Add pinyin_group and lazy_pinyin_group functions for grouped pinyin output with apostrophe handling

.circleci/config.yml

@@ -163,4 +163,3 @@ workflows:
       - python3.5
       - python3.4
       - python2.7
-      - pypy2

.github/workflows/ci.yml

@@ -15,27 +15,31 @@ jobs:
         python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "pypy3.9", "pypy3.10"]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
+
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v7
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
 
     - name: Install dependencies
       run: |
-        python -m pip install -r requirements_dev.txt
+        uv pip install --system -r requirements_dev.txt
+        uv pip install --system .
 
     - name: Run tests
       run: |
-        py.test tests/ pypinyin/
+        python -m pytest tests/ pypinyin/
 
     - name: test cli
       if: startsWith(matrix.os,'ubuntu')
       run: |
         set -xe
-        python setup.py sdist
-        python -m pip install dist/*.gz
+        uv build
+        uv pip install --system dist/*.tar.gz
         python -m pypinyin test
         python -m pypinyin.tools.toneconvert to-tone 'zhong4 xin1'
 

Makefile

@@ -29,15 +29,13 @@ doctest:
 .PHONY: publish
 publish: clean
 	@echo "publish to pypi"
-	python setup.py sdist
-	python setup.py bdist_wheel
+	uv build
 	twine upload dist/*
 
 .PHONY: publish_test
 publish_test: clean
 	@echo "publish to test pypi"
-	python setup.py sdist
-	python setup.py bdist_wheel
+	uv build
 	twine upload --repository test dist/*
 
 .PHONY: docs_html

README.rst

@@ -12,7 +12,7 @@
 * GitHub: https://github.com/mozillazg/python-pinyin
 * License: MIT license
 * PyPI: https://pypi.org/project/pypinyin
-* Python version: 2.7, pypy, pypy3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12, 3.13
+* 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
 
 .. contents::
 
@@ -33,6 +33,12 @@
 
     pip install pypinyin
 
+使用 `uv` 安装：
+
+.. code-block:: bash
+
+    uv add pypinyin
+
 
 使用示例
 --------

README_en.rst

@@ -33,6 +33,12 @@ Install
 
     $ pip install pypinyin
 
+Install with `uv`:
+
+.. code-block:: bash
+
+    $ uv add pypinyin
+
 
 Usage cases
 --------

docs/api.rst

@@ -19,8 +19,12 @@ API
 
 .. autofunction:: pypinyin.pinyin
 
+.. autofunction:: pypinyin.pinyin_group
+
 .. autofunction:: pypinyin.lazy_pinyin
 
+.. autofunction:: pypinyin.lazy_pinyin_group
+
 .. autofunction:: pypinyin.load_single_dict
 
 .. autofunction:: pypinyin.load_phrases_dict

docs/index.rst

@@ -17,7 +17,7 @@
 * GitHub: https://github.com/mozillazg/python-pinyin
 * License: MIT license
 * PyPI: https://pypi.org/project/pypinyin
-* Python version: 2.7, pypy, pypy3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9
+* 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
 
 
 特性

pypinyin/__init__.py

@@ -24,7 +24,8 @@
     STYLE_CYRILLIC_FIRST, CYRILLIC_FIRST
 )
 from pypinyin.core import (     # noqa
-    pinyin, lazy_pinyin, slug, load_single_dict, load_phrases_dict
+    pinyin, lazy_pinyin, slug, pinyin_group, lazy_pinyin_group,
+    load_single_dict, load_phrases_dict
 )
 
 __title__ = 'pypinyin'
@@ -33,7 +34,7 @@
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2016 mozillazg, 闲耘'
 __all__ = [
-    'pinyin', 'lazy_pinyin', 'slug',
+    'pinyin', 'lazy_pinyin', 'slug', 'pinyin_group', 'lazy_pinyin_group',
     'load_single_dict', 'load_phrases_dict',
     'Style',
     'STYLE_NORMAL', 'NORMAL',

pypinyin/__init__.pyi

@@ -46,5 +46,7 @@ CYRILLIC_FIRST = constants.CYRILLIC_FIRST
 pinyin = core.pinyin
 lazy_pinyin = core.lazy_pinyin
 slug = core.slug
+pinyin_group = core.pinyin_group
+lazy_pinyin_group = core.lazy_pinyin_group
 load_single_dict = core.load_single_dict
 load_phrases_dict = core.load_phrases_dict