Import BackendFilter and backend_registry into

matplotlib.backends.__init__.py

Author: ianthomas23

doc/api/next_api_changes/deprecations/27719-IT.rst

@@ -1,12 +1,11 @@
 ``rcsetup.interactive_bk``, ``rcsetup.non_interactive_bk`` and ``rcsetup.all_backends``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-... are deprecated and replaced by
-:meth:`matplotlib.backends.registry.BackendRegistry.list_builtin`
+... are deprecated and replaced by ``matplotlib.backends.backend_registry.list_builtin``
 with the following arguments
 
-- `matplotlib.backends.registry.BackendFilter.INTERACTIVE`
-- `matplotlib.backends.registry.BackendFilter.NON_INTERACTIVE`
+- ``matplotlib.backends.BackendFilter.INTERACTIVE``
+- ``matplotlib.backends.BackendFilter.NON_INTERACTIVE``
 - ``None``
 
 respectively.

doc/users/next_whats_new/backend_registry.rst

@@ -3,4 +3,4 @@ BackendRegistry
 
 New :class:`~matplotlib.backends.registry.BackendRegistry` class is the single
 source of truth for available backends. The singleton instance is
-``matplotlib.backends.registry.backend_registry``.
+``matplotlib.backends.backend_registry``.

lib/matplotlib/backend_bases.py

@@ -105,7 +105,7 @@ def _safe_pyplot_import():
         if current_framework is None:
             raise  # No, something else went wrong, likely with the install...
 
-        from matplotlib.backends.registry import backend_registry
+        from matplotlib.backends import backend_registry
         backend = backend_registry.backend_for_gui_framework(current_framework)
         if backend is None:
             raise RuntimeError("No suitable backend for the current GUI framework "

lib/matplotlib/backends/__init__.py

@@ -1,3 +1,5 @@
+from .registry import BackendFilter, backend_registry  # noqa: F401
+
 # NOTE: plt.switch_backend() (called at import time) will add a "backend"
 # attribute here for backcompat.
 _QT_FORCE_QT5_BINDING = False

lib/matplotlib/backends/registry.py

@@ -18,7 +18,7 @@ class BackendRegistry:
     This is the single source of truth for available backends.
 
     All use of ``BackendRegistry`` should be via the singleton instance
-    ``backend_registry``.
+    ``backend_registry`` which can be imported from ``matplotlib.backends``.
 
     .. versionadded:: 3.9
     """

lib/matplotlib/pyplot.py

@@ -69,7 +69,7 @@
 from matplotlib.artist import Artist
 from matplotlib.axes import Axes
 from matplotlib.axes import Subplot  # noqa: F401
-from matplotlib.backends.registry import BackendFilter, backendRegistry
+from matplotlib.backends import BackendFilter, backend_registry
 from matplotlib.projections import PolarAxes
 from matplotlib import mlab  # for detrend_none, window_hanning
 from matplotlib.scale import get_scale_names  # noqa: F401

lib/matplotlib/rcsetup.py

@@ -23,7 +23,7 @@
 import numpy as np
 
 from matplotlib import _api, cbook
-from matplotlib.backends.registry import BackendFilter, backend_registry
+from matplotlib.backends import BackendFilter, backend_registry
 from matplotlib.cbook import ls_mapper
 from matplotlib.colors import Colormap, is_color_like
 from matplotlib._fontconfig_pattern import parse_fontconfig_pattern
@@ -37,23 +37,23 @@
 class __getattr__:
     @_api.deprecated(
         "3.9",
-        alternative="``matplotlib.backends.registry.backend_registry.list_builtin"
-            "(matplotlib.backends.registry.BackendFilter.INTERACTIVE)``")
+        alternative="``matplotlib.backends.backend_registry.list_builtin"
+            "(matplotlib.backends.BackendFilter.INTERACTIVE)``")
     @property
     def interactive_bk(self):
         return backend_registry.list_builtin(BackendFilter.INTERACTIVE)
 
     @_api.deprecated(
         "3.9",
-        alternative="``matplotlib.backends.registry.backend_registry.list_builtin"
-            "(matplotlib.backends.registry.BackendFilter.NON_INTERACTIVE)``")
+        alternative="``matplotlib.backends.backend_registry.list_builtin"
+            "(matplotlib.backends.BackendFilter.NON_INTERACTIVE)``")
     @property
     def non_interactive_bk(self):
         return backend_registry.list_builtin(BackendFilter.NON_INTERACTIVE)
 
     @_api.deprecated(
         "3.9",
-        alternative="``matplotlib.backends.registry.backend_registry.list_builtin()``")
+        alternative="``matplotlib.backends.backend_registry.list_builtin()``")
     @property
     def all_backends(self):
         return backend_registry.list_builtin()

lib/matplotlib/tests/test_backend_registry.py

@@ -4,7 +4,7 @@
 import pytest
 
 import matplotlib as mpl
-from matplotlib.backends.registry import BackendFilter, backend_registry
+from matplotlib.backends import BackendFilter, backend_registry
 
 
 def has_duplicates(seq: Sequence[Any]) -> bool:

lib/matplotlib/tests/test_matplotlib.py

@@ -57,7 +57,7 @@ def parse(key):
             backends += [e.strip() for e in line.split(',') if e]
         return backends
 
-    from matplotlib.backends.registry import BackendFilter, backend_registry
+    from matplotlib.backends import BackendFilter, backend_registry
 
     assert (set(parse('- interactive backends:\n')) ==
             set(backend_registry.list_builtin(BackendFilter.INTERACTIVE)))