matplotlib.backends.registry

classmatplotlib.backends.registry.BackendFilter(*values)[исходный код]

Базовые классы: Enum

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

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

INTERACTIVE=0[исходный код]

NON_INTERACTIVE=1[исходный код]

classmatplotlib.backends.registry.BackendRegistry[исходный код]

Базовые классы: object

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

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

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

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

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

backend_for_gui_framework(framework)[исходный код]

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

Параметры:

frameworkstr

GUI-платформа, например "qt".

Возвращает:

str или None

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

is_valid_backend(backend)[исходный код]

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

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

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

Параметры:

backendstr

Имя бэкенда.

Возвращает:

bool

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

list_all()[исходный код]

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

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

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

Возвращает:

list of str

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

list_builtin(filter_=None)[исходный код]

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

Параметры:

filter_BackendFilter, необязательно

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

Возвращает:

list of str

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

list_gui_frameworks()[исходный код]

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

Возвращает:

list of str

Имена GUI-платформ.

load_backend_module(backend)[исходный код]

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

Параметры:

backendstr

Имя загружаемого бэкенда.

Возвращает:

Module

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

resolve_backend(backend)[исходный код]

Возвращает бэкенд и GUI-платформу для указанного имени бэкенда.

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

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

Параметры:

backendstr или None

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

Возвращает:

backendstr

Имя бэкенда.

frameworkstr или None

GUI-платформа; для неинтерактивного бэкенда это значение будет равно None.

resolve_gui_or_backend(gui_or_backend)[исходный код]

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

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

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

Параметры:

gui_or_backendstr или None

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

Возвращает:

backendstr

Имя бэкенда.

frameworkstr или None

GUI-платформа; для неинтерактивного бэкенда это значение будет равно None.