matplotlib.cbook
Сборник служебных функций и классов. Изначально многие (но не все) были из Python Cookbook — отсюда и название cbook.
Этот модуль безопасно импортировать из любой точки Matplotlib; он импортирует Matplotlib только во время выполнения.
-
class matplotlib.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На практике, следует всегда отключать все обратные вызовы, когда они больше не нужны, чтобы избежать висячих ссылок (и, следовательно, утечек памяти). Однако реальный код в Matplotlib редко это делает, и из-за его дизайна довольно сложно разместить такой код. Чтобы обойти это и предотвратить этот класс утечек памяти, мы вместо этого храним только слабые ссылки на связанные методы, так что когда целевой объект должен умереть, CallbackRegistry не будет его удерживать.
Параметры: -
exception_handlercallable, optional -
Если указано, должно иметь сигнатуру
def handler(exc: Exception) -> None:
Если не равно None, эта функция будет вызываться с любым подклассом
Exception, поднятым обратными вызовами вCallbackRegistry.process. Обработчик может либо обработать исключение, либо повторно его поднять.Вызываемая функция должна быть сериализуема.
По умолчанию обработчик
def h(exc): traceback.print_exc()
-
connect(self, s, func)[source] -
Зарегистрировать func для вызова при генерации сигнала s.
-
disconnect(self, cid)[source] -
Отключить обратный вызов, зарегистрированный с идентификатором обратного вызова cid.
-
process(self, s, *args, **kwargs)[source] -
Обработать сигнал s.
Все функции, зарегистрированные для получения обратных вызовов по s, будут вызваны с
*argsи**kwargs.
-
-
class matplotlib.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) >>> sorted(map(tuple, grp)) [(a, b, c), (d, e)] >>> grp.joined(a, b) True >>> grp.joined(a, c) True >>> grp.joined(a, d) False
-
clean(self)[source] -
Очистить мертвые слабые ссылки из словаря.
-
get_siblings(self, a)[source] -
Возвращает все элементы, объединенные с a, включая сам a.
-
join(self, a, *args)[source] -
Объединить заданные аргументы в одно множество. Принимает один или несколько аргументов.
-
joined(self, a, b)[source] -
Возвращает, являются ли a и b членами одного множества.
-
remove(self, a)[source]
-
-
exception matplotlib.cbook.IgnoredKeywordWarning(*args, **kwargs)[source] -
Базовый класс:
UserWarning[Устарело] Класс для выдачи предупреждений об аргументах ключевых слов, которые будут проигнорированы Matplotlib.
Примечания
Устарело начиная с версии 3.3.
-
class matplotlib.cbook.Stack(default=None)[source] -
Базовый класс:
objectСтек элементов с перемещаемым курсором.
Эмулирует действия «Назад», «Вперёд» в веб-браузере.
-
back(self)[source] -
Переместить позицию назад и вернуть текущий элемент.
-
bubble(self, o)[source] -
Поднять все ссылки на o наверх стека и вернуть его.
Исключения: - ValueError
-
Если o не находится в стеке.
-
clear(self)[source] -
Очистить стек.
-
empty(self)[source] -
Возвращает, пуст ли стек.
-
forward(self)[source] -
Переместить позицию вперёд и вернуть текущий элемент.
-
home(self)[source] -
Поместить первый элемент в верхнюю часть стека.
Возвращает первый элемент.
-
push(self, o)[source] -
Поместить o в стек в текущей позиции. Отбросить все последующие элементы.
Возвращает o.
-
remove(self, o)[source] -
Удалить o из стека.
Исключения: - ValueError
-
Если o не находится в стеке.
-
-
matplotlib.cbook.boxplot_stats(X, whis=1.5, bootstrap=None, labels=None, autorange=False)[source] -
Возвращает список словарей со статистикой, используемой для построения ряда диаграмм размаха с использованием
bxp.Параметры: -
Xarray-like -
Данные, которые будут представлены на диаграммах размаха. Должны иметь 2 или меньше измерений.
-
whisfloat or (float, float), default: 1.5 -
Положение усов.
Если это число, нижний ус находится в наименьшем значении, большем, чем
Q1 - whis*(Q3-Q1), а верхний — в наибольшем значении, меньшем, чемQ3 + whis*(Q3-Q1), где Q1 и Q3 — первый и третий квартили. Значение по умолчаниюwhis = 1.5соответствует первоначальному определению диаграмм размаха по Туки.Если это пара чисел, они указывают процентили, в которых нужно рисовать усы (например, (5, 95)). В частности, установка этого значения в (0, 100) приводит к усам, охватывающим весь диапазон данных. «range» — устаревшее синоним для (0, 100).
В крайнем случае, где
Q1 == Q3, whis автоматически устанавливается в (0, 100) (охватывает весь диапазон данных), если autorange равно True.Значения данных за пределами усов считаются выбросами и отображаются как отдельные точки.
-
bootstrapint, optional -
Количество раз, которое необходимо выполнить бутстрапинг для построения доверительных интервалов вокруг медианы (метод процентилей).
-
labelsarray-like, optional -
Метки для каждого набора данных. Длина должна соответствовать измерениям X.
-
autorangebool, optional (False) -
Когда
Trueи данные распределены таким образом, что 25-й и 75-й процентили равны,whisустанавливается в (0, 100), чтобы концы усов находились в минимальном и максимальном значениях данных.
Возвращает: - 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()равно True, и мы покрываем все такие области.
-
matplotlib.cbook.delete_masked_points(*args)[source] -
Находит все замаскированные и/или не-конечные точки в наборе аргументов и возвращает аргументы, содержащие только незамаскированные точки.
Аргументы могут принадлежать к одному из 5 категорий:
- Одномерные массивы с масками
- Одномерные массивы NumPy
- Массивы NumPy с более чем одним измерением
- Другие итерируемые объекты, не являющиеся строками
- любой другой тип
Первый аргумент должен принадлежать к одной из первых четырёх категорий; любой аргумент с длиной, отличающейся от длины первого аргумента (и, следовательно, любой аргумент из категории 5) передаётся без изменений.
Маски получаются от всех аргументов правильной длины в категориях 1, 2 и 4; точка считается плохой, если она замаскирована в массиве с масками или если она равна nan или inf. Не предпринимается попыток извлечь маску из категорий 2, 3 и 4, если
numpy.isfiniteне возвращает массив булевых значений.Все входные аргументы, которые не передаются без изменений, возвращаются как массивы NumPy после удаления точек или строк, соответствующих маскам в любом из аргументов.
Значительно упрощённая версия этой функции изначально была написана как помощник для Axes.scatter().
-
matplotlib.cbook.file_requires_unicode(x)[source] -
Возвращает значение, определяющее, требует ли данный объект-подобный файлу Unicode для записи в него.
-
matplotlib.cbook.flatten(seq, scalarp=<function is_scalar_or_string at 0x7fba597fc1f0>)[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_realpath_and_stat(path)[source] -
[Устарело]
Примечания
Устарело начиная с версии 3.3:
-
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 or array-like
Возвращает: -
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.local_over_kwdict(local_var, kwargs, *keys)[source] -
[Устаревший] Обеспечивает приоритет локальной переменной над потенциально конфликтующими аргументами из словаря kwargs. Следующие возможные значения вывода рассматриваются в порядке приоритета:
local_var > kwargs[keys[0]] > ... > kwargs[keys[-1]]
Первое из этих значений, которое не равно None, будет возвращено. Если все они равны None, то будет возвращено None. Каждый ключ в keys будет удалён из словаря kwargs на месте.
Параметры: -
local_varany object -
Локальная переменная (наивысший приоритет).
-
kwargsdict -
Словарь ключевых аргументов; изменяется на месте.
-
keysstr(s) -
Имя(а) ключевых аргументов для обработки в порядке убывания приоритета.
Возвращает: - любой объект
-
Либо local_var, либо одно из kwargs[key] для key в keys.
Исключения: - IgnoredKeywordWarning
-
Для каждого ключа в keys, который был удалён из kwargs, но не использован в качестве значения вывода.
Примечания
Устарело начиная с версии 3.3.
-
-
class matplotlib.cbook.maxdict(maxsize)[source] -
Bases:
dictСловарь с максимальным размером.
Примечания
Это не переопределяет все соответствующие методы для ограничения размера, только
__setitem__, поэтому используйте с осторожностью.
-
matplotlib.cbook.normalize_kwargs(kw, alias_mapping=None, required=<deprecated parameter>, forbidden=<deprecated parameter>, allowed=<deprecated parameter>)[source] -
Вспомогательная функция для нормализации входных данных kwarg.
Порядок их разрешения:
- алиасирование
- обязательные
- запрещённые
- разрешённые
Этот порядок означает, что только канонические имена должны появляться в разрешённых, запрещённых, обязательных.
Параметры: -
kwdict -
Словарь ключевых аргументов.
-
alias_mappingdict or Artist subclass or Artist instance, optional -
Сопоставление между каноническим именем и списком псевдонимов в порядке приоритета от низшего к высшему.
Если каноническое значение не находится в списке, предполагается, что у него наивысший приоритет.
Если передан подкласс или экземпляр Artist, используется его сопоставление алиасов свойств.
-
requiredlist of str, optional -
Список ключей, которые должны быть в kws. Этот параметр устарел.
-
forbiddenlist of str, optional -
Список ключей, которые не должны быть в kw. Этот параметр устарел.
-
allowedlist of str, optional -
Список разрешённых полей. Если это не None, то возникает ошибка, если kw содержит ключи, отсутствующие в объединении обязательных и разрешённых. Чтобы разрешить только обязательные поля, передайте пустой кортеж
allowed=(). Этот параметр устарел.
Исключения: - TypeError
-
Для соответствия тому, что Python поднимает, если недопустимые args/kwargs передаются вызываемому объекту.
-
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] -
Печать циклов циклических ссылок в заданных объектах.
Часто бывает полезно передавать
gc.garbageдля поиска циклов, которые препятствуют удалению некоторых объектов сборщиком мусора.Параметры: - objects
-
Список объектов для поиска циклов.
- outstream
-
Поток для вывода.
-
show_progressbool -
Если True, печатать количество достигнутых объектов по мере их нахождения.
-
matplotlib.cbook.pts_to_midstep(x, *args)[source] -
Преобразование непрерывной линии в точки середин шагов.
Даны набор
Nточек, преобразуйте в2Nточки, которые при линейном соединении дают ступенчатую функцию, меняющую значения в середине интервалов.Параметры: -
xarray -
Положение x шагов. Может быть пустым.
-
y1, ..., yparray -
Массивы 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точки, которые при линейном соединении дают ступенчатую функцию, изменяющую значения в конце интервалов.Параметры: -
xarray -
Положение x шагов. Может быть пустым.
-
y1, ..., yparray -
Массивы 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точки, которые при линейном соединении дают ступенчатую функцию, изменяющую значения в начале интервалов.Параметры: -
xarray -
Положение x шагов. Может быть пустым.
-
y1, ..., yparray -
Массивы 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] -
Возвращает память, потребляемую процессом.
-
matplotlib.cbook.safe_first_element(obj)[source] -
Возвращает первый элемент в obj.
Это независимый от типа способ получения первого элемента, поддерживающий как доступ по индексу, так и протокол итератора.
-
matplotlib.cbook.safe_masked_invalid(x, copy=False)[source]
-
matplotlib.cbook.sanitize_sequence(data)[source] -
Преобразует объекты dictview в список. Другие входные данные возвращаются без изменений.
-
class matplotlib.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>
-
matplotlib.cbook.simple_linear_interpolation(a, steps)[source] -
Пересэмплирование массива с
steps - 1точками между исходными парами точек.Вдоль каждого столбца a вводится
(steps - 1)точек между каждыми исходными значениями; значения линейно интерполируются.Параметры: -
aarray, shape (n, ...) -
stepsint
Возвращает: - массив
-
форма
((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, так как оно позволяет более легко правильно закрывать недавно созданные объекты файлов.Параметры: -
fnamestr or path-like or file-like -
Если
strилиos.PathLike, файл открывается с флагами, указанными в flag и encoding. Если объект похож на файл, он пропускается. -
flagstr, default 'r' -
Передаётся в качестве аргумента mode к
open, когда fname являетсяstrилиos.PathLike; игнорируется, если fname является объектом, похожим на файл. -
return_openedbool, default False -
Если True, возвращает и объект файла, и булево значение, указывающее, был ли это новый файл (который вызывающий метод должен закрыть). Если False, возвращает только новый файл.
-
encodingstr or None, default None -
Передаётся в качестве аргумента mode к
open, когда fname являетсяstrилиos.PathLike; игнорируется, если fname является объектом, похожим на файл.
Возвращает: -
fhfile-like -
openedbool -
opened возвращается только если return_opened равно True.
-
-
matplotlib.cbook.violin_stats(X, method, points=100, quantiles=None)[source] -
Возвращает список словарей данных, которые могут использоваться для рисования серии диаграмм размаха.
См. раздел
Returnsниже, чтобы увидеть необходимые ключи словаря.Пользователи могут пропустить эту функцию и передать пользовательский набор словарей с теми же ключами в
violinplotвместо использования Matplotlib для вычислений. См. раздел Возвращает ниже, для ключей, которые должны быть присутствовать в словарях.Параметры: -
Xarray-like -
Данные выборки, которые будут использоваться для создания оценок плотности гауссова ядра. Должны иметь 2 или менее измерения.
-
methodcallable -
Метод, используемый для вычисления оценки плотности ядра для каждого столбца данных. При вызове через
method(v, coords), он должен возвращать вектор значений KDE, вычисленных в значениях, указанных в coords. -
pointsint, default: 100 -
Определяет количество точек для вычисления каждой из оценок плотности гауссова ядра.
-
quantilesarray-like, default: None -
Определяет (если не None) список чисел с плавающей точкой в интервале [0, 1] для каждого столбца данных, которые представляют квантили, которые будут отображаться для этого столбца данных. Должны иметь 2 или менее измерения. 1D массив будет рассматриваться как список содержащий их.
Возвращает: - список словарей
-
Список словарей, содержащих результаты для каждого столбца данных. Словари содержат по крайней мере следующие:
- coords: Список скаляров, содержащих координаты, в которых была вычислена конкретная оценка плотности ядра.
- vals: Список скаляров, содержащих значения оценки плотности ядра в каждой из координат, указанных в coords.
- mean: Среднее значение для данного столбца данных.
- median: Медианное значение для данного столбца данных.
- min: Минимальное значение для данного столбца данных.
- max: Максимальное значение для данного столбца данных.
- quantiles: Значения квантилей для этого столбца данных.
-
-
exception matplotlib.cbook.deprecation.MatplotlibDeprecationWarning[source] -
Базы:
UserWarningКласс для выдачи предупреждений об устаревании для пользователей Matplotlib.
В связи с тем, что встроенные предупреждения Python о устаревании игнорируются по умолчанию с Python 2.7 (см. ссылку ниже), этот класс был создан для сигнализации об устаревании, но через UserWarning, которые по умолчанию не игнорируются.
https://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x
-
matplotlib.cbook.deprecation.deprecated(since, *, message='', name='', alternative='', pending=False, obj_type=None, addendum='', removal='')[source] -
Декоратор для маркировки функции, класса или свойства как устаревшего.
При устаревании метода класса, статического метода или свойства декоратор
@deprecatedдолжен быть под@classmethodи@staticmethod(т.е.deprecatedдолжен непосредственно декорировать вызываемый объект), но над@property.Параметры: -
sincestr -
Версия, в которой этот API стал устаревшим.
-
messagestr, optional -
Замена стандартного сообщения об устаревании. Местозаменители
%(since)s,%(name)s,%(alternative)s,%(obj_type)s,%(addendum)s, и%(removal)sбудут заменены значениями соответствующих аргументов, переданных в эту функцию. -
namestr, optional -
Имя, используемое в сообщении об устаревании; если не указано, имя определяется автоматически из устаревшего объекта.
-
alternativestr, optional -
Альтернативный API, который пользователь может использовать вместо устаревшего API. Предупреждение об устаревании сообщит пользователю об этой альтернативе, если она указана.
-
pendingbool, optional -
Если True, используется PendingDeprecationWarning вместо DeprecationWarning. Не может быть использовано вместе с removal.
-
obj_typestr, optional -
Тип объекта, который устарел; по умолчанию, 'class', если декоратор применен к классу, 'attribute', если к свойству, 'function' в противном случае.
-
addendumstr, optional -
Дополнительный текст, добавленный непосредственно к окончательному сообщению.
-
removalstr, optional -
Ожидаемая версия удаления. По умолчанию (пустая строка), версия удаления вычисляется автоматически из since. Установите другие ложные значения, чтобы не планировать дату удаления. Не может быть использовано вместе с pending.
Примеры
Базовый пример:
@deprecated('1.4.0') def the_function_to_deprecate(): pass -
-
matplotlib.cbook.deprecation.mplDeprecation -
псевдоним для
matplotlib.cbook.deprecation.MatplotlibDeprecationWarning
-
matplotlib.cbook.deprecation.warn_deprecated(since, *, message='', name='', alternative='', pending=False, obj_type='', addendum='', removal='')[source] -
Отображение стандартизированного предупреждения об устаревании.
Параметры: -
sincestr -
Версия, с которой данный API устарел.
-
messagestr, optional -
Переопределение стандартного сообщения об устаревании. Значения форматов
%(since)s,%(name)s,%(alternative)s,%(obj_type)s,%(addendum)s, и%(removal)sбудут заменены значениями соответствующих аргументов, переданных в эту функцию. -
namestr, optional -
Имя устаревшего объекта.
-
alternativestr, optional -
Альтернативный API, который пользователь может использовать вместо устаревшего API. При указании предупреждение об устаревании сообщит пользователю об этой альтернативе.
-
pendingbool, optional -
Если True, используется PendingDeprecationWarning вместо DeprecationWarning. Не может быть использовано вместе с removal.
-
obj_typestr, optional -
Тип объекта, который устарел.
-
addendumstr, optional -
Дополнительный текст, добавляемый непосредственно к конечному сообщению.
-
removalstr, optional -
Ожидаемая версия удаления. При использовании значения по умолчанию (пустая строка) версия удаления автоматически вычисляется из since. Установка других ложных значений не запланирует дату удаления. Не может быть использовано вместе с pending.
Примеры
Базовый пример:
# To warn of the deprecation of "matplotlib.name_of_module" warn_deprecated('1.4.0', name='matplotlib.name_of_module', obj_type='module') -
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.3.3/api/cbook_api.html