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')