matplotlib.backends.registry

class matplotlib.backends.registry.BackendFilter(*values)

Basiert auf Enum

Filter, der mit list_builtin() verwendet wird

Hinzugefügt in Version 3.9.

INTERACTIVE = 0

NON_INTERACTIVE = 1

class matplotlib.backends.registry.BackendRegistry

Bases: object

Registrierung der in Matplotlib verfügbaren Backends.

Dies ist die einzige Quelle der Wahrheit für verfügbare Backends.

Alle Verwendungen von BackendRegistry sollten über die Singleton-Instanz backend_registry erfolgen, die aus matplotlib.backends importiert werden kann.

Jedes Backend hat einen Namen, einen Modulnamen, der den Backend-Code enthält, und ein optionales GUI-Framework, das laufen muss, wenn das Backend interaktiv ist. Es gibt drei Quellen für Backends: integrierte (Quellcode befindet sich im Matplotlib-Repository), explizite Syntax module://some.backend (Backend wird durch Laden des Moduls erhalten) oder über einen Entry Point (selbstregistrierendes Backend in einem externen Paket).

Hinzugefügt in Version 3.9.

backend_for_gui_framework(framework)

Gibt den Namen des Backends zurück, das dem angegebenen GUI-Framework entspricht.

Parameter:

frameworkstr

GUI-Framework wie "qt".

Gibt zurück:

str oder None

Backend-Name oder None, wenn das GUI-Framework nicht erkannt wird.

is_valid_backend(backend)

Gibt True zurück, wenn der Backend-Name gültig ist, andernfalls False.

Ein Backend-Name ist gültig, wenn er eines der integrierten Backends ist oder über einen Entry Point dynamisch hinzugefügt wurde. Namen, die mit module:// beginnen, werden immer als gültig betrachtet und in dieser Funktion zur aktuellen Liste aller Backends hinzugefügt.

Auch wenn ein Name gültig ist, kann er möglicherweise nicht importiert oder verwendet werden. Dies kann nur durch Laden und Verwenden des Backend-Moduls bestimmt werden.

Parameter:

backendstr

Name des Backends.

Gibt zurück:

bool

True, wenn das Backend gültig ist, False andernfalls.

list_all()

Gibt eine Liste aller bekannten Backends zurück.

Dazu gehören integrierte Backends und solche, die zur Laufzeit entweder über Entry Points oder die explizite Syntax module://some.backend erhalten werden.

Entry Points werden geladen, wenn sie noch nicht geladen wurden.

Gibt zurück:

Liste von str

Backend-Namen.

list_builtin(filter_=None)

Gibt eine Liste der in Matplotlib integrierten Backends zurück.

Parameter:

filter_BackendFilter, optional

Filter, der auf die zurückgegebenen Backends angewendet werden soll. Um beispielsweise nur nicht-interaktive Backends zurückzugeben, verwenden Sie BackendFilter.NON_INTERACTIVE.

Gibt zurück:

Liste von str

Backend-Namen.

list_gui_frameworks()

Gibt eine Liste der von Matplotlib-Backends verwendeten GUI-Frameworks zurück.

Gibt zurück:

Liste von str

Namen von GUI-Frameworks.

load_backend_module(backend)

Lädt und gibt das Modul zurück, das das angegebene Backend enthält.

Parameter:

backendstr

Name des zu ladenden Backends.

Gibt zurück:

Modul

Modul, das das Backend enthält.

resolve_backend(backend)

Gibt das Backend und das GUI-Framework für den angegebenen Backend-Namen zurück.

Wenn das GUI-Framework noch nicht bekannt ist, wird es durch Laden des Backend-Moduls und Überprüfen des Attributs FigureCanvas.required_interactive_framework ermittelt.

Diese Funktion lädt Entry Points nur, wenn sie noch nicht geladen wurden und das Backend nicht integriert ist und nicht dem Format module://some.backend entspricht.

Parameter:

backendstr oder None

Name des Backends oder None, um das Standard-Backend zu verwenden.

Gibt zurück:

backendstr

Der Backend-Name.

frameworkstr oder None

Das GUI-Framework, das für ein nicht-interaktives Backend None ist.

resolve_gui_or_backend(gui_or_backend)

Gibt das Backend und das GUI-Framework für die angegebene Zeichenkette zurück, die entweder ein GUI-Framework oder ein Backend-Name sein kann, in dieser Reihenfolge getestet.

Dies ist für die Verwendung mit dem IPython %matplotlib Magic Command bestimmt, das ein GUI-Framework wie %matplotlib qt oder ein Backend-Name wie %matplotlib qtagg sein kann.

Diese Funktion lädt Entry Points nur, wenn sie noch nicht geladen wurden und das Backend nicht integriert ist und nicht dem Format module://some.backend entspricht.

Parameter:

gui_or_backendstr oder None

Name des GUI-Frameworks oder Backends oder None, um das Standard-Backend zu verwenden.

Gibt zurück:

backendstr

Der Backend-Name.

frameworkstr oder None

Das GUI-Framework, das für ein nicht-interaktives Backend None ist.