How do I pass extra arguments to a Python decorator?

by

Since you are calling the decorator like a function, it needs to return another function which is the actual decorator:

def my_decorator(param):
    def actual_decorator(func):
        print("Decorating function {}, with parameter {}".format(func.__name__, param))
        return function_wrapper(func)  # assume we defined a wrapper somewhere
    return actual_decorator

The outer function will be given any arguments you pass explicitly, and should return the inner function. The inner function will be passed the function to decorate, and return the modified function.

Usually you want the decorator to change the function behavior by wrapping it in a wrapper function. Here’s an example that optionally adds logging when the function is called:

def log_decorator(log_enabled):
    def actual_decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            if log_enabled:
                print("Calling Function: " + func.__name__)
            return func(*args, **kwargs)
        return wrapper
    return actual_decorator

The functools.wraps call copies things like the name and docstring to the wrapper function, to make it more similar to the original function.

Example usage:

>>> @log_decorator(True)
... def f(x):
...     return x+1
...
>>> f(4)
Calling Function: f
5

More Related Contents:

  1. Decorator error: NoneType object is not callable
  2. python 2.7 script to add a column
  3. How can I calculate a list modulo a numer in python?
  4. Python 2: Conditional statement behaviour of lists with greater/smaller [duplicate]
  5. Zip lists in Python
  6. Backporting Python 3 open(encoding=”utf-8″) to Python 2
  7. How can I decorate an instance method with a decorator class?
  8. Selenium Webdriver in Python – files download directory change in Chrome preferences
  9. How to pip or easy_install tkinter on Windows
  10. pip install gives error: Unable to find vcvarsall.bat
  11. Python dynamic function creation with custom names
  12. gcc-4.2 failed with exit status 1
  13. What does an ‘r’ represent before a string in python? [duplicate]
  14. Sort a list to form the largest possible number
  15. Get unicode code point of a character using Python
  16. How to split dictionary into multiple dictionaries fast
  17. Distributed lock manager for Python
  18. Python 3 urllib produces TypeError: POST data should be bytes or an iterable of bytes. It cannot be of type str
  19. How can I copy a Python string?
  20. Connection Timeout with Elasticsearch
  21. How to locate and insert a value in a text box (input) using Python Selenium?
  22. Multiple keys per value
  23. flatten list of list through list comprehension
  24. PyQt GUI order of operations
  25. How to create a new text file using Python
  26. How to save python screen output to a text file
  27. Python: How to resize an image using PIL module
  28. Python not able to open file with non-english characters in path
  29. numpy.sum() giving strange results on large arrays
  30. How to fix TypeError: ‘int’ object is not subscriptable

Leave a Comment