feature: add deprecated decorator helper

Author: rohawamr

src/sagemaker/deprecations.py

@@ -51,8 +51,7 @@ def renamed_warning(phrase):
 
 
 def deprecation_warn(name, date, msg=None):
-    """Raise a warning for soon to be deprecated feature
-    in sagemaker>=2
+    """Raise a warning for soon to be deprecated feature in sagemaker>=2
 
     Args:
         name (str): Name of the feature
@@ -63,8 +62,7 @@ def deprecation_warn(name, date, msg=None):
 
 
 def deprecation_warning(date, msg=None):
-    """Decorator for raising deprecation warning for a feature
-    in sagemaker>=2
+    """Decorator for raising deprecation warning for a feature in sagemaker>=2
 
     Args:
         date (str): the date when the feature will be deprecated
@@ -81,11 +79,14 @@ def __init__(self):
                 print("xxxx....")
 
     """
+
     def deprecate(obj):
         def wrapper(*args, **kwargs):
             deprecation_warn(obj.__name__, date, msg)
             return obj(*args, **kwargs)
+
         return wrapper
+
     return deprecate
 
 
@@ -145,6 +146,31 @@ def func(*args, **kwargs):  # pylint: disable=W0613
     return func
 
 
+def deprecated(obj):
+    """Decorator for raising deprecated warning for a feature in sagemaker>=2
+
+    Args:
+        msg (str): the prefix phrase of the warning message.
+
+    Usage:
+        @deprecated(msg="message")
+        def sample_function():
+            print("xxxx....")
+
+        @deprecated(msg="message")
+        class SampleClass():
+            def __init__(self):
+                print("xxxx....")
+
+    """
+
+    def wrapper(*args, **kwargs):
+        removed_warning(obj.__name__)
+        return obj(*args, **kwargs)
+
+    return wrapper
+
+
 def deprecated_function(func, name):
     """Wrap a function with a deprecation warning.
 

tests/unit/test_deprecations.py

@@ -24,6 +24,7 @@
     removed_kwargs,
     renamed_kwargs,
     deprecation_warning,
+    deprecated,
 )
 
 
@@ -69,26 +70,30 @@ def sample_function():
     with pytest.warns(DeprecationWarning) as w:
         output = sample_function()
         assert output == "xxxx...."
-        msg = "sample_function will be deprecated on date.message in sagemaker>=2.\n" \
-              "See: https://sagemaker.readthedocs.io/en/stable/v2.html for details."
+        msg = (
+            "sample_function will be deprecated on date.message in sagemaker>=2.\n"
+            "See: https://sagemaker.readthedocs.io/en/stable/v2.html for details."
+        )
         assert str(w[-1].message) == msg
 
 
 def test_deprecation_warning_for_class():
     @deprecation_warning(msg="message", date="date")
-    class SampleClass():
+    class SampleClass:
         def __init__(self):
             pass
 
     with pytest.warns(DeprecationWarning) as w:
         SampleClass()
-        msg = "SampleClass will be deprecated on date.message in sagemaker>=2.\n" \
-              "See: https://sagemaker.readthedocs.io/en/stable/v2.html for details."
+        msg = (
+            "SampleClass will be deprecated on date.message in sagemaker>=2.\n"
+            "See: https://sagemaker.readthedocs.io/en/stable/v2.html for details."
+        )
         assert str(w[-1].message) == msg
 
 
 def test_deprecation_warning_for_class_method():
-    class SampleClass():
+    class SampleClass:
         def __init__(self):
             pass
 
@@ -100,8 +105,60 @@ def sample_method(self):
     with pytest.warns(DeprecationWarning) as w:
         output = s.sample_method()
         assert output == "xxxx...."
-        msg = "sample_method will be deprecated on date.message in sagemaker>=2.\n" \
-              "See: https://sagemaker.readthedocs.io/en/stable/v2.html for details."
+        msg = (
+            "sample_method will be deprecated on date.message in sagemaker>=2.\n"
+            "See: https://sagemaker.readthedocs.io/en/stable/v2.html for details."
+        )
+        assert str(w[-1].message) == msg
+
+
+def test_deprecated_for_function():
+    @deprecated
+    def sample_function():
+        return "xxxx...."
+
+    with pytest.warns(DeprecationWarning) as w:
+        output = sample_function()
+        assert output == "xxxx...."
+        msg = (
+            "sample_function is a no-op in sagemaker>=2.\n"
+            "See: https://sagemaker.readthedocs.io/en/stable/v2.html for details."
+        )
+        assert str(w[-1].message) == msg
+
+
+def test_deprecated_for_class():
+    @deprecated
+    class SampleClass:
+        def __init__(self):
+            pass
+
+    with pytest.warns(DeprecationWarning) as w:
+        SampleClass()
+        msg = (
+            "SampleClass is a no-op in sagemaker>=2.\n"
+            "See: https://sagemaker.readthedocs.io/en/stable/v2.html for details."
+        )
+        assert str(w[-1].message) == msg
+
+
+def test_deprecated_for_class_method():
+    class SampleClass:
+        def __init__(self):
+            pass
+
+        @deprecated
+        def sample_method(self):
+            return "xxxx...."
+
+    s = SampleClass()
+    with pytest.warns(DeprecationWarning) as w:
+        output = s.sample_method()
+        assert output == "xxxx...."
+        msg = (
+            "sample_method is a no-op in sagemaker>=2.\n"
+            "See: https://sagemaker.readthedocs.io/en/stable/v2.html for details."
+        )
         assert str(w[-1].message) == msg