Tài liệu xử lý trang trí bằng Python

Question

Tôi gặp sự cố khi sử dụng docstrings with decorators. Với ví dụ sau:

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) 

Bây giờ sự giúp đỡ không chỉ cho tôi những docstring của foo như mong đợi, nó cho thấy:

Help on function _decorator in module __main__: 

_decorator() 

Nếu không có sự trang trí, sự giúp đỡ là chính xác:

Help on function foo in module __main__: 

foo() 
    the magic foo function 

Tôi biết, chức năng foo được bao quanh bởi trang trí và do đó đối tượng chức năng không còn là chức năng foo nữa. Nhưng một giải pháp tốt đẹp để có được docstring (và sự giúp đỡ) như mong đợi là gì?

Answer 1

Sử dụng functools.wraps() để cập nhật các thuộc tính của trang trí:

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) 

Cũng thấy Standard Library documentation cho functools.

Answer 2

Tôi tìm thấy một giải pháp, nhưng không biết nếu nó thật sự tốt đẹp:

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

Phần với _decorator.__name__=f.__name__ dường như một chút gớm ghiếc ... Bạn nghĩ gì?

Answer 3

Hãy xem functools.wraps: http://docs.python.org/library/functools.html

Answer 4

Đây có thể là một chút cũ bây giờ nhưng đây là cách bạn làm điều đó. Chỉ cần chắc chắn rằng @decorator được thụt vào trên cùng một dòng như 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)