open warning with paddle.utils.deprecated (#60458)

ooooo-create · SigureMo · web-flow · commit 8fcf35b724cd · 2024-01-02T10:38:25.000+08:00
* open_warning

* update unittest

* update

* fix typos

* fix warning in test runner

* uncomment

* cleanup todo

* using VisibleDeprecationWarning

* update comment

* fix typo

* fix indentation

* fix

* fix

* fix indent level and test

* update

---------

Co-authored-by: SigureMo &lt;sigure.qaq@gmail.com&gt;
diff --git a/python/paddle/utils/deprecated.py b/python/paddle/utils/deprecated.py
@@ -16,6 +16,7 @@
 """
 
 import functools
+import inspect
 import sys
 import warnings
 
@@ -24,6 +25,18 @@
 __all__ = []
 
 
+class VisibleDeprecationWarning(UserWarning):
+    """Visible deprecation warning.
+
+    Since Python 3.7, Python only show the DeprecationWarning if the module
+    is __main__. So we use this warning to make the deprecation warning visible.
+
+    See more details from https://peps.python.org/pep-0565/
+    """
+
+    ...
+
+
 def deprecated(update_to="", since="", reason="", level=0):
     """Decorate a function to signify its deprecation.
 
@@ -47,8 +60,6 @@ def deprecated(update_to="", since="", reason="", level=0):
     """
 
     def decorator(func):
-        # TODO(zhiqiu): temporally disable the warnings
-        return func
         """construct warning message, and return a decorated function or class."""
         assert isinstance(update_to, str), 'type of "update_to" must be str.'
         assert isinstance(since, str), 'type of "since" must be str.'
@@ -75,9 +86,11 @@ def decorator(func):
             )
             msg += f' Please use "{_update_to}" instead.'
         if len(_reason) > 0:
-            msg += f"\nreason: {_reason}"
+            msg += f"\n    Reason: {_reason}"
         if func.__doc__:
-            func.__doc__ = ('\n\nWarning: ' + msg + '\n') + func.__doc__
+            func.__doc__ = (
+                '\n\nWarning:\n    ' + msg + '\n\n'
+            ) + inspect.cleandoc(func.__doc__)
 
         if level == 0:
             return func
@@ -110,7 +123,7 @@ def wrapper(*args, **kwargs):
                 or v_current >= v_since
             ):
                 warnings.warn(
-                    warningmsg, category=DeprecationWarning, stacklevel=2
+                    warningmsg, category=VisibleDeprecationWarning, stacklevel=2
                 )
 
             return func(*args, **kwargs)
diff --git a/test/legacy_test/CMakeLists.txt b/test/legacy_test/CMakeLists.txt
@@ -118,8 +118,6 @@ if(((NOT WITH_ROCM) AND (NOT WITH_GPU)) OR WIN32)
   list(REMOVE_ITEM TEST_OPS test_fleet_executor_cond_interceptor)
 endif()
 
-list(REMOVE_ITEM TEST_OPS test_deprecated_decorator)
-
 if(WIN32)
   list(REMOVE_ITEM TEST_OPS test_multiprocess_reader_exception)
   list(REMOVE_ITEM TEST_OPS test_trainer_desc)
diff --git a/test/legacy_test/test_deprecated_decorator.py b/test/legacy_test/test_deprecated_decorator.py
@@ -19,23 +19,20 @@
 import numpy as np
 
 import paddle
-from paddle import _legacy_C_ops
 from paddle.utils import deprecated
 
 LOWEST_WARNING_POSTION = 3
 ERROR_WARNING_POSTION = sys.maxsize
 
 # custom paddle version
-paddle.version.major = '1'
-paddle.version.minor = '8'
+paddle.version.major = '0'
+paddle.version.minor = '0'
 paddle.version.patch = '0'
 paddle.version.rc = '0'
-paddle.__version__ = '1.8.0'
-paddle.version.full_version = '1.8.0'
+paddle.__version__ = '0.0.0'
+paddle.version.full_version = '0.0.0'
 print("current paddle version: ", paddle.__version__)
 
-paddle.disable_static()
-
 
 def get_warning_index(api):
     """
@@ -49,22 +46,25 @@ def get_warning_index(api):
         index (int): the index of the Warinng information in its doc string if exists.
     """
 
-    doc_lst = api.__doc__.splitlines()
-    for idx, val in enumerate(doc_lst):
+    doc_list = api.__doc__.splitlines()
+    if len(doc_list) < 2:
+        return ERROR_WARNING_POSTION
+    for idx, (current_line, next_line) in enumerate(
+        zip(doc_list[:-1], doc_list[1:])
+    ):
         if (
-            val.startswith("Warning: ")
-            and val.endswith(" instead.")
-            and "and will be removed in future versions." in val
+            current_line == "Warning:"
+            and next_line.endswith(" instead.")
+            and "and will be removed in future versions." in next_line
         ):
             return idx
     return ERROR_WARNING_POSTION
 
 
-class TestDeprecatedDocorator(unittest.TestCase):
+class TestDeprecatedDecorator(unittest.TestCase):
     """
-    tests for paddle's Deprecated Docorator.
+    tests for paddle's deprecated decorator.
     test_new_multiply: test for new api, which should not insert warning information.
-    test_ops_elementwise_mul: test for C++ elementwise_mul op, which should not insert warning information.
     """
 
     def test_new_multiply(self):
@@ -87,26 +87,15 @@ def test_new_multiply(self):
         # testting
         self.assertLess(expected, captured)
 
-    def test_ops_elementwise_mul(self):
-        """
-        Test for new C++ elementwise_op, expected result should be True,
-        because not matter what base.layers.elementwise_mul is deprecated.
-        """
-
-        a = np.random.uniform(0.1, 1, [51, 76]).astype(np.float32)
-        b = np.random.uniform(0.1, 1, [51, 76]).astype(np.float32)
-        x = paddle.to_tensor(a)
-        y = paddle.to_tensor(b)
-        res = _legacy_C_ops.elementwise_mul(x, y)
-
-        # expected
-        expected = LOWEST_WARNING_POSTION
-
-        # captured
-        captured = get_warning_index(paddle.multiply)
-
-        # testting
-        self.assertGreater(expected, captured)
+    def test_indent_level(self):
+        # test for different indent_level
+        dataset = paddle.base.DatasetFactory().create_dataset("InMemoryDataset")
+        with warnings.catch_warnings(record=True):
+            dataset.set_merge_by_lineid()
+            assert (
+                '\nSet merge by'
+                in paddle.base.InMemoryDataset.set_merge_by_lineid.__doc__
+            )
 
     def test_tensor_gradient(self):
         paddle.__version__ = '2.1.0'
