Update

docs/index.rst

@@ -10,6 +10,7 @@ Qieyun Encoder Python 說明文件
    :maxdepth: 1
 
    常量
+   變換
    音韻地位
    工具
 

docs/變換.rst

@@ -0,0 +1,8 @@
+QieyunEncoder.變換
+==================
+
+.. automodule:: QieyunEncoder.變換
+   :imported-members:
+   :members:
+   :undoc-members:
+   :show-inheritance:

src/QieyunEncoder/__init__.py

@@ -3,14 +3,5 @@
 from . import 常量
 from .音韻地位 import 音韻地位
 from .韻鏡位置 import 韻鏡位置
-from .工具.反切 import 反切
-from .工具.韻目到韻 import 韻目到韻
-from .工具.母到清濁 import 母到清濁
-from .工具.母到組 import 母到組
-from .工具.母到音 import 母到音
-from .工具.韻到攝 import 韻到攝
-from .工具.音韻地位到韻鏡位置 import 音韻地位到韻鏡位置
-from .工具.韻鏡位置到音韻地位 import 韻鏡位置到音韻地位
-from .工具.音韻屬性到韻鏡位置們 import 音韻屬性到韻鏡位置們
 
 __version__ = '0.4.3'

src/QieyunEncoder/工具/__init__.py

@@ -1 +1,6 @@
 # -*- coding: utf-8 -*-
+
+from .反切 import 反切
+from .音韻地位到韻鏡位置 import 音韻地位到韻鏡位置
+from .韻鏡位置到音韻地位 import 韻鏡位置到音韻地位
+from .音韻屬性到韻鏡位置們 import 音韻屬性到韻鏡位置們

src/QieyunEncoder/工具/音韻屬性到韻鏡位置們.py

@@ -5,9 +5,9 @@
 '''
 
 from ..韻鏡位置 import 韻鏡位置
-from ..常量 import 常量
-from .韻目到韻 import 韻目到韻
-from .母到組 import 母到組
+from .. import 常量
+from ..變換 import 韻目到韻
+from ..變換 import 母到組
 
 
 def 音韻屬性到韻鏡位置們(母: str, 韻目: str, 聲: str):

src/QieyunEncoder/工具/韻鏡位置到音韻地位.py

@@ -6,7 +6,7 @@
 
 from ..音韻地位 import 音韻地位
 from ..韻鏡位置 import 韻鏡位置
-from ..常量 import 常量
+from .. import 常量
 
 
 def 韻鏡位置到音韻地位(當前韻鏡位置: 韻鏡位置) -> 音韻地位:

src/QieyunEncoder/變換/__init__.py

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+
+from .韻目到韻 import 韻目到韻
+from .母到清濁 import 母到清濁
+from .母到組 import 母到組
+from .母到音 import 母到音
+from .韻到攝 import 韻到攝

src/QieyunEncoder/工具/母到清濁.py → src/QieyunEncoder/變換/母到清濁.py

@@ -13,16 +13,15 @@
 
 _d母到清濁 = {母: 清濁 for 清濁, 母們 in _清濁到母表 for 母 in 母們}
 
-
-def 母到清濁(母: str):
+def 母到清濁(母: str) -> str:
     '''
     將母轉換爲清濁。
 
-    ```python
-    >>> 母到清濁('端')
-    '全清'
-    >>> 母到清濁('以')
-    '次濁'
-    ```
+    Examples:
+
+        >>> 母到清濁('端')
+        '全清'
+        >>> 母到清濁('以')
+        '次濁'
     '''
     return _d母到清濁[母]

src/QieyunEncoder/工具/母到組.py → src/QieyunEncoder/變換/母到組.py

@@ -18,18 +18,17 @@
 
 _d母到組 = {母: 組 for 組, 母們 in _組到母表 for 母 in 母們}
 
-
-def 母到組(母: str):
+def 母到組(母: str) -> str | None:
     '''
     將母轉換爲組。
 
-    ```python
-    >>> 母到組('滂')
-    '幫'
-    >>> 母到組('云')
-    '影'
-    >>> 母到組('以')
-    None
-    ```
+    Examples:
+
+        >>> 母到組('滂')
+        '幫'
+        >>> 母到組('云')
+        '影'
+        >>> 母到組('以')
+        None
     '''
     return _d母到組[母]

src/QieyunEncoder/工具/母到音.py → src/QieyunEncoder/變換/母到音.py

@@ -14,16 +14,15 @@
 
 _d母到音 = {母: 音 for 音, 母們 in _音到母表 for 母 in 母們}
 
-
-def 母到音(母: str):
+def 母到音(母: str) -> str:
     '''
     將母轉換爲音。
 
