Merge pull request #1028 from bact/dev

Update warn_deprecation to get deprecated and removal versions

pythainlp/cls/__init__.py

@@ -11,4 +11,4 @@
 from pythainlp.classify.param_free import GzipModel
 from pythainlp.tools import warn_deprecation
 
-warn_deprecation("pythainlp.cls", "pythainlp.classify", "5.2")
+warn_deprecation("pythainlp.cls", "pythainlp.classify", "5.1", "5.2")

pythainlp/corpus/common.py

@@ -353,6 +353,7 @@ def thai_synonym() -> dict:
     warn_deprecation(
         "pythainlp.corpus.thai_synonym",
         "pythainlp.corpus.thai_synonyms",
+        "5.1",
         "5.2",
     )
     return thai_synonyms()

pythainlp/tools/core.py

@@ -12,24 +12,26 @@
 def warn_deprecation(
     deprecated_func: str,
     replacing_func: str = "",
-    version: str = "",
+    deprecated_version: str = "",
+    removal_version: str = "",
 ):
     """Warn about the deprecation of a function.
 
     :param str deprecated_func: Name of the deprecated function.
     :param str replacing_func: Name of the function to use instead (optional).
-    :param str version: PyThaiNLP version in which the function will be deprecated (optional).
+    :param str deprecated_version: Version in which the function will be deprecated (optional).
+    :param str removal_version: Version in which the function will be removed (optional).
     """
-    if version:
-        version = f"PyThaiNLP {version}"
-    else:
-        version = "a future release"
-    message = f"The '{deprecated_func}' function is deprecated and will be removed in {version}."
+    message = f"The '{deprecated_func}' function is deprecated"
+    if deprecated_version:
+        message += f" since {deprecated_version}"
+    if not removal_version:
+        removal_version = "a future release"
+    message += f" and will be removed in {removal_version}."
     if replacing_func:
         message += f" Please use '{replacing_func}' instead."
     warnings.warn(message, DeprecationWarning, stacklevel=2)
 
-
 def safe_print(text: str):
     """Print text to console, handling UnicodeEncodeError.
 

pythainlp/util/normalize.py

@@ -331,6 +331,9 @@ def maiyamok(sent: Union[str, List[str]]) -> List[str]:
         # output: ['คน', 'คน', 'นก']
     """
     warn_deprecation(
-        "pythainlp.util.maiyamok", "pythainlp.util.expand_maiyamok", "5.2"
+        "pythainlp.util.maiyamok",
+        "pythainlp.util.expand_maiyamok",
+        "5.0.5",
+        "5.2",
     )
     return expand_maiyamok(sent)

pythainlp/util/thaiwordcheck.py

@@ -8,6 +8,7 @@ def is_native_thai(word: str) -> bool:
     warn_deprecation(
         "pythainlp.util.is_native_thai",
         "pythainlp.morpheme.is_native_thai",
+        "5.0",
         "5.1",
     )