Add BackendRegistry.list_gui_frameworks() needed by IPython

ianthomas23 · ianthomas23 · commit 8a711eb4c958 · 2024-04-10T10:15:32.000+01:00
diff --git a/lib/matplotlib/backends/registry.py b/lib/matplotlib/backends/registry.py
@@ -292,6 +292,18 @@ def list_builtin(self, filter_=None):
 
         return list(self._BUILTIN_BACKEND_TO_GUI_FRAMEWORK.keys())
 
+    def list_gui_frameworks(self):
+        """
+        Return list of gui frameworks used by Matplotlib backends.
+
+        Returns
+        -------
+        list of str
+            GUI framework names.
+        """
+        return [k for k in self._GUI_FRAMEWORK_TO_BACKEND.keys()
+                if k != "headless"]
+
     def load_backend_module(self, backend):
         """
         Load and return the module containing the specified backend.
diff --git a/lib/matplotlib/backends/registry.pyi b/lib/matplotlib/backends/registry.pyi
@@ -26,6 +26,7 @@ class BackendRegistry:
     def is_valid_backend(self, backend: str) -> bool: ...
     def list_all(self) -> list[str]: ...
     def list_builtin(self, filter_: BackendFilter | None) -> list[str]: ...
+    def list_gui_frameworks(self) -> list[str]: ...
     def load_backend_module(self, backend: str) -> ModuleType: ...
     def resolve_backend(self, backend: str | None) -> tuple[str, str | None]: ...
     def resolve_gui_or_backend(self, gui_or_backend: str | None) -> tuple[str, str | None]: ...