-    ```python
-    >>> 母到音('並')
-    '脣'
-    >>> 母到音('羣')
-    '牙'
-    ```
+    Examples:
+
+        >>> 母到音('並')
+        '脣'
+        >>> 母到音('羣')
+        '牙'
     '''
     return _d母到音[母]

src/QieyunEncoder/工具/母與等到類.py → src/QieyunEncoder/變換/母與等到類.py

@@ -61,7 +61,6 @@
     ('而', '日', None),
 )
 
-
 def 母與等到類(母: str, 等: str) -> str:
     for 聲類, 母條件, 等條件 in _五十一聲類映射表:
         if 母 == 母條件 and (等條件 is None or 等 in 等條件):

src/QieyunEncoder/工具/韻到攝.py → src/QieyunEncoder/變換/韻到攝.py

@@ -25,16 +25,15 @@
 
 _d韻到攝 = {韻: 攝 for 攝, 韻們 in _攝到韻表 for 韻 in 韻們}
 
-
-def 韻到攝(韻: str):
+def 韻到攝(韻: str) -> str:
     '''
     將韻轉換爲攝。
+    
+    Examples:
 
-    ```python
-    >>> 韻到攝('冬')
-    '通'
-    >>> 韻到攝('侵')
-    '深'
-    ```
+        >>> 韻到攝('冬')
+        '通'
+        >>> 韻到攝('侵')
+        '深'
     '''
     return _d韻到攝[韻]

src/QieyunEncoder/工具/韻目到韻.py → src/QieyunEncoder/變換/韻目到韻.py

@@ -74,23 +74,21 @@
     '夬𡗒',
 )
 
-_標準韻映射表 = {非標準韻: 非標準韻們[0]
-           for 非標準韻們 in _非標準韻表 for 非標準韻 in 非標準韻們.replace(' ', '')}
+_標準韻映射表 = {非標準韻: 非標準韻們[0] for 非標準韻們 in _非標準韻表 for 非標準韻 in 非標準韻們.replace(' ', '')}
 
-
-def 韻目到韻(韻: str):
+def 韻目到韻(韻: str) -> str:
     '''
     將切韻系韻書的韻目轉換爲韻。
 
-    ```python
-    >>> 韻目到韻('物')
-    '文'
-    >>> 韻目到韻('敬')
-    '庚'
-    >>> 韻目到韻('東')
-    '東'
-    ```
+    此函式具有冪等性，即 ``韻目到韻(韻目到韻(韻目)) == 韻目到韻(韻目)`` 永遠成立。
 
-    此函式具有冪等性，即 `韻目到韻(韻目到韻(韻目)) == 韻目到韻(韻目)` 永遠成立。
+    Examples:
+    
+        >>> 韻目到韻('物')
+        '文'
+        >>> 韻目到韻('敬')
+        '庚'
+        >>> 韻目到韻('東')
+        '東'
     '''
     return _標準韻映射表[韻]

src/QieyunEncoder/音韻地位.py

@@ -3,7 +3,7 @@
 import re
 
 from . import 常量
-from ._拓展音韻屬性 import 母到清濁, 母到音, 母到組, 韻到攝
+from .變換 import 母到清濁, 母到音, 母到組, 韻到攝
 
 編碼表 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
 韻順序表 = '東_冬鍾江支脂之微魚虞模齊祭泰佳皆夬灰咍廢真臻文殷元魂痕寒刪山仙先蕭宵肴豪歌_麻_陽唐庚_耕清青蒸登尤侯幽侵覃談鹽添咸銜嚴凡'

src/QieyunEncoder/韻鏡位置.py

@@ -3,8 +3,8 @@
 import re
 from typing import Optional, Union
 
-from .工具.韻目到韻 import 韻目到韻
-from .常量 import 常量
+from .變換 import 韻目到韻
+from . import 常量
 
 _韻鏡母位置表 = [
     '脣音第一位', '脣音第二位', '脣音第三位', '脣音第四位',