inheritedglyphs 2.0

No project description provided

繁體中文 简体中文󠄁 English

• Online version has been released, click me!

Inherited Glyphs Converter 傳承字形轉換器

Convert CJK ideographs to their inherited glyphs form (mostly follows List of Recommended Inherited Glyph Components), eliminating the xin zixing, Hong Kong and Taiwan region standard glyphs, and character variants that is unifiable but encoded seperately on Unicode.

The converter keeps shinjitai and simplified Chinese characters as much as possible.

Usage

Command line

python . <text file name>

Command line arguments:

Options	Usage	Default value
-o	Specifies an output file.	root_converted.ext
-c	A string that contains j, k or t, or _. j: Use Japanese compatibility ideographs. k: Use Korean compatibility ideographs. t: Use CNS 11643 compatibility ideographs. _: Not to use compatibility ideographs.	jkt
-s	Supplementary planes characters usage settings, parameter follows: c: Only use characters that are in Adobe-Japan1, HKSCS or UnihanCore2020 characters on supplementary planes *: Use all characters on supplementary planes. _: Only use characters from the Basic Multilingual Plane.	c
-n	Not to convert to inherited variants that are not unifiable on Unicode. (e.g. 秘 → 祕, 床 → 牀)
-v	Use inherited variants that are commonly seen but not etymological. (e.g. 免 → 免)
-a	Use inherited variants that are more etymological. (e.g. 皆 → 𣅜)
-i	Uses IVSes in the conversion. Parameters: ad: Use the Adobe-Japan1 IVS. mo: Moji-Joho IVS. ms: Macao Supplementary Character Set IVS.
-t	Uses IVSes with tiāo nà stroke (乀).
-p	Center align the punctation.
-u	Specifies text encoding for decoding.	UTF-8

Import module

The inheritedglyphs module provides a single function convert() which converts a string to their inherited glyphs form.

Function arguments:

Arguments	Usage	Default value
compatibility	An iterable that contains 'j', 'k', and/or 't'. 'j': Use Japanese compatibility ideographs. 'k': Use Korean compatibility ideographs. 't': Use CNS 11643 compatibility ideographs.	'jkt'
supp_planes	Use of supplementary planes characters settings, value follows: 'c': for supplementary planes, only use characters in Adobe-Japan1, HKSCS or UnihanCore2020. '*': in supplementary planes, use all characters. False: Only use characters from the Basic Multilingual Plane.	'c'
convert_not_unifiable	Convert to inherited variants that are not unifiable on Unicode (e.g. 秘 → 祕, 床 → 牀)	True
alternate	Use inherited variants that are commonly seen but not etymological. (e.g. 免 → 免)	False
etymological	Use inherited variants that are more etymological. (e.g. 皆 → 𣅜)	False
ivs	Uses IVSes in the conversion. The argument value is an (ordered) iterable that contains one or more of the following, or False: 'ad': Adobe-Japan1 IVS. 'mo': Moji-Joho IVS. 'ms': Macao Supplementary Character Set IVS.	False
tiao_na	Uses IVSes with tiāo (㇀) nà (㇏) stroke (乀) in the conversion.
-p	Center align the punctation.	False

Example

>>> from inheritedglyphs import *
>>> string = '寒來暑往，秋收冬藏。閏餘成歳，律吕調陽。雲騰致雨，露結為霜。金生麗水，玉出崑崗。'
>>> print(convert(string))
寒來暑往，秋收冬藏。閏餘成歲，律呂調陽。雲騰致雨，露結爲霜。金生麗水，玉出崑崗。
>>> print(convert(string, compatibility='j')) # # don't use Korean and CNS compatibility ideographs
寒來暑往，秋收冬藏。閏餘成歲，律呂調陽。雲騰致雨，露結爲霜。金生麗水，玉出崑崗。
>>> print(convert(string, compatibility=False, ivs=['ad'])) # Only uses Adobe-Japan1 IVS
寒󠄁來暑󠄁往󠄁，秋收冬󠄀藏。閏餘成󠄁歲，律呂調󠄁陽。雲騰󠄁致雨，露結爲霜。金生麗󠄁水，玉出崑崗。

Download & installation

The module requires Python 3.7 or up.

To install latest release with pip, simply run

pip install inheritedglyphs

or from the source tree

pip install .