Python Class Based Decorator with parameters that can decorate a method or a function

by

You don’t need to mess around with descriptors. It’s enough to create a wrapper function inside the __call__() method and return it. Standard Python functions can always act as either a method or a function, depending on context:

class MyDecorator(object):
    def __init__(self, argument):
        self.arg = argument

    def __call__(self, fn):
        @functools.wraps(fn)
        def decorated(*args, **kwargs):
            print "In my decorator before call, with arg %s" % self.arg
            result = fn(*args, **kwargs)
            print "In my decorator after call, with arg %s" % self.arg
            return result
        return decorated

A bit of explanation about what’s going on when this decorator is used like this:

@MyDecorator("some other func!")
def some_other_function():
    print "in some other function!"

The first line creates an instance of MyDecorator and passes "some other func!" as an argument to __init__(). Let’s call this instance my_decorator. Next, the undecorated function object — let’s call it bare_func — is created and passed to the decorator instance, so my_decorator(bare_func) is executed. This will invoke MyDecorator.__call__(), which will create and return a wrapper function. Finally this wrapper function is assigned to the name some_other_function.

More Related Contents:

  1. TypeError: method() takes 1 positional argument but 2 were given
  2. What is the difference between a function, an unbound method and a bound method?
  3. Why does Python code use len() function instead of a length method?
  4. Why does using `arg=None` fix Python’s mutable default argument issue?
  5. Why do some functions have underscores “__” before and after the function name?
  6. How do I create a Python function with optional arguments?
  7. Python: Passing variables between functions
  8. Difference between methods and functions, in Python compared to C++
  9. How can I pass information (a variable) out of a function? How can I use that from outside, e.g. in other functions?
  10. Best way to check function arguments? [closed]
  11. How do I define a function with optional arguments?
  12. Python function as a function argument?
  13. Overloaded functions in Python
  14. Python passing list as argument
  15. What is a maximum number of arguments in a Python function?
  16. Why do I get a TypeError that says “takes no arguments (1 given)”? [duplicate]
  17. How to have multiple conditions for one if statement in python [duplicate]
  18. Modifying function arguments
  19. How to make function decorators and chain them together in Python?
  20. In Python, when should I use a function instead of a method?
  21. Python decorator? – can someone please explain this? [duplicate]
  22. “TypeError: method() takes 1 positional argument but 2 were given” but I did only pass one
  23. Get a list/tuple/dict of the arguments passed to a function?
  24. How to get all methods of a Python class with given decorator?
  25. “TypeError: method() takes 1 positional argument but 2 were given” but I only passed one
  26. How does using a function (callback) as an argument to another function work in Python?
  27. In Python, can I specify a function argument’s default in terms of other arguments?
  28. How to create a custom decorator in Django?
  29. Are functions objects in Python?
  30. How can the built-in range function take a single argument or three?

Leave a Comment