Python matplotlib rename_parameter用法及代码示例

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

用法

matplotlib._api.deprecation.rename_parameter(since, old, new, func=None)

指示 func 的参数 old 的装饰器重命名为 new 。

func 的实际实现应该使用 new ，而不是 old 。如果将 old 传递给 func ，则会发出 DeprecationWarning 并使用其值，即使 new 也通过关键字传递(这是为了简化 pyplot 包装函数，它总是显式传递 new到轴方法)。如果 new 也被传递但在位置上，则在参数绑定期间底层函数将引发 TypeError。

例子

@_api.rename_parameter("3.1", "bad_name", "good_name")
def func(good_name): ...