Python matplotlib deprecated用法及代码示例

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

用法

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

装饰器将函数、类或属性标记为已弃用。

当弃用类方法、静态方法或属性时，@deprecated 装饰器应该转到 under @classmethod 和 @staticmethod(即 deprecated 应该直接装饰底层可调用对象)，但 over @property 。

当弃用旨在用作多继承层次结构中的基类的类 C 时，C must 定义 __init__ 方法(如果 C 而是从其自己的基类继承其 __init__，然后 @deprecated 会在安装自己的 (deprecation-emitting) C.__init__ 时弄乱 __init__ 继承。

参数与 warn_deprecated 相同，但 obj_type 如果装饰类则默认为 'class'，如果装饰属性则默认为 'attribute'，否则为 'function'。

例子

@deprecated('1.4.0')
def the_function_to_deprecate():
    pass