Spec-Zone.ru › Matplotlib 3.3

matplotlib

Управление бэкендами

matplotlib.use(backend, *, force=True) [source]

Выбор бэкенда для отрисовки и интеграции с графическим интерфейсом.

Параметры:
backendstr

Бэкенд для переключения. Это может быть одно из стандартных имён бэкендов, нечувствительных к регистру:

  • интерактивные бэкенды: GTK3Agg, GTK3Cairo, MacOSX, nbAgg, Qt4Agg, Qt4Cairo, Qt5Agg, Qt5Cairo, TkAgg, TkCairo, WebAgg, WX, WXAgg, WXCairo
  • неинтерактивные бэкенды: agg, cairo, pdf, pgf, ps, svg, template

или строка вида: module://my.module.name.

forcebool, default: True

Если True (по умолчанию), вызывать ImportError, если бэкенд не может быть настроен (либо из-за неудачной импортизации, либо из-за работы несовместимой графической интерактивной среды); если False, игнорировать ошибку.

См. также

Бэкенды
matplotlib.get_backend
matplotlib.get_backend() [source]

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

См. также

matplotlib.use
matplotlib.interactive(b) [source]

Установить, нужно ли перерисовывать после каждой команды построения графика (например, pyplot.xlabel).

matplotlib.is_interactive() [source]

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

Значения по умолчанию и стилизация

matplotlib.rcParams

Экземпляр RcParams для обработки значений по умолчанию Matplotlib.

class matplotlib.RcParams(*args, **kwargs) [source]

Объект словаря с валидацией.

Валидирующие функции определены и связаны с параметрами rc в matplotlib.rcsetup.

См. также

Файл matplotlibrc
find_all(self, pattern) [source]

Возвращает подмножество словаря RcParams, ключи которого соответствуют заданному pattern, используя re.search().

Примечание

Изменения в возвращённом словаре не распространяются на родительский словарь RcParams.

matplotlib.rc_context(rc=None, fname=None) [source]

Возвращает менеджер контекста для временного изменения rcParams.

Параметры:
rcdict

rcParams для временного задания.

fnamestr or path-like

Файл с настройками rc Matplotlib. Если заданы оба fname и rc, настройки из rc имеют приоритет.

См. также

Файл matplotlibrc

Примеры

Передача явных значений через словарь:

with mpl.rc_context({'interactive': False}):
    fig, ax = plt.subplots()
    ax.plot(range(3), range(3))
    fig.savefig('example.png')
    plt.close(fig)

Загрузка настроек из файла:

with mpl.rc_context(fname='print.rc'):
    plt.plot(x, y)  # uses 'print.rc'
matplotlib.rc(group, **kwargs) [source]

Установить текущие rcParams. group — группа rc, например, для lines.linewidth группа — lines, для axes.facecolor, группа — axes, и так далее. Группа также может быть списком или кортежем имён групп, например, (xtick, ytick). kwargs — словарь пар имя/значение атрибута, например:

rc('lines', linewidth=2, color='r')

устанавливает текущие rcParams и эквивалентно:

rcParams['lines.linewidth'] = 2
rcParams['lines.color'] = 'r'

Доступны следующие псевдонимы для экономии времени интерактивных пользователей:

Псевдоним Свойство
'lw' 'linewidth'
'ls' 'linestyle'
'c' 'color'
'fc' 'facecolor'
'ec' 'edgecolor'
'mew' 'markeredgewidth'
'aa' 'antialiased'

Таким образом, вы можете сократить вышеуказанный вызов следующим образом:

rc('lines', lw=2, c='r')

Обратите внимание, что вы можете использовать механизм словарей python kwargs для хранения словарей параметров по умолчанию. Например, вы можете настроить параметры шрифта rc следующим образом:

font = {'family' : 'monospace',
        'weight' : 'bold',
        'size'   : 'larger'}
rc('font', **font)  # pass in the font dict as kwargs

Это позволяет легко переключаться между несколькими конфигурациями. Используйте matplotlib.style.use('default') или rcdefaults() для восстановления значений по умолчанию rcParams после изменений.

Примечания

Аналогичная функциональность доступна с помощью обычного интерфейса словаря, т.е. rcParams.update({"lines.linewidth": 2, ...}) (но rcParams.update не поддерживает сокращения или группировку).

