matplotlib.cbook

Коллекция служебных функций и классов. Изначально многие (но не все) были взяты из Python Cookbook — отсюда и название cbook.

Этот модуль безопасно импортировать из любой части Matplotlib; он импортирует Matplotlib только во время выполнения.

classmatplotlib.cbook.CallbackRegistry(exception_handler=<function _exception_printer>)[source]

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

Обработка регистрации, обработки, блокирования и отключения сигналов и обратных вызовов:

>>> def oneat(x):
...    print('eat', x)
>>> def ondrink(x):
...    print('drink', x)

>>> from matplotlib.cbook import CallbackRegistry
>>> callbacks = CallbackRegistry()

>>> id_eat = callbacks.connect('eat', oneat)
>>> id_drink = callbacks.connect('drink', ondrink)

>>> callbacks.process('drink', 123)
drink 123
>>> callbacks.process('eat', 456)
eat 456
>>> callbacks.process('be merry', 456) # nothing will be called

>>> callbacks.disconnect(id_eat)
>>> callbacks.process('eat', 456)      # nothing will be called

>>> with callbacks.blocked(signal='drink'):
...     callbacks.process('drink', 123) # nothing will be called
>>> callbacks.process('drink', 123)
drink 123

На практике всегда следует отключать все обратные вызовы, когда они больше не нужны, чтобы избежать висячих ссылок (и, следовательно, утечек памяти). Однако реальный код в Matplotlib редко это делает, и из-за его конструкции довольно сложно разместить такой код. Чтобы обойти это и предотвратить этот тип утечек памяти, мы вместо этого храним только слабые ссылки на связанные методы, поэтому, когда целевой объект должен умереть, CallbackRegistry не будет его поддерживать.

Параметры

exception_handlerвызываемый объект, необязательно

Если не None, exception_handler должен быть функцией, которая принимает исключение Exception в качестве единственного параметра. Она вызывается с любым исключением Exception, возникшим в обратных вызовах во время CallbackRegistry.process, и может либо повторно вызвать исключение, либо обработать его другим способом.

Обработчик по умолчанию выводит исключение (с помощью traceback.print_exc) если запущен интерактивный цикл событий; он повторно вызывает исключение, если интерактивный цикл событий не запущен.

blocked(*, signal=None)

Заблокировать сигналы обратных вызовов от обработки.

Контекстный менеджер для временной блокировки/отключения сигналов обратных вызовов от обработки зарегистрированными слушателями.

Параметры

signalстрока, необязательно

Сигнал обратного вызова для блокировки. По умолчанию блокируются все сигналы.

connect(signal, func)[source]

Зарегистрировать func для вызова, когда генерируется сигнал signal.

disconnect(cid)[source]

Отключить зарегистрированный обратный вызов с идентификатором обратного вызова cid.

Ошибка не возникает, если такой обратный вызов не существует.

process(s, *args, **kwargs)[source]

Обработать сигнал s.

Все функции, зарегистрированные для получения обратных вызовов по s, будут вызваны с *args и **kwargs.

classmatplotlib.cbook.Grouper(init=())[source]

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

Структура данных для непересекающихся множеств.

Объекты могут быть объединены с помощью join(), проверены на связанность с помощью joined(), а все непересекающиеся множества могут быть получены, используя объект как итератор.

Объекты, которые объединяются, должны быть хешируемыми и допускающими слабые ссылки.

Примеры

>>> from matplotlib.cbook import Grouper
>>> class Foo:
...     def __init__(self, s):
...         self.s = s
...     def __repr__(self):
...         return self.s
...
>>> a, b, c, d, e, f = [Foo(x) for x in 'abcdef']
>>> grp = Grouper()
>>> grp.join(a, b)
>>> grp.join(b, c)
>>> grp.join(d, e)
>>> list(grp)
[[a, b, c], [d, e]]
>>> grp.joined(a, b)
True
>>> grp.joined(a, c)
True
>>> grp.joined(a, d)
False

clean()[source]

Очистка мертвых слабых ссылок из словаря.

get_siblings(a)[source]

