Re-add a deprecated cbook.deprecation module for backward compatibility

timhoffm · timhoffm · commit c6419cfd9595 · 2020-10-05T22:52:38.000+02:00
diff --git a/.flake8 b/.flake8
@@ -58,6 +58,7 @@ per-file-ignores =
     lib/matplotlib/backends/backend_*.py: F401
     lib/matplotlib/backends/qt_editor/formlayout.py: F401, F403
     lib/matplotlib/cbook/__init__.py: F401
+    lib/matplotlib/cbook/deprecation.py: F401
     lib/matplotlib/font_manager.py: E221, E251, E501
     lib/matplotlib/image.py: F401, F403
     lib/matplotlib/lines.py: F401
diff --git a/doc/api/next_api_changes/deprecations/18657-TH.rst b/doc/api/next_api_changes/deprecations/18657-TH.rst
@@ -0,0 +1,3 @@
+``matplotlib.cbook.deprecation`` is deprecated
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The module is considered internal and will be removed from the public API.
diff --git a/lib/matplotlib/_api/deprecation.py b/lib/matplotlib/_api/deprecation.py
@@ -105,7 +105,7 @@ def warn_deprecated(
     warning = _generate_deprecation_warning(
         since, message, name, alternative, pending, obj_type, addendum,
         removal=removal)
-    from . import _warn_external
+    from ..cbook import _warn_external
     _warn_external(warning, category=MatplotlibDeprecationWarning)
 
 
diff --git a/lib/matplotlib/cbook/deprecation.py b/lib/matplotlib/cbook/deprecation.py
@@ -0,0 +1,7 @@
+# imports are for backward compatibility
+from matplotlib._api.deprecation import (
+    MatplotlibDeprecationWarning, mplDeprecation, warn_deprecated, deprecated)
+
+warn_deprecated("3.4",
+                "The module matplotlib.cbook.deprecation is considered "
+                "internal and it will be made private in the future.")

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+``matplotlib.cbook.deprecation`` is deprecated
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	`+The module is considered internal and will be removed from the public API.`