Python matplotlib warn_deprecated用法及代码示例

本文简要介绍 python 语言中 matplotlib._api.deprecation.warn_deprecated 的用法。

用法

matplotlib._api.deprecation.warn_deprecated(since, *, message='', name='', alternative='', pending=False, obj_type='', addendum='', removal='')

显示标准化的弃用。

参数：

since str

弃用此 API 的版本。

message str，可选

覆盖默认的弃用消息。 %(since)s 、 %(name)s 、 %(alternative)s 、 %(obj_type)s 、 %(addendum)s 和 %(removal)s 格式说明符将替换为传递给此函数的各个参数的值。

name str，可选

不推荐使用的对象的名称。

alternative str，可选

用户可以使用替代 API 来代替已弃用的 API。如果提供，弃用警告将告诉用户此替代方案。

pending 布尔型，可选

如果为 True，则使用 PendingDeprecationWarning 而不是 DeprecationWarning。不能与 removal 一起使用。

obj_type str，可选

不推荐使用的对象类型。

addendum str，可选

直接附加到最终消息的附加文本。

removal str，可选

预期的删除版本。使用默认值(空字符串)，将自动从 since 计算删除版本。设置为其他 Falsy 值以不安排删除日期。不能与 pending 一起使用。

例子

# To warn of the deprecation of "matplotlib.name_of_module"
warn_deprecated('1.4.0', name='matplotlib.name_of_module',
                obj_type='module')