Python裝飾器處理文檔字符串

Question

我在裝飾器中使用docstrings時遇到問題。考慮下面的例子：

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被修飾器封裝，所以函數對象不再是函數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) 

另見Standard Library documentation爲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

現在可能是一個有點老，但你這是怎麼做到這一點。只要確保@decorator是在同一行縮進爲def decorator(f)：

from functools import wraps 

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

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

help(foo)