Возвращает все элементы, объединенные с a, включая сам a.

join(a, *args)[source]

Объединяет заданные аргументы в одно множество. Принимает один или несколько аргументов.

joined(a, b)[source]

Возвращает True, если a и b являются членами одного множества.

remove(a)[source]

classmatplotlib.cbook.Stack(default=None)[source]

Bases: object

Стек элементов со смещаемым курсором.

Имитирует навигацию «назад/вперед» в веб-браузере.

back()[source]

Перемещает позицию назад и возвращает текущий элемент.

bubble(o)[source]

Приподнимает все ссылки на o до вершины стека и возвращает его.

Raises

ValueError

Если o не находится в стеке.

clear()[source]

Очищает стек.

empty()[source]

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

forward()[source]

Перемещает позицию вперед и возвращает текущий элемент.

home()[source]

Помещает первый элемент на вершину стека.

Возвращает первый элемент.

push(o)[source]

Помещает o в стек в текущей позиции. Отбрасывает все последующие элементы.

Возвращает o.

remove(o)[source]

Удаляет o из стека.

Raises

ValueError

Если o не находится в стеке.

matplotlib.cbook.boxplot_stats(X, whis=1.5, bootstrap=None, labels=None, autorange=False)[source]

Возвращает список словарей со статистикой, используемой для построения серии диаграмм размаха и ящиков с помощью bxp.

Parameters

Xarray-like

Данные, которые будут представлены на диаграммах размаха. Должны иметь 2 или меньше измерений.

whisfloat or (float, float), default: 1.5

Положение усов.

Если float, нижний ус находится в самом нижнем значении данных выше Q1 - whis*(Q3-Q1), а верхний ус — в самом высоком значении данных ниже Q3 + whis*(Q3-Q1), где Q1 и Q3 — первый и третий квартили. Значение по умолчанию whis = 1.5 соответствует исходному определению диаграмм размаха по Тьюки.

Если пара чисел с плавающей точкой, они указывают на процентили, в которых нужно рисовать усы (например, (5, 95)). В частности, установка значения на (0, 100) приводит к усам, охватывающим весь диапазон данных.

В крайнем случае, где Q1 == Q3, whis автоматически устанавливается в (0, 100) (охватывать весь диапазон данных), если autorange равно True.

За пределами усов данные считаются выбросами и отображаются как отдельные точки.

bootstrapint, optional

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

labelsarray-like, optional

Метки для каждого набора данных. Длина должна быть совместима с измерениями X.

autorangebool, optional (False)

Когда True и данные распределены таким образом, что 25-й и 75-й процентили равны, whis устанавливается в (0, 100) таким образом, что концы усов находятся в минимуме и максимуме данных.

Returns

list of dict

Список словарей, содержащих результаты для каждого столбца данных. Ключи каждого словаря следующие:

Ключ	Описание значения
label	метка шкалы для диаграммы размаха
mean	арифметическое среднее значение
med	50-й процентиль
q1	первый квартиль (25-й процентиль)
q3	третий квартиль (75-й процентиль)
cilo	нижняя отметка вокруг медианы
cihi	верхняя отметка вокруг медианы
whislo	конец нижнего уса
whishi	конец верхнего уса
fliers	выбросы

Примечания

Не-бутстреповый подход к интервалу доверия использует гауссовское асимптотическое приближение:

\[\mathrm{med} \pm 1.57 \times \frac{\mathrm{iqr}}{\sqrt{N}}\]

Общий подход из: McGill, R., Tukey, J.W., and Larsen, W.A. (1978) "Variations of Boxplots", The American Statistician, 32:12-16.

matplotlib.cbook.contiguous_regions(mask)[source]

Возвращает список (ind0, ind1) такой, что mask[ind0:ind1].all() истинно и мы охватываем все такие области.

matplotlib.cbook.delete_masked_points(*args)[source]

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

Аргументы могут быть любого из 5 категорий:

1. Одномерные замаскированные массивы
2. Одномерные массивы NumPy
3. Массивы NumPy с более чем одним измерением
4. Другие итерируемые объекты, не являющиеся строками
5. Любой другой тип

