README

汉字拼音转换工具（Python 版）
=============================

|Build| |GitHubAction| |Coverage| |Pypi version| |PyPI downloads| |DOI|


将汉字转为拼音。可以用于汉字注音、排序、检索(Russian translation_) 。

最初版本的代码参考了 hotoo/pinyin __ 的实现。

 Documentation: https://pypinyin.readthedocs.io/
 GitHub: https://github.com/mozillazg/python-pinyin
 License: MIT license
 PyPI: https://pypi.org/project/pypinyin
 Python version: 2.7, pypy3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12, 3.13, 3.14, 3.15

.. contents::


特性
----

 根据词组智能匹配最正确的拼音。
 支持多音字。
 简单的繁体支持，注音支持，威妥玛拼音支持。
 支持多种不同拼音/注音风格。


安装
----

.. code-block:: bash

    pip install pypinyin

使用 uv 安装：

.. code-block:: bash

    uv add pypinyin


使用示例
--------

.. code-block:: python

     from pypinyin import pinyin, lazy_pinyin, Style
     pinyin('中心')   or pinyin(['中心'])，参数值为列表时表示输入的是已分词后的数据
    [['zhōng'], ['xīn']]
     pinyin('中心', heteronym=True)   启用多音字模式
    [['zhōng', 'zhòng'], ['xīn']]
     pinyin('中心', style=Style.FIRST_LETTER)   设置拼音风格
    [['z'], ['x']]
     pinyin('中心', style=Style.TONE2, heteronym=True)
    [['zho1ng', 'zho4ng'], ['xi1n']]
     pinyin('中心', style=Style.TONE3, heteronym=True)
    [['zhong1', 'zhong4'], ['xin1']]
     pinyin('中心', style=Style.BOPOMOFO)   注音风格
    [['ㄓㄨㄥ'], ['ㄒㄧㄣ']]
     lazy_pinyin('威妥玛拼音', style=Style.WADEGILES)
    ['wei', "t'o", 'ma', "p'in", 'yin']
     lazy_pinyin('中心')   不考虑多音字的情况
    ['zhong', 'xin']
     lazy_pinyin('战略', v_to_u=True)   不使用 v 表示 ü
    ['zhan', 'lüe']
     使用 5 标识轻声
     lazy_pinyin('衣裳', style=Style.TONE3, neutral_tone_with_five=True)
    ['yi1', 'shang5']
     变调  nǐ hǎo - ní hǎo
     lazy_pinyin('你好', style=Style.TONE2, tone_sandhi=True)
    ['ni2', 'ha3o']

注意事项 ：

 默认情况下拼音结果不会标明哪个韵母是轻声，轻声的韵母没有声调或数字标识（可以通过参数 neutral_tone_with_five=True 开启使用 5 标识轻声 ）。
 默认情况下无声调相关拼音风格下的结果会使用 v 表示 ü （可以通过参数 v_to_u=True 开启使用 ü 代替 v ）。
 默认情况下会原样输出没有拼音的字符（自定义处理没有拼音的字符的方法见 文档 __ ）。
 嗯 的拼音并不是大部分人以为的 en 以及存在既没有声母也没有韵母的拼音，详见下方 FAQ 中的说明。

命令行工具：

.. code-block:: console

    $ pypinyin 音乐
    yīn yuè

    $ python -m pypinyin.tools.toneconvert to-tone 'zhong4 xin1'
    zhòng xīn


文档
--------

详细文档请访问：https://pypinyin.readthedocs.io/。

项目代码开发方面的问题可以看看 开发文档_ 。


FAQ
---------

拼音有误？
+++++++++++++++++++++++++++++

可以通过下面的方法提高拼音准确性：

 可以通过自定义词组拼音库或者单字拼音库的方式修正拼音结果，
  详见 文档 __ 。

.. code-block:: python

     from pypinyin import load_phrases_dict, load_single_dict

     load_phrases_dict({'桔子': [['jú'], ['zǐ']]})   增加 "桔子" 词组

     load_single_dict({ord('还'): 'hái,huán'})   调整 "还" 字的拼音顺序或覆盖默认拼音

 也可以使用 pypinyin-dict __ 项目提供的自定义拼音库来纠正结果。

.. code-block:: python

     使用 phrase-pinyin-data 项目中 cc_cedict.txt 文件中的拼音数据优化结果
     from pypinyin_dict.phrase_pinyin_data import cc_cedict
     cc_cedict.load()

     使用 pinyin-data 项目中 kXHC1983.txt 文件中的拼音数据优化结果
     from pypinyin_dict.pinyin_data import kxhc1983
     kxhc1983.load()

 如果是分词导致的拼音有误的话，可以先使用其他的分词模块对数据进行分词处理，
  然后将分词后的词组结果列表作为函数的参数即可:

.. code-block:: python

      使用其他分词模块分词，比如 jieba 之类，
     或者基于 phrases_dict.py 里的词语数据使用其他分词算法分词
     words =