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