Первый аргумент должен быть одной из первых четырёх категорий; любой аргумент с длиной, отличающейся от длины первого аргумента (и, следовательно, любой аргумент из пятой категории) будет передан без изменений.

Маски получаются из всех аргументов с правильной длиной в категориях 1, 2 и 4; точка считается плохой, если она замаскирована в замаскированном массиве или является NaN или Inf. Не делается попыток извлечь маску из категорий 2, 3 и 4, если numpy.isfinite не возвращает булевый массив.

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

Значительно более простая версия этой функции изначально была написана в качестве помощника для Axes.scatter().

matplotlib.cbook.deprecated(*args, **kwargs)[source]

[Устаревшее]

Примечания

Устарело начиная с версии 3.4:

matplotlib.cbook.file_requires_unicode(x)[source]

Возвращает значение, указывающее, требует ли данный объект типа «файл для записи» Unicode для записи в него.

matplotlib.cbook.flatten(seq, scalarp=<function is_scalar_or_string>)[source]

Возвращает генератор с выровненными вложенными контейнерами.

Например:

>>> from matplotlib.cbook import flatten
>>> l = (('John', ['Hunter']), (1, 23), [[([42, (5, 23)], )]])
>>> print(list(flatten(l)))
['John', 'Hunter', 1, 23, 42, 5, 23]

Авторы: Хольгер Крекель и Лютер Блиссетт Источник: https://code.activestate.com/recipes/121294/ и рецепт 1.12 в кулинарной книге

matplotlib.cbook.get_sample_data(fname, asfileobj=True, *, np_load=False)[source]

Возвращает файл с образцовыми данными. fname — это путь, относительный к mpl-data/sample_data каталогу. Если asfileobj равен True, возвращается объект файла, в противном случае — просто путь к файлу.

Файлы с образцовыми данными хранятся в каталоге 'mpl-data/sample_data' внутри пакета Matplotlib.

Если имя файла оканчивается на .gz, файл неявно распаковывается. Если имя файла оканчивается на .npy или .npz, asfileobj равно True, и np_load равно True, файл загружается с помощью numpy.load. В настоящее время np_load по умолчанию имеет значение False, но в будущей версии по умолчанию будет True.

matplotlib.cbook.index_of(y)[source]

Вспомогательная функция для создания разумных значений x для заданных y.

Используется для построения графиков (x, y), если значения x не заданы явно.

Сначала попробуйте y.index (предполагая, что y — это pandas.Series), если это не сработает, используйте range(len(y)).

В будущем эта функция будет расширена для обработки других типов данных с метками.

Параметры

yfloat или массив-подобный объект

Возвращает

x, yndarray

Значения x и y для построения графика.

matplotlib.cbook.is_math_text(s)[source]

Возвращает значение, указывающее, содержит ли строка s математические выражения.

Это делается путем проверки наличия в s чётного количества неэкранированных знаков доллара.

matplotlib.cbook.is_scalar_or_string(val)[source]

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

matplotlib.cbook.is_writable_file_like(obj)[source]

Возвращает значение, указывающее, похож ли obj на объект файла с методом write.

matplotlib.cbook.ls_mapper={'-': 'solid', '--': 'dashed', '-.': 'dashdot', ':': 'dotted'}

Отображает короткие коды стиля линий на их полные имена, используемые бэкендами.

matplotlib.cbook.ls_mapper_r={'dashdot': '-.', 'dashed': '--', 'dotted': ':', 'solid': '-'}

Отображает полные имена стилей линий, используемые бэкендами, на их короткие коды.

classmatplotlib.cbook.maxdict(maxsize)[source]

Основан на dict

Словарь с максимальным размером.

Примечания

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

matplotlib.cbook.normalize_kwargs(kw, alias_mapping=None)[source]

Вспомогательная функция для нормализации входных данных kwarg.

Параметры

kwdict или None

Словарь ключевых аргументов. Явно поддерживается None и обрабатывается как пустой словарь, чтобы поддерживать функции с необязательным параметром в формате props=None.

alias_mappingdict или подкласс Artist или экземпляр Artist, необязательно

