Welcome to pypinyin’s documentation!

Build Coverage Pypi version Pypi downloads

将汉语转为拼音。可以用于汉字注音、排序、检索。基于 pinyinjs 开发。

安装

$ pip install pypinyin

为了更好的处理多音字及中英文混合的字符串, 推荐安装 jieba 分词模块。

使用示例

>>> from pypinyin import pinyin, lazy_pinyin
>>> import pypinyin
>>> pinyin(u'中心')
[[u'zh\u014dng'], [u'x\u012bn']]
>>> pinyin(u'中心', heteronym=True)  # 启用多音字模式
[[u'zh\u014dng', u'zh\xf2ng'], [u'x\u012bn']]
>>> pinyin(u'中心', style=pypinyin.STYLE_INITIALS)  # 设置拼音风格
[['zh'], ['x']]
>>> lazy_pinyin(u'中心')
['zhong', 'xin']

分词处理

如果安装了 jieba 分词模块,程序会自动调用。

使用其他分词模块:

  1. 安装分词模块,比如 pip install snownlp

  2. 使用经过分词处理的字符串列表作参数:

    >> from pypinyin import lazy_pinyin, STYLE_TONE2
    >> from snownlp import SnowNLP
    >> hans = u'音乐123'
    >>
    >> lazy_pinyin(hans, style=STYLE_TONE2)
    >> [u'yi1n', u'le4', u'1', u'2', u'3']
    >>
    >> hans_seg = SnowNLP(hans).words  # 分词处理
    >> hans_seg
    >> [u'\u97f3\u4e50', u'123']
    >> lazy_pinyin(hans_seg, style=STYLE_TONE2)
    >> [u'yi1n', u'yue4', u'123']
    

API

拼音风格:

pypinyin.STYLE_NORMAL 普通风格(0),不带声调。如: pin yin
pypinyin.STYLE_TONE 声调风格(1),拼音声调在韵母第一个字母上(默认风格)。如: pīn yīn
pypinyin.STYLE_TONE2 声调风格2(2),即拼音声调在各个拼音之后,用数字 [0-4] 进行表示。如: pi1n yi1n
pypinyin.STYLE_INITIALS 声母风格(3),只返回各个拼音的声母部分。如: 中国 的拼音 zh g
pypinyin.STYLE_FIRST_LETTER 首字母风格(4),只返回拼音的首字母部分。如: p y
pypinyin.STYLE_FINALS 韵母风格1(5),只返回各个拼音的韵母部分,不带声调。如: ong uo
pypinyin.STYLE_FINALS_TONE 韵母风格2(6),带声调,声调在韵母第一个字母上。如: ōng
pypinyin.STYLE_FINALS_TONE2 韵母风格2(7),带声调,声调在各个拼音之后,用数字 [0-4] 进行表示。如: o1ng uo2
pypinyin.pinyin(hans, style=1, heteronym=False)

将汉字转换为拼音.

Parameters:
  • hans (unicode 字符串或字符串列表) – 汉字字符串(u’你好吗’)或列表([u’你好’, u’吗’]) 如果用户安装了 jieba,将使用 jieba 对字符串进行分词处理。 用户也可以使用自己喜爱的分词模块对字符串进行分词处理。 只需将进行过分词处理的字符串列表传进来就可以了。
  • style – 指定拼音风格
  • heteronym – 是否启用多音字
Returns:

拼音列表

Return type:

list

Usage:

>>> from pypinyin import pinyin
>>> import pypinyin
>>> pinyin(u'中心')
[[u'zhōng'], [u'xīn']]
>>> pinyin(u'中心', heteronym=True)  # 启用多音字模式
[[u'zhōng', u'zhòng'], [u'xīn']]
>>> pinyin(u'中心', style=pypinyin.STYLE_INITIALS)  # 设置拼音风格
[[u'zh'], [u'x']]
>>> pinyin(u'中心', style=pypinyin.STYLE_TONE2)
[[u'zho1ng'], [u'xi1n']]
pypinyin.slug(hans, style=0, heteronym=False, separator=u'-')

生成 slug 字符串.

Parameters:
  • hans (unicode or list) – 汉字
  • style – 指定拼音风格
  • heteronym – 是否启用多音字
  • separstor – 两个拼音间的分隔符/连接符
Returns:

slug 字符串.

pypinyin.lazy_pinyin(hans, style=0)

不包含多音字的拼音列表.

pinyin() 的区别是返回的拼音是个字符串,并且每个字只包含一个读音.

Parameters:
  • hans (unicode or list) – 汉字
  • style – 指定拼音风格
Returns:

拼音列表(e.g. ['zhong', 'guo', 'ren'])

Return type:

list

Usage:

>>> from pypinyin import lazy_pinyin
>>> import pypinyin
>>> lazy_pinyin(u'中心')
[u'zhong', u'xin']
>>> lazy_pinyin(u'中心', style=pypinyin.STYLE_TONE)
[u'zhōng', u'xīn']
>>> lazy_pinyin(u'中心', style=pypinyin.STYLE_INITIALS)
[u'zh', u'x']
>>> lazy_pinyin(u'中心', style=pypinyin.STYLE_TONE2)
[u'zho1ng', u'xi1n']

Changelog

0.4.0 (2014-01-3)

  • jieba 模块改为可选安装,用户可以选择使用自己喜爱的分词模块对汉字进行分词处理
  • 支持 Python 3

0.3.1 (2013-12-24)

  • 增加 lazy_pinyin

    >>> lazy_pinyin(u'中心')
    ['zhong', 'xin']
    

0.3.0 (2013-09-26)

  • 修复首字母风格无法正确处理只有韵母的汉字

  • 新增三个拼音风格:
    • pypinyin.STYLE_FINALS : 韵母风格1,只返回各个拼音的韵母部分,不带声调。如: ong uo
    • pypinyin.STYLE_FINALS_TONE : 韵母风格2,带声调,声调在韵母第一个字母上。如: ōng
    • pypinyin.STYLE_FINALS_TONE2 : 韵母风格2,带声调,声调在各个拼音之后,用数字 [0-4] 进行表示。如: o1ng uo2

0.2.0 (2013-09-22)

  • 完善对中英文混合字符串的支持:

    >> pypinyin.pinyin(u'你好abc')
    [[u'n\u01d0'], [u'h\u01ceo'], [u'abc']]

0.1.0 (2013-09-21)

  • Initial Release

Indices and tables

Read the Docs v: v0.4.0
Versions
latest
develop
v0.4.0
0.3.1
0.3.0
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.