Python matplotlib Substitution用法及代码示例

本文简要介绍 python 语言中 matplotlib.docstring.Substitution 的用法。

用法

class matplotlib.docstring.Substitution(*args, **kwargs)

基础： object

对对象的文档字符串执行 %-substitution 的装饰器。

即使 obj.__doc__ 为 None(例如，如果 -OO 被传递给解释器)，这个装饰器也应该是健壮的。

用法：构造一个 docstring.Substitution 用一个适合执行替换的序列或字典；然后用构造的对象装饰一个合适的函数，例如：

sub_author_name = Substitution(author='Jason')

@sub_author_name
def some_function(x):
    "%(author)s wrote this function"

# note that some_function.__doc__ is now "Jason wrote this function"

也可以使用位置参数：

sub_first_last_names = Substitution('Edgar Allen', 'Poe')

@sub_first_last_names
def some_function(x):
    "%s %s wrote the Raven"