Skip to main content

ja-itaiji: handling Japanese 異体字 (itaiji), which are variant forms of kanji characters

Project description

ja-itaiji

ja-itaiji is a Python package for handling Japanese 異体字 (itaiji), which are variant forms of kanji characters. This package allows you to find equivalent characters, check if two kanji characters or words are equivalent, and generate a list of similar words by replacing kanji with their itaiji.

Features

  • Get Itaiji Family: Retrieve a list of kanji characters that are equivalent to a given kanji.
  • Check Kanji Equivalence: Determine whether two kanji characters are equivalent itaiji.
  • Check Word Equivalence: Check if two words are equivalent within itaiji.
  • Generate Similar Words: Generate a list of words by replacing each kanji with its equivalent itaiji.

Installation

To install the package, use pip:

pip install ja-itaiji

Usage

Importing the Package

from ja_itaiji import Itaiji

Get Itaiji Family

Retrieve a list of kanji characters that are equivalent to a given kanji.

family = Itaiji.get_family('漢')
print(family)  # Output: ['漢', '㵄', '漢', '汉']

Check Kanji Equivalence

Determine whether two kanji characters are equivalent itaiji.

is_equivalent = Itaiji.is_family('漢', '㵄')
print(is_equivalent)  # Output: True

Check Word Equivalence

Check if two words are equivalent within itaiji.

is_similar = Itaiji.is_similar('漢字', '汉字')
print(is_similar)  # Output: True

Generate Similar Words

Generate a list of words by replacing each kanji with its equivalent itaiji.

similar_words = Itaiji.get_similar('漢字')
print(similar_words)  # Output: ['漢字', '㵄字', '漢字', '汉字']

You can also specify the number of replacing.

similar_words = Itaiji.get_similar("低頭思故郷", n=1)
print(similar_words)  # Output: ['低頭思故郷', '低頭思故鄕', '低頭思故乡', '低頭楒故郷', '低頭䰄故郷', '低頭恖故郷', '低头思故郷', '氐頭思故郷', '仾頭思故郷']

Data

The package uses a JSON file (ja-itaiji.json) that contains mappings of kanji to their itaiji. Ensure that this file is located in the correct directory as specified by ITAIJI_PATH.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ja_itaiji-1.0.2.tar.gz (171.8 kB view details)

Uploaded Source

Built Distribution

ja_itaiji-1.0.2-py3-none-any.whl (169.8 kB view details)

Uploaded Python 3

File details

Details for the file ja_itaiji-1.0.2.tar.gz.

File metadata

  • Download URL: ja_itaiji-1.0.2.tar.gz
  • Upload date:
  • Size: 171.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for ja_itaiji-1.0.2.tar.gz
Algorithm Hash digest
SHA256 91c766e0cf64fbc0126ab2e548da6147427f089469980412eb6482b049aa6acd
MD5 eb1f6d567487895154bbc79f8c55848b
BLAKE2b-256 f7d05a405dddade3da42d4e69437f5918c84f98d8555eefbf60900f6ced70b85

See more details on using hashes here.

File details

Details for the file ja_itaiji-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: ja_itaiji-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 169.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for ja_itaiji-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0e8237ee9762c789c124ca29c1e7790367dc11e998f965c5c43de2517d715b62
MD5 f0eaa7682d0f0d22ce2972dd297c7511
BLAKE2b-256 56bfacabc232a779bbe11af9f465c946a45ee4821d7edda7f8cf9dc6db135a05

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page