拼音解析器
Project description
这是一个拼音解析器。
更准确地说,针对符合汉语拼音方案的汉语拼音的解析器;
并可以扩展预设的音位表示补充方案或用户自定义的其他类拼音方案。
能做什么?
- 解析拼音,尤其适用于UGC,或者任何你对输入是一坨怎样的东西完全没信心的时候。
- 如果你的输入已经非常整洁标准,那或许有其他更快的解析库适合你。
- 本库保证输出标准化、规范化;但是对于不符合设计意图的输入,强行标准规范化可能导致奇怪的结果。
- 例如,压根不是拼音的
chinese强行解析会变成[<ch·ri·missing>,<n·e·missing>,<s·e·missing>]
- 例如,压根不是拼音的
- 检验一个拼音是不是存在。
- 查拼音,尤其是查谐音/双声叠韵 etc.
- 把拼音解析成按音位的声韵调格式,便于存储与查询。
- 每个音节仅占用2B(16b),而只是“存储音节”的理论最小值就是2B(11b)。
- 因此使用本库可以获取理论极限的内存效率以及与之相匹配的性能(不bitpack的情况下)。
- 也可以转换拼音的格式/风格(例如
guang1gua1ngguāng)。- 但这不是主要功能。如果你的主要需求是这个,那你应该去看kittell的同名库或是pypinyin。
- 拼音规范化/格式化。
- 默认行为不完全严格符合汉语拼音正词法,而是使用了更保守的方案(在主观上可能混淆的时候额外断词)。
- 或者其他任何需要对 “拼音”本身 进行处理的场合。
不能做什么?
- 从汉字解析出来拼音。
- 如果你的需求是汉字加拼音,那你应该去看pypinyin。
- 模糊解析。
- 所见即所得的解析。
- 本解析器使用的是音位表示,解析结果很可能会与你想象的不同。
- 例:
chi→<ch·ri·missing>而不是<ch·i·missing>。
- 例:
- 如果你需要所见即所得,那么你应当自己处理转换,将音节转换为更“符合直觉”的表示。
- 本解析器使用的是音位表示,解析结果很可能会与你想象的不同。
怎么使用?
你应当询问AI。我的语言能力并不足以支持我进行非常详细的表述。
当然如果你懒得用AI的话,往下一点就可以看到我帮你问的……
支持什么版本?
3.12+,推荐3.14;3.10及以上需要删一些类型注解之类的东西再用;3.10以下不考虑支持,要用自己去改。
AI写的readme
pinyinparser.py 使用说明
pinyinparser 是一个强大且高精度的汉语拼音解析与生成库。它不仅支持将拼音字符串解析为结构化的“声母+韵母+声调”对象,还能将对象重新格式化为不同风格的拼音字符串。
该模块对拼音的音位学进行了较深度的建模(如区分 i 的不同音位变体、处理 y/w 伪声母等),因此在使用时有部分不符合直觉的设计,请务必阅读注意事项。
🚀 基本使用
1. 解析拼音字符串
使用 parse() 方法将拼音字符串解析为 Syllable 对象列表。默认支持空格、单引号 ' 和连字符 - 作为音节分隔符。
from pinyinparser import parse, Syllable, ToneStyle, syllables_to_str
# 解析连续拼音(解析器会自动尝试切分)
syllables = parse("xian") # 可能解析为 xi'an 或 xian,取决于合法性
print(syllables)
# 推荐使用分隔符消除歧义
syllables = parse("xi'an")
for s in syllables:
print(f"声母: {s.initial.name}, 韵母: {s.final.name}, 声调: {s.tone.name}")
2. 构建与解析单个音节
可以直接通过字符串构造 Syllable,或使用 parse_single。
# 直接通过字符串构造
syl = Syllable("zhōng")
print(syl) # <zh·ong·1>
# 使用类属性直接获取(利用了元类 _SyllMeta 的 __getattr__)
syl2 = Syllable.zhong1
print(syl2.initial, syl2.final, syl2.tone)
3. 拼音对象转字符串
使用 syllables_to_str() 或 Syllable.to_str() 将对象转回字符串。支持三种声调风格:
syl = Syllable("zhōng")
# 默认:声调在元音上方
print(syl.to_str()) # "zhōng"
# 声调数字在韵母后
print(syl.to_str(ToneStyle.RIGHT)) # "zho1ng" (注意:此格式不可逆!)
# 声调数字在音节末尾
print(syl.to_str(ToneStyle.AFTER)) # "zhong1"
# 批量转换并自动添加分隔符
syllables = parse("xi'an")
print(syllables_to_str(syllables)) # "xi'ān"
⚠️ 注意事项与反直觉设计(重要!)
本库为了严格贴合语音学和底层位运算设计,存在多处与日常直觉不符的逻辑,使用时请特别注意:
1. y 和 w 是“伪声母”
在《汉语拼音方案》中,y 和 w 是起隔音作用的零声母标记。但在本库中,y 和 w 被视作正式的声母。
- 直觉:
yan的声母为空(零声母),韵母为ian。 - 本库:
yan的声母为Initial.y,韵母为Final.ian。 - 同理,
wu的声母为Initial.w,韵母为Final.u。
2. i 并不总是 Final.i
受舌尖元音影响,拼音中的 i 在解析时会被映射为不同的底层韵母:
zi, ci, si中的i解析为Final.ii([ɿ])zhi, chi, shi, ri中的i解析为Final.ri([ʅ])bi, pi, mi等常规发音解析为Final.i- 注意:在
j, q, x后面的i(如ji)依然是Final.i,但在转出字符串时,若搭配ü(如ju),底层韵母其实是Final.v,转字符串时规则会自动把ü替换为u。
3. 缺失声调 与 轻声(t5) 的区别
本库严格区分“没有标注声调”和“轻声”:
- 如果输入
zhong(不带声调),解析出的声调是Tone.missing,而不是轻声t5。 - 如果要默认将未标调音节视为轻声,需在
parse时传入default_tone_neutral=True。
4. ToneStyle.RIGHT 是单向不可逆的
使用 ToneStyle.RIGHT(如 zho1ng)生成的拼音字符串无法被本解析器重新解析。因为数字插在字母中间破坏了正则与Token的匹配逻辑。调用时会抛出 IncompatibleWarning,若你明确知道后果,可传 NO_INCOMPAT_WARNING=True 关闭警告。
5. “不存在”的拼音也会被解析(除非强制校验)
解析器默认只做文法切分,不检验音节在普通话中是否真实存在。例如 wai2 在词典中不存在,但符合拼写规则,默认仍能解析成功。
- 若要强制只生成真实存在的音节,请使用
parse(s, force_valid_syllable=True)。内部会通过一个巨大的 Base85 位图(VALID_SYLLABLES)进行校验。
6. 声母变体选择位(高级用法)
声母枚举值不是简单的递增。例如:
c = 0x0004ch = 0x8004这里0x8000是变体选择位。如果你需要做模糊匹配(比如让ch匹配c开头的所有音),可以通过位运算initial & 0x001F屏蔽高位,实现“通配首字母”的功能。zh, sh, H, R, M, N同理。
7. 特殊叹词的韵母
像 hm (噷)、hng (哼)、m (呣)、n (嗯) 等特殊音节:
hm被视为声母Initial.H+ 韵母Final.hm。m单独作音节时,被视为声母Initial.M+ 韵母Final.m。- 这与普通零声母(如
an)的处理逻辑完全不同。
8. ü 与 v 的输入输出
- 输入时,
ü和v均可被接受(如nv和nü等价)。 - 内部统一存储为
Final.v(或其衍生如Final.veh,Final.van)。 - 输出时,
FINAL2STR映射表会自动将其转为标准的ü(在 j/q/x 后会自动脱帽变 u)。
9. DFS解析性能问题
作者在源码中坦诚指出,__parse 方法使用了不带剪枝的深度优先搜索(DFS),在处理长且无分隔符的极端字符串时,可能存在性能瓶颈或爆递归风险。推荐在处理用户输入时,尽量要求带分隔符,或对输入长度做限制。
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pinyinparser-1.2.1.tar.gz.
File metadata
- Download URL: pinyinparser-1.2.1.tar.gz
- Upload date:
- Size: 17.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cdbcbece5a20007aa260653fcd7e619a59f4c743674c946c2c27852c81ea768f
|
|
| MD5 |
3630936e88c2036bf314e9be578db831
|
|
| BLAKE2b-256 |
1d8ff5e01b64f45e7872f3781b6a04aa3963ed2873528e4a7f4cc88e66405edf
|
File details
Details for the file pinyinparser-1.2.1-py3-none-any.whl.
File metadata
- Download URL: pinyinparser-1.2.1-py3-none-any.whl
- Upload date:
- Size: 17.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
40349e25040e3bef05b9f5fe104801584522602c07a70ea9dd9f4054e98b6ee5
|
|
| MD5 |
78d46c7c63bc76bb830615e7edf815f5
|
|
| BLAKE2b-256 |
209d7fbaf2a9257c8e8090251f29eaf658d719c031d2d4c9236dfbd27ce2478a
|