Update transliterate_wiktionary

Author: wannaphong

docs/api/transliterate.rst

@@ -17,6 +17,9 @@ Modules
 
     The `transliterate` function serves as a versatile transliteration tool, offering a range of transliteration engines to choose from. It provides flexibility and customization for your transliteration needs.
 
+.. autofunction:: transliterate_wiktionary
+    :noindex:
+
 .. autofunction:: pronunciate
     :noindex:
 
@@ -27,6 +30,9 @@ Modules
 
     The `puan` function offers a unique transliteration feature known as "Puan." It provides a specialized transliteration method for Thai text and is an additional option for rendering Thai text into English characters.
 
+.. autofunction:: get_word_dict
+    :noindex:
+
 .. autoclass:: pythainlp.transliterate.wunsen.WunsenTransliterate
    :members:
 

pythainlp/transliterate/__init__.py

@@ -8,13 +8,13 @@
     "pronunciate",
     "puan",
     "romanize",
-    "th_pron_transliterate",
     "transliterate",
+    "transliterate_wiktionary",
 ]
 
 from pythainlp.transliterate.core import pronunciate, romanize, transliterate
 from pythainlp.transliterate.spoonerism import puan
-from pythainlp.transliterate.th_pron import (
+from pythainlp.transliterate.wiktionary import (
     get_word_dict,
-    th_pron_transliterate,
+    transliterate_wiktionary,
 )

pythainlp/transliterate/th_pron.py pythainlp/transliterate/wiktionary.pypythainlp/transliterate/th_pron.py renamed to pythainlp/transliterate/wiktionary.py

@@ -1,7 +1,10 @@
 # SPDX-FileCopyrightText: 2016-2026 PyThaiNLP Project
 # SPDX-FileType: SOURCE
 # SPDX-License-Identifier: Apache-2.0
-"""Thai pronunciation transliteration from Wiktionary th-pron module."""
+"""
+Thai pronunciation transliteration from Wiktionary th-pron module.
+Source code: https://en.wiktionary.org/wiki/Module:th-pron
+"""
 
 from __future__ import annotations
 
@@ -421,7 +424,7 @@ def syllable(match: re.Match[str]) -> str:
 
 
 def get_word_dict(word: str) -> dict[str, str]:
-    """Return th-pron transliteration outputs in all supported systems.
+    """Return Wiktionary transliteration outputs in all supported systems.
 
     :param str word: Thai input word.
     :return: ``dict[str, str]`` with ``word``, ``paiboon``, ``royin``, and ``ipa``.
@@ -440,6 +443,6 @@ def get_word_dict(word: str) -> dict[str, str]:
     }
 
 
-def transliterate(text: str, mode: str = "ipa") -> str:
+def transliterate_wiktionary(text: str, mode: str = "ipa") -> str:
     """Backward-compatible alias for :func:`th_pron_transliterate`."""
     return th_pron_transliterate(text, mode=mode)

tests/core/test_transliterate_th_pron.py …ts/core/test_transliterate_wiktionary.pytests/core/test_transliterate_th_pron.py renamed to tests/core/test_transliterate_wiktionary.py tests/core/test_transliterate_th_pron.py renamed to tests/core/test_transliterate_wiktionary.py

@@ -5,16 +5,21 @@
 import unittest
 
 from pythainlp.transliterate import get_word_dict
-from pythainlp.transliterate.th_pron import transliterate
+from pythainlp.transliterate.wiktionary import transliterate_wiktionary
 
 
 class TransliterateThPronTestCase(unittest.TestCase):
-    def test_transliterate_supported_modes(self):
-        self.assertEqual(transliterate("แมว", mode="royin"), "maeo")
-        self.assertEqual(transliterate("คน", mode="paiboon"), "kon")
-        self.assertEqual(transliterate("คน", mode="ipa"), "kʰon˧")
+    def test_transliterate_wiktionary(self):
+        self.assertEqual(
+            transliterate_wiktionary("แมว", mode="royin"), "maeo"
+        )
+        self.assertEqual(
+            transliterate_wiktionary("คน", mode="paiboon"), "kon"
+        )
+        self.assertEqual(
+            transliterate_wiktionary("คน", mode="ipa"), "kʰon˧")
 
-    def test_transliterate_returns_input_for_unknown_mode(self):
+    def test_transliterate_wiktionary_returns_input_for_unknown_mode(self):
         self.assertEqual(transliterate("แมว", mode="unknown"), "แมว")
 
     def test_thai_digits_conversion(self):
@@ -31,7 +36,7 @@ def test_get_word_dict(self):
             },
         )
 
-    def test_transliterate_paiboon_cases(self):
+    def test_transliterate_wiktionary_paiboon_cases(self):
         # test cases from https://w.wiki/RifX
         test_cases = [
             ('เฮิ็้ย', 'hə́i'),
@@ -154,7 +159,10 @@ def test_transliterate_paiboon_cases(self):
 
         for thai_text, expected_translit in test_cases:
             with self.subTest(thai_text=thai_text):
-                self.assertEqual(transliterate(thai_text, mode="paiboon"), expected_translit)
+                self.assertEqual(
+                    transliterate_wiktionary(thai_text, mode="paiboon"),
+                    expected_translit
+                )
 
 if __name__ == '__main__':
     unittest.main()