Get the name of a decorated function?

Question

here is my decorator:

def check_domain(func):

    def wrapper(domain_id, *args, **kwargs):
        domain = get_object_or_None(Domain, id=domain_id)
        if not domain:
            return None
        return func(domain_id, *args, **kwargs)

    return wrapper

Here is a wrapped up function:

@check_domain
def collect_data(domain_id, from_date, to_date):
    do_stuff(...)

If I do collect_data.__name__ I get wrapper instead of collect_data

Any ideas?

Asked By: RadiantHex

||

Source

Answer 1

Use http://docs.python.org/library/functools.html#functools.wraps

Answered By: Tomasz Zieliński

Answer 2

Check out functools.wraps. Requires python 2.5 or higher though, if that’s an issue.

Answered By: meshantz

Answer 3

You may want to use wraps from functools. See the example

>>> from functools import wraps
>>> def my_decorator(f):
...     @wraps(f)
...     def wrapper(*args, **kwargs):
...         print('Calling decorated function')
...         return f(*args, **kwargs)
...     return wrapper
...
>>> @my_decorator
... def example():
...     """Docstring"""
...     print('Called example function')
...
>>> example()
Calling decorated function
Called example function
>>> example.__name__
'example'
>>> example.__doc__
'Docstring'

Answered By: Tommaso Barbugli

Answer 4

In addition to functools.wraps, you can check out the decorator module which was designed to help with this problem.

Answered By: tkerwin

Answer 5

functools.wraps is not needed! Just use func.__name__

import time

def timeit(func):
    def timed(*args, **kwargs):
        ts = time.time()
        result = func(*args, **kwargs)
        te = time.time()
        print('Function', func.__name__, 'time:', round((te -ts)*1000,1), 'ms')
        print()
        return result
    return timed

@timeit
def math_harder():
    [x**(x%17)^x%17 for x in range(1,5555)]
math_harder()

@timeit
def sleeper_agent():
    time.sleep(1)
sleeper_agent()

Outputs:

Function math_harder time: 8.4 ms
Function sleeper_agent time: 1003.7 ms

Answered By: Zach Estela

Answer 6

For anyone who needs to access the decorated function name when there are multiple decorators, like this:

@decorator1
@decorator2
@decorator3
def decorated_func(stuff):
    return stuff

the functools.wraps mentioned above solves that.

Answered By: Zevgon

Get the name of a decorated function?

Question:

Answers: