Python 装饰器处理文档字符串

Question

我在使用带有装饰器的文档字符串时遇到问题。给出以下示例：

def decorator(f):
    def _decorator():
        print 'decorator active'
        f()
    return _decorator

@decorator
def foo():
    '''the magic foo function'''
    print 'this is function foo'

help(foo)

现在帮助没有按预期显示 foo 的文档字符串，它显示：

Help on function _decorator in module __main__:

_decorator()

没有装饰器，帮助是正确的：

Help on function foo in module __main__:

foo()
    the magic foo function

我知道，函数 foo< /code> 被装饰器包装，因此函数对象不再是函数 foo 。但是，有什么好的解决方案可以按预期获取文档字符串（和帮助）呢？

Answer 1

使用 functools.wraps() 更新装饰器的属性：

from functools import wraps

def decorator(f):
    @wraps(f)
    def _decorator():
        print 'decorator active'
        f()
    return _decorator

@decorator
def foo():
    '''the magic foo function'''
    print 'this is function foo'

help(foo)

另请参阅 functools 的标准库文档。

Answer 2

我找到了一个解决方案，但不知道它是否真的很好：

def decorator(f):
    def _decorator():
        print 'decorator active'
        f()
    _decorator.__name__=f.__name__
    _decorator.__doc__=f.__doc__
    return _decorator

_decorator.__name__=f.__name__ 的部分看起来有点丑陋......你觉得怎么样？

Answer 3

看一下functools.wraps：http://docs.python .org/library/functools.html

Answer 4

解决方案非常简单。文档字符串应该在主函数之上调用的最顶层装饰器中提及。查找下面的示例：

import math

def wrap2(func):
    def squarer(x):
        return [math.sqrt(i) for i in func(x)]
    return squarer
    

def wrap1(func):
    def summer(x):
        return [i*2 for i in func(x)]
    return summer

def wrap3(func):
    def rounder(x):
        return [round(i,1) for i in func(x)]
    return rounder

def wrap4(func):
    def stringer(x):
        '''
    Enter the input of a 2-dim array to get the output
    '''
        return [str(i)+' rounds ' for i in func(x)]
    return stringer

@wrap4
@wrap3
@wrap2
@wrap1
def rooter(i):
    return [sum(p) for p in i]

help(rooter)

# output
Help on function stringer in module __main__:

stringer(x)
    Enter the input of a 2-dim array to get the output

---or----

Signature: rooter(x)
Docstring: Enter the input of a 2-dim array to get the output
File:      d:\<ipython-input-392-487fc73b05cf>
Type:      function

因此，必须在 wrap4 装饰器函数 中提及 Doc String，才能使其在 main 函数中可见。