mlzboy
mlzboy

Reputation: 14691

about python __doc__ docstring

i want to show docstring of my function, but if i use like this

@cost_time
def func():
    "define ...."
    blabla
print func.__doc__

it will not show the docstring,just because i use some meta programming tricky, how can fix this?

Upvotes: 4

Views: 2281

Answers (2)

AndiDog
AndiDog

Reputation: 70128

Your wrapped function returned from the cost_time decorator must have the docstring instead of func. Therefore, use functools.wraps which correctly sets __name__ and __doc__:

from functools import wraps

def cost_time(fn):
    @wraps(fn)
    def wrapper():
        return fn()

    return wrapper

Upvotes: 12

Ignacio Vazquez-Abrams
Ignacio Vazquez-Abrams

Reputation: 798606

Use functools.wraps().

Upvotes: 2

Related Questions