matplotlib.rcdefaults() [source]

Восстановить rcParams из внутреннего стиля по умолчанию Matplotlib.

Стилизованные rcParams (определённые в matplotlib.style.core.STYLE_BLACKLIST) не обновляются.

См. также

matplotlib.rc_file_defaults
Восстановить rcParams из файла rc, первоначально загруженного Matplotlib.
matplotlib.style.use
Использование определённого файла стиля. Вызов style.use('default') для восстановления стиля по умолчанию.
matplotlib.rc_file_defaults() [source]

Восстановить rcParams из исходного файла rc, загруженного Matplotlib.

Стилизованные rcParams (определённые в matplotlib.style.core.STYLE_BLACKLIST) не обновляются.

END_OF_DOCUMENT_MARKER
matplotlib.rc_file(fname, *, use_default_template=True) [source]

Обновить rcParams из файла.

Стили, помеченные как исключённые (rcParams) (определённые в matplotlib.style.core.STYLE_BLACKLIST) не обновляются.

Параметры:
fnamestr or path-like

Файл с настройками Matplotlib rc.

use_default_templatebool

Если True, инициализировать значениями по умолчанию перед обновлением из заданного файла. Если False, текущая конфигурация сохраняется, и обновляются только параметры, указанные в файле.

matplotlib.rc_params(fail_on_error=False) [source]

Создать экземпляр RcParams из файла параметров по умолчанию Matplotlib.

matplotlib.rc_params_from_file(fname, fail_on_error=False, use_default_template=True) [source]

Создать RcParams из файла fname.

Параметры:
fnamestr or path-like

Файл с настройками Matplotlib rc.

fail_on_errorbool

Если True, выводить ошибку, если анализатор не может преобразовать параметр.

use_default_templatebool

Если True, инициализировать значениями по умолчанию перед обновлением из заданного файла. Если False, класс конфигурации содержит только параметры, указанные в файле. (Полезно для обновления словарей.)

matplotlib.get_configdir() [source]

Возвращает строку пути к каталогу конфигурации.

Каталог выбирается следующим образом:

  1. Если переменная окружения MPLCONFIGDIR задана, использовать её.
  2. В Linux, следуя спецификации XDG, сначала искать в $XDG_CONFIG_HOME, если определено, или $HOME/.config. В других операционных системах, использовать $HOME/.matplotlib.
  3. Если выбранный каталог существует и доступен для записи, использовать его в качестве каталога конфигурации.
  4. В противном случае создать временный каталог и использовать его как каталог конфигурации.
matplotlib.matplotlib_fname() [source]

Получить расположение файла конфигурации.

Расположение файла определяется в следующем порядке:

  • $PWD/matplotlibrc
  • $MATPLOTLIBRC если это не каталог
  • $MATPLOTLIBRC/matplotlibrc
  • $MPLCONFIGDIR/matplotlibrc
  • В Linux,
    • $XDG_CONFIG_HOME/matplotlib/matplotlibrc (если $XDG_CONFIG_HOME определено)
    • или $HOME/.config/matplotlib/matplotlibrc (если $XDG_CONFIG_HOME не определено)
  • В других операционных системах, - $HOME/.matplotlib/matplotlibrc если $HOME определено
  • В последнюю очередь, ищется в $MATPLOTLIBDATA/matplotlibrc, который должен всегда существовать.
matplotlib.get_data_path(*, _from_rc=None) [source]

Возвращает путь к данным Matplotlib.

Ведение журнала

matplotlib.set_loglevel(level) [source]

Устанавливает уровень корневого регистратора и обработчика корневого регистратора Matplotlib, создавая обработчик, если его ещё нет.

Обычно для получения дополнительной отладочной информации следует вызвать set_loglevel("info") или set_loglevel("debug").

Параметры:
level{"notset", "debug", "info", "warning", "error", "critical"}

Уровень ведения журнала для обработчика.

Примечания

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

Разное

matplotlib.get_cachedir() [source]

Возвращает строку пути к каталогу кэша.

Процедура поиска каталога аналогична _get_config_dir, но используется $XDG_CACHE_HOME/$HOME/.cache вместо этого.

© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.3.3/api/matplotlib_configuration_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API