Сопоставление между каноническим именем и списком псевдонимов в порядке приоритета от низкого к высокому.

Если каноническое значение не входит в список, предполагается, что оно имеет наивысший приоритет.

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

Исключения

TypeError

Для соответствия тому, что Python поднимает, если передаются недопустимые аргументы/ключевые аргументы вызываемому объекту.

matplotlib.cbook.open_file_cm(path_or_file, mode='r', encoding=None)[source]

Передача файлов и управление файлами с использованием путей.

matplotlib.cbook.print_cycles(objects, outstream=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, show_progress=False)[source]

Вывод циклов циклических ссылок в заданных objects.

Часто бывает полезно передать gc.garbage для поиска циклов, которые препятствуют сборке мусора некоторых объектов.

Параметры

objects

Список объектов для поиска циклов.

outstream

Поток для вывода.

show_progressbool

Если True, выводит количество достигнутых объектов по мере их обнаружения.

matplotlib.cbook.pts_to_midstep(x, *args)[source]

Преобразование непрерывной линии в средние шаги.

Учитывая набор N точек, преобразуйте в 2N точки, которые при линейном соединении дают ступенчатую функцию, изменяющую значения в середине интервалов.

Параметры

xмассив

Положение x шагов. Может быть пустым.

y1, ..., ypмассив

Массивы y, которые должны быть преобразованы в шаги; все должны иметь одинаковую длину, что и x.

Возвращает

массив

Значения x и y, преобразованные в шаги в том же порядке, что и входные данные; может быть распаковано как x_out, y1_out, ..., yp_out. Если длина входных данных равна N, каждая из этих массивов будет иметь длину 2N.

Примеры

>>> x_s, y1_s, y2_s = pts_to_midstep(x, y1, y2)

matplotlib.cbook.pts_to_poststep(x, *args)[source]

Преобразование непрерывной линии в постшаги.

Учитывая набор N точек, преобразуйте в 2N + 1 точки, которые при линейном соединении дают ступенчатую функцию, изменяющую значения в конце интервалов.

Параметры

xмассив

Положение x шагов. Может быть пустым.

y1, ..., ypмассив

Массивы y, которые должны быть преобразованы в шаги; все должны иметь одинаковую длину, что и x.

Возвращает

массив

Значения x и y, преобразованные в шаги в том же порядке, что и входные данные; может быть распаковано как x_out, y1_out, ..., yp_out. Если длина входных данных равна N, каждая из этих массивов будет иметь длину 2N + 1. Для N=0, длина будет 0.

Примеры

>>> x_s, y1_s, y2_s = pts_to_poststep(x, y1, y2)

matplotlib.cbook.pts_to_prestep(x, *args)[source]

Преобразование непрерывной линии в предыдущие шаги.

Учитывая набор N точек, преобразуйте в 2N - 1 точки, которые при линейном соединении дают ступенчатую функцию, изменяющую значения в начале интервалов.

Параметры

xмассив

Положение x шагов. Может быть пустым.

y1, ..., ypмассив

Массивы y, которые должны быть преобразованы в шаги; все должны иметь одинаковую длину, что и x.

Возвращает

массив

Значения x и y, преобразованные в шаги в том же порядке, что и входные данные; может быть распаковано как x_out, y1_out, ..., yp_out. Если длина входных данных равна N, каждая из этих массивов будет иметь длину 2N + 1. Для N=0, длина будет 0.

Примеры

>>> x_s, y1_s, y2_s = pts_to_prestep(x, y1, y2)

matplotlib.cbook.report_memory(i=0)[source]

[Устарело] Возвращает память, потребляемую процессом.

Примечания

Устарело начиная с версии 3.5.

matplotlib.cbook.safe_first_element(obj)[source]

Возвращает первый элемент в obj.

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

matplotlib.cbook.safe_masked_invalid(x, copy=False)[source]

matplotlib.cbook.sanitize_sequence(data)[source]

Преобразовать объекты dictview в список. Другие входные данные возвращаются без изменений.

classmatplotlib.cbook.silent_list(type, seq=None)[source]

Базы: list

Список с кратким repr().

Предназначен для использования в однородном списке объектов-артистов, чтобы они не выводили длинные бессмысленные сообщения.

Вместо

[<matplotlib.lines.Line2D object at 0x7f5749fed3c8>,
 <matplotlib.lines.Line2D object at 0x7f5749fed4e0>,
 <matplotlib.lines.Line2D object at 0x7f5758016550>]

получите

<a list of 3 Line2D objects>

Если self.type равно None, имя типа берется из первого элемента списка (если таковой имеется).

matplotlib.cbook.simple_linear_interpolation(a, steps)[source]

Пересэмплирование массива с steps - 1 точками между парами исходных точек.

Вдоль каждой колонки массива a вводится (steps - 1) точек между каждыми исходными значениями; значения линейно интерполируются.

Параметры

aмассив, форма (n, ...)

stepsцелое число

Возвращает

массив

форма ((n - 1) * steps + 1, ...)

matplotlib.cbook.strip_math(s)[source]

Удаление форматирования LaTeX из mathtext.

Обрабатывает только полностью математические и полностью не математические строки.

matplotlib.cbook.to_filehandle(fname, flag='r', return_opened=False, encoding=None)[source]

Преобразование пути в открытый дескриптор файла или передача файлоподобного объекта.

Рассмотрите использование open_file_cm вместо этого, так как он позволяет более легко правильно закрывать вновь созданные файлы.

Параметры

fnameстрока или объект-подобный путь или файлоподобный объект

Если str или os.PathLike, файл открывается с использованием флагов, заданных flag и encoding. Если файлоподобный объект, он передается без изменений.

flagстрока, по умолчанию: 'r'

Передается как аргумент mode к open, когда fname является str или os.PathLike; игнорируется, если fname является файлоподобным объектом.

return_openedbool, по умолчанию: False

Если True, возвращает как объект файла, так и булевое значение, указывающее, был ли это новый файл (который вызывающий код должен закрыть). Если False, возвращает только новый файл.

encodingстрока или None, по умолчанию: None

Передается как аргумент mode к open, когда fname является str или os.PathLike; игнорируется, если fname является файлоподобным объектом.

Возвращает

fhфайл-подобный

openedbool

opened возвращается только если return_opened равно True.

matplotlib.cbook.violin_stats(X, method, points=100, quantiles=None)[source]

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

См. раздел Returns ниже, чтобы увидеть необходимые ключи словаря.

Пользователи могут пропустить эту функцию и передать пользовательский набор словарей с теми же ключами в violinplot вместо использования Matplotlib для вычислений. См. раздел «Возвращает» ниже для ключей, которые должны присутствовать в словарях.

Параметры

Xподобный массиву

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

methodвызываемая функция

Метод, используемый для вычисления оценки плотности вероятности ядра для каждой колонки данных. При вызове через method(v, coords), он должен возвращать вектор значений KDE, вычисленных в значениях, указанных в coords.

pointsцелое число, по умолчанию: 100

Определяет количество точек для вычисления каждой оценки плотности вероятности ядра.

quantilesподобный массиву, по умолчанию: None

Определяет (если не None) список чисел с плавающей точкой в интервале [0, 1] для каждой колонки данных, которые представляют квантили, которые будут отрисованы для этой колонки данных. Должны иметь 2 или менее измерения. 1D массив будет обрабатываться как одиночный список, содержащий их.

Возвращает

список словарей

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

• coords: Список скаляров, содержащих координаты, в которых оценивается эта оценка плотности вероятности ядра.
• vals: Список скаляров, содержащих значения оценки плотности вероятности ядра в каждой из координат, указанных в coords.
• mean: Среднее значение для этой колонки данных.
• median: Медиана для этой колонки данных.
• min: Минимальное значение для этой колонки данных.
• max: Максимальное значение для этой колонки данных.
• quantiles: Значения квантилей для этой колонки данных.

matplotlib.cbook.warn_deprecated(*args, **kwargs)[source]

[Устарело]

Примечания

Устарело начиная с версии 3.4: