add custom decorator to send method deprecation warning

twilio · eshanholtz · Nov 1, 2019 · Oct 31, 2019 · Oct 31, 2019 · Oct 31, 2019
commit f 8000 68d8222b0d82480735a51095e1dcd75a2c1cebc
diff --git a/tests/unit/base/test_deprecation.py b/tests/unit/base/test_deprecation.py
@@ -0,0 +1,27 @@
+import unittest
+import warnings
+
+from twilio.base.obsolete import deprecated_method
+
+
+class DeprecatedMethodTest(unittest.TestCase):
+
+    def test_deprecation_decorator(self):
+
+        @deprecated_method('new_method')
+        def old_method():
+            pass
+
+        with warnings.catch_warnings(record=True) as caught_warnings:
+            warnings.simplefilter("always")
+
+            # Call function that should raise a warning
+            old_method()
+
+            if len(caught_warnings):
+                self.assertEqual(
+                    str(caught_warnings[0].message),
+                    'Function method .old_method() is being deprecated in favor of .new_method()'
+                )
+                assert issubclass(caught_warnings[0].category, DeprecationWarning)
+
diff --git a/twilio/base/obsolete.py b/twilio/base/obsolete.py
@@ -21,3 +21,22 @@ def new_func(*args, **kwargs):
         )
 
     return new_func
+
+
+def deprecated_method(new_func):
+    """
+    This is a decorator which can be used to mark deprecated methods.
+    It will report in a DeprecationWarning being emitted to stderr when the deprecated method is used.
+    """
+
+    def deprecated_method_wrapper(func):
+
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            warnings.warn('Function method .{}() is being deprecated in favor of .{}()'.format(func.__name__, new_func),
+                          DeprecationWarning)
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return deprecated_method_wrapper