Decorum 1.0.3

因循守旧

为了编写自己的decorators，只需子类decorum.Decorum：

>>> fromdecorumimportDecorum>>> classempty_decorator(Decorum):... """Just inherit from Decorum's builtins."""

当然你会想定制装饰的行为！只有 需要注意的三种方法：

• init()设置装饰器本身；
• wraps()修饰函数；
• call()运行包装函数并返回结果。

这里有一个简单的装饰器来演示礼仪用法：

>>> from__future__importprint_function>>> classverbose_decorator(Decorum):... """Print info about decoration process."""... definit(self,*args,**kwargs):... print('Initializing decorator with args={} and kwargs={}'... .format(args,kwargs))... returnsuper(verbose_decorator,self).init(*args,**kwargs)...... defwraps(self,f):... print('Wrapping function "{}"'.format(f.__name__))... returnsuper(verbose_decorator,self).wraps(f)...... defcall(self,*args,**kwargs):... print('Running wrapped function with args={} and kwargs={}'... .format(args,kwargs))... returnsuper(verbose_decorator,self).call(*args,**kwargs)

然后您可以将其用作任何装饰：

>>> @verbose_decorator... deffoo(x):... print(x)Initializing decorator with args=() and kwargs={}
Wrapping function "foo"

>>> foo('bar')Running wrapped function with args=('bar',) and kwargs={}
bar

>>> fromdecorumimportdecorator>>> @decorator... classnoop:... """Override init(), wraps() or call() if you like.""">>> @noop... deffoo():... """Do nothing."""

>>> isinstance(foo,noop)True
>>> isinstance(foo,Decorum)True

不用麻烦用括号

礼仪允许您以统一的方式编写带参数和不带参数的装饰器。 那么您的decorator可以使用有无参数，调用与否，以及 它将以同样的方式工作：

>>> @verbose_decorator... deffoo(x):... print(x)Initializing decorator with args=() and kwargs={}
Wrapping function "foo"

与：

>>> @verbose_decorator()... deffoo(x):... print(x)Initializing decorator with args=() and kwargs={}
Wrapping function "foo"

使用选项初始化装饰器

要实现接受自定义选项的decorator，只需更改init()：

>>> classconfigurable_decorator(Decorum):... definit(self,custom_option='default',*args,**kwargs):... print('Initializing decorator with custom_option="{}"'... .format(custom_option))... # Remember the option, typically for use in wraps() or call().... self.custom_option=custom_option... # Call super().init() with remaining arguments.... returnsuper(configurable_decorator,self).init(*args,**kwargs)

当我们使用关键字参数时，它是可选的：

>>> @configurable_decorator... deffoo(x):... print(x)Initializing decorator with custom_option="default"

>>> foo.custom_option'default'

我们可以在修饰函数时传递这个选项。或者作为位置 参数…

>>> @configurable_decorator('positional')... deffoo(x):... print(x)Initializing decorator with custom_option="positional"

>>> foo.custom_option'positional'

…或关键字参数：

>>> @configurable_decorator(custom_option='keyword')... deffoo(x):... print(x)Initializing decorator with custom_option="keyword"

>>> foo.custom_option'keyword'

当然，不能传递未声明为^{tt2}的参数$ 选项：

>>> @configurable_decorator(wrong_option=True)# doctest: +ELLIPSIS... deffoo(x):... print(x)Traceback (most recent call last):
...TypeError: init() got an unexpected keyword argument 'wrong_option'

包装功能

wraps()方法允许您处理修饰的函数。它收到 将修饰为单个位置参数并返回可调用的 （通常是self）。

在大多数情况下，wraps()函数将return super(...,self).wraps(f)。

默认情况下，基Decorum.wraps()将尝试保持assign 属性，即__doc__和 __name__。此功能使用functools.wraps。

>>> classidentity(Decorum):... """Noop decorator: does nothing!""">>> @identity... defmy_function():... """My function's docstring.""">>> print(my_function.__name__)my_function
>>> print(my_function.__doc__)My function's docstring.

可选的assigned关键字参数可用于指定 原始函数的属性直接分配给匹配 包装器函数的属性。默认为 functools.WRAPPER_ASSIGNMENTS。您可以将False或None指定为 禁用此。

>>> @identity(assigned=None)... defmy_function():... """My function's docstring.""">>> print(my_function.__name__)identity
>>> print(my_function.__doc__)Noop decorator: does nothing!

运行修饰函数

Decorum.call()方法接收*args和**kwargs作为输入。它运行 包装的函数，并返回结果。

下面是一个简单的decorator，它重复decorated函数的结果：

>>> classrepeat(Decorum):... defcall(self,*args,**kwargs):... result=super(repeat,self).call(*args,**kwargs)... return' '.join([result]*2)>>> @repeat... defparrot(word):... returnword>>> parrot('hello')'hello hello'

测试装饰器

礼节使测试自定义装饰器变得容易。

>>> decorator=repeat(lambdax:x.upper())>>> result=decorator.call('input')>>> assertresult=='INPUT INPUT'

>>> assertisinstance(my_function,Decorum)>>> assertisinstance(my_function,identity)

知道n限制

礼仪有一些鲜为人知的局限性：

• 装饰程序的init()不能接收单个位置参数 是一个可呼叫的。礼节将尝试触发器wraps()，而不是init()。 这样的案子。

关于

礼仪项目是自由软件，在麻省理工学院许可下发布。

• 圆周率：https://pypi.python.org/pypi/Decorum
• 代码库：https://github.com/zeekay/decorum
• 错误跟踪器：https://github.com/zeekay/decorum/issues
• 连续积分：https://travis-ci.org/zeekay/decorum