matplotlib.backends.registry

classmatplotlib.backends.registry.BackendFilter(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

Фильтр, используемый с list_builtin()

Добавлена в версии 3.9.

INTERACTIVE=0[source]

NON_INTERACTIVE=1[source]

classmatplotlib.backends.registry.BackendRegistry[source]

Bases: object

Регистр доступных бэкэндов в Matplotlib.

Это единственный источник данных о доступных бэкендах.

Все использование BackendRegistry должно осуществляться через экземпляр-синглтон backend_registry, который можно импортировать из matplotlib.backends.

Каждый бэкенд имеет имя, имя модуля, содержащего код бэкенда, и необязательную графическую оболочку, которая должна быть запущена, если бэкенд интерактивный. Есть три источника бэкэндов: встроенные (исходный код находится в репозитории Matplotlib), явные module://some.backend конструкции (бэкенд получается путем загрузки модуля) или через точку входа (саморегистрирующийся бэкенд во внешнем пакете).

Добавлен в версии 3.9.

backend_for_gui_framework(framework)[source]

Возвращает имя бэкенда, соответствующее указанной графической оболочке.

Параметры:

frameworkstr

Графическая оболочка, например, "qt".

Возвращает:

str или None

Имя бэкенда или None, если графическая оболочка не распознана.

is_valid_backend(backend)[source]

Возвращает True, если имя бэкенда допустимо, иначе False.

Имя бэкенда допустимо, если оно является одним из встроенных бэкэндов или было динамически добавлено через точку входа. Начинающиеся с module:// всегда считаются допустимыми и добавляются в текущий список всех бэкэндов в этой функции.

Даже если имя допустимо, оно может быть не импортировано или не использовано. Это можно определить только путем загрузки и использования модуля бэкенда.

Параметры:

backendstr

Имя бэкенда.

Возвращает:

bool

True, если бэкенд допустим, False в противном случае.

list_all()[source]

Возвращает список всех известных бэкэндов.

Сюда входят встроенные бэкэнды и те, которые получены во время выполнения либо из точек входа, либо из явной module://some.backend конструкции.

Точки входа будут загружены, если они еще не загружены.

Возвращает:

list of str

Имена бэкэндов.

list_builtin(filter_=None)[source]

Возвращает список бэкэндов, встроенных в Matplotlib.

Параметры:

filter_BackendFilter, optional

Фильтр, применяемый к возвращаемым бэкэнда. Например, чтобы вернуть только неинтерактивные бэкэнды, используйте BackendFilter.NON_INTERACTIVE.

Возвращает:

list of str

Имена бэкэндов.

list_gui_frameworks()[source]

Возвращает список графических оболочек, используемых бэкендами Matplotlib.

Возвращает:

list of str

Имена графических оболочек.

load_backend_module(backend)[source]

Загружает и возвращает модуль, содержащий указанный бэкенд.

Параметры:

backendstr

Имя бэкенда для загрузки.

Возвращает:

Модуль

Модуль, содержащий бэкенд.

resolve_backend(backend)[source]

Возвращает бэкенд и графическую оболочку для указанного имени бэкенда.

Если графическая оболочка еще не известна, она будет определена путем загрузки модуля бэкенда и проверки атрибута FigureCanvas.required_interactive_framework.

Эта функция загружает точки входа только в том случае, если они еще не были загружены, бэкенд не встроен и не имеет формата module://some.backend.

Параметры:

backendstr или None

Имя бэкенда или None для использования по умолчанию.

Возвращает:

backendstr

Имя бэкенда.

frameworkstr или None

Графическая оболочка, которая будет None для неинтерактивного бэкенда.

resolve_gui_or_backend(gui_or_backend)[source]

Возвращает бэкенд и графическую оболочку для указанной строки, которая может быть либо графической оболочкой, либо именем бэкенда, проверяя в таком порядке.

Это используется с магической командой IPython %matplotlib, которая может быть графической оболочкой, такой как %matplotlib qt, или именем бэкенда, таким как %matplotlib qtagg.

Эта функция загружает точки входа только в том случае, если они еще не были загружены, бэкенд не встроен и не имеет формата module://some.backend.

Параметры:

gui_or_backendstr или None

Имя графической оболочки или бэкенда, или None для использования по умолчанию.

Возвращает:

backendstr

Имя бэкенда.

frameworkstr или None

Графическая оболочка, которая будет None для неинтерактивного бэкенда.