We accidentally introduce a break change for

removing ctl_tlb_mode.

Author: wtdcode

bindings/python/unicorn/unicorn_py3/unicorn.py

@@ -3,11 +3,12 @@
 """
 
 from __future__ import annotations
-from typing import TYPE_CHECKING, Any, Callable, Dict, Generic, Iterable, Iterator, Optional, Sequence, Tuple, Type, TypeVar, Union
+from typing import TYPE_CHECKING, Any, Callable, Dict, Generic, Iterable, Iterator, Optional, Sequence, Tuple, Type, TypeVar, Union, ParamSpec
 
 import ctypes
 import functools
 import weakref
+import warnings
 
 from unicorn import unicorn_const as uc
 from .arch.types import uc_err, uc_engine, uc_context, uc_hook_h, UcReg, VT
@@ -631,6 +632,29 @@ class Uc(RegStateManager):
     """Unicorn Engine class.
     """
 
+    # Code snippet modified from:
+    # https://stackoverflow.com/questions/2536307/decorators-in-the-python-standard-lib-deprecated-specifically
+    
+    
+    @staticmethod
+    def __deprecated(msg: str):
+        __rT = TypeVar('rT') # return type
+        __pT = ParamSpec('pT') # parameters type
+        def __deprecated_inner(func: Callable[__pT, __rT]) -> Callable[__pT, __rT]:
+            """Use this decorator to mark functions as deprecated.
+            Every time the decorated function runs, it will emit
+            a "deprecation" warning."""
+            @functools.wraps(func)
+            def new_func(*args: Uc.__pT.args, **kwargs: Uc.__pT.kwargs):
+                warnings.simplefilter('always', DeprecationWarning)  # turn off filter
+                warnings.warn("Call to a deprecated function {}. {}".format(func.__name__, msg),
+                            category=DeprecationWarning,
+                            stacklevel=2)
+                warnings.simplefilter('default', DeprecationWarning)  # reset filter
+                return func(*args, **kwargs)
+            return new_func
+        return __deprecated_inner
+
     @staticmethod
     def __is_compliant() -> bool:
         """Checks whether Unicorn binding version complies with Unicorn library.
@@ -1435,6 +1459,15 @@ def ctl_flush_tb(self) -> None:
 
         self.__ctl_w(uc.UC_CTL_TB_FLUSH)
 
+    @__deprecated("You should use ctl_set_tlb_mode instead.")
+    def ctl_tlb_mode(self, mode: int) -> None:
+        """Deprecated, please use ctl_set_tlb_mode instead.
+        
+        Args:
+            mode: tlb mode to use (see UC_TLB_* constants)
+        """
+        self.ctl_set_tlb_mode(mode)
+    
     def ctl_set_tlb_mode(self, mode: int) -> None:
         """Set TLB mode.