Decorators with Optional Arguments in Python

2011-12-13 18:34

It is common that features dubbed ‘syntactic sugar’ are often fostering novel approaches to programming problems. Python’s decorators are no different here, and this was a topic I touched upon before. Today I’d like to discuss few quirks which are, unfortunately, adding to their complexity in a way that often doesn’t feel necessary.

Let’s start with something easy. Pretend that we have a simple decorator named @trace, which logs every call of the function it is applied to:

  1. @trace
  2. def some_function(*args):
  3.     pass

An implementation of such decorator is relatively trivial, as it wraps the decorated function directly. One of the possible variants can be seen below:

  1. def trace(func):
  2.     def wrapped(*args, **kwargs):
  3.         logging.debug("Calling %s with args=%s, kwargs=%s",
  4.                       func.__name__, args, kwargs)
  5.         return func(*args, **kwargs)
  6.     return wrapped

That’s pretty cool for starters, but let’s say we want some calls to stand out in the logging output. Perhaps there are functions that we are more interested in than the rest. In other words, we’d like to adjust the priority of log messages that are generated by @trace:

  1. @trace(level=logging.INFO)
  2. def important_func():
  3.     pass

This seemingly small change is actually mandating massive conceptual leap in what our decorator really does. It becomes apparent when we de-sugar the @decorator syntax and look at the plumbing underneath:

  1. important_func = trace(level=logging.INFO)(important_func)

Introduction of parameters requires adding a new level of indirection, because it’s the return value of trace(level=logging.INFO) that does the actual decorating (i.e. transforming given function into another). This might not be obvious at first glance and admittedly, a notion of function that returns a function which takes some other function in order to output a final function might be – ahem – slightly confusing ;-)

But wait! There is just one more thing… When we added the level argument, we not necessarily wanted to lose the ability to invoke @trace without it. Yes, it is still possible – but the syntax is rather awkward:

  1. @trace()
  2. def some_function(*args):
  3.     pass

That’s expected – trace only returns the actual decorator now – but at least slightly annoying. Can we get our pretty syntax back while maintaining the added flexibility of specifying custom arguments? Better yet: can we make @trace, @trace() and @trace(level) all work at the same time?…

Looks like tough call, but fortunately the answer is positive. Before we delve into details, though, let’s step back and try to somewhat improve the way we are writing our decorators.

A class is generally better

As we probably know very well, the quacky nature of Python allows not only functions to be callable. Other language constructs which can also behave that way include all classes, as well as certain kind of objects – namely those implementing the __call__ method. Stitching those two facts together, we can see that classes having __call__ method can be considered “doubly callable”:

  1. class Foo(object):
  2.     def __init__(self, *args): pass
  3.     def __call__(self, *args):
  4.         return 42
  5.  
  6. print Foo(1)(2) # prints 42

This is strikingly similar to de-sugared version of our parametrized @trace decorator. And indeed, it is relatively straightforward to implement as a class:

  1. class TraceDecorator(object):
  2.     def __init__(self, level=logging.DEBUG):
  3.         self.level = level
  4.  
  5.     def __call__(self, func):
  6.         def wrapped(*args, **kwargs):
  7.             logging.log(self.level, "Calling %s(args=%s, kwargs=%s)",
  8.                         func.__name__, args, kwargs)
  9.             return func(*args, **kwargs)
  10.         return wrapped
  11.  
  12. trace = TraceDecorator

For experienced Python developer, the difference might be small, but personally I find it much easier to wrap my head around such class rather than triply-nested function. Also, note that it serves us nicely by clearly separating the key two steps of parametrized decoration: creating the decorator object in __init__ (with supplied or default argument) and applying it to a function in __call__. This will come handy in our quest for reclaiming the neat syntax for decorators with optional parameters.

Are you a function, maybe?

To properly support both @trace and @trace(...) form of our decorator, we must properly recognize those two situations. This boils down to determining whether the decorator is directly applied, or is just getting its __init__ parameters. Both cases will provoke a call, but with different arguments – and it’s a difference we can generally detect:

  1. import inspect
  2.  
  3. def trace(*args, **kwargs):
  4.     one_arg = len(args) == 1 and not kwargs
  5.     if one_arg and inspect.isfunction(args[0]):
  6.         decorator = TraceDecorator()
  7.         return decorator(args[0])
  8.     else:
  9.         return TraceDecorator(*args, **kwargs)

It’s rather simple, too. If the decorator is invoked directly, it receives a function as its sole positional parameter. This function shall be decorated, so we are instantiating our class (with default arguments) and “calling” its object on this single parameter that we have received.
On the other hand, getting something else indicates that the decorator is not being called to wrap a function, but is just having some optional arguments passed. In this case we should simply relay them to the class and return an object which is created as a result. This situation corresponds to the parametrized invocation of our decorator, such as @trace(level=logging.INFO).

Note that if we are writing universal decorator that works for any callable, we should obviously replace inspect.isfunction with callable for our heuristics to work correctly.

Getting more general

This pattern of dispatching (described above using the @trace example) is general enough to be used by pretty much any parametrized decorator. It doesn’t even have to be implemented as a class; it just needs to be “doubly callable” and allow for its arguments to be optional. We don’t even need to touch the decorator itself, as the pattern can be encapsulated in a function of its own:

  1. import functools
  2. import inspect
  3.  
  4. def optional_args(decorator):
  5.     @functools.wraps(decorator)
  6.     def dispatcher(*args, **kwargs):
  7.         one_arg = len(args) == 1 and not kwargs
  8.         if one_arg and inspect.isfunction(args[0]):
  9.             decor_obj = decorator()
  10.             return decor_obj(args[0])
  11.         else:
  12.             return decorator(*args, **kwargs)
  13.     return dispatcher

Applying it to the TraceDecorator is trivial:

  1. trace = optional_args(TraceDecorator)

It actually goes even further, as the optional_args function is itself capable of working as decorator! Provided we use at least Python 2.6, we can put it directly in front of our TraceDecorator definition:

  1. @optional_args
  2. class trace(object):
  3.     # ...

In other words, we are decorating our decorators, so we can more easily decorate other things with them. This just screams meta-awesomeness :)

Wrapping up

There is one small limitation of this technique for detecting parametrized and parameterless invocations of decorators. It’s the case when decorator can accept a single positional argument which is a function – other than the function being decorated, that is:

  1. def foo(): pass
  2.  
  3. @decorator(foo) # seems like we are decorating 'foo'!
  4. def bar(): pass

It seems to be rather contrived, though. And even if this issue arises in practice, solution would be very simple. The problematic argument shall be simply made keyword rather than positional:

  1. @decorator(arg=foo)
  2. def bar(): pass

This causes it to land inside kwargs dictionary and prevents from being incorrectly recognized as decorated function.

Tags: , , , ,
Author: Xion, posted under Programming »


2 comments for post “Decorators with Optional Arguments in Python”.
  1. pog992:
    December 14th, 2011 o 19:35

    didn’t even realize that decorator with parameter may be constructed using triple-nested fuctions.

    nice article!

Comments are disabled.
 


© 2017 Karol Kuczmarski "Xion". Layout by Urszulka. Powered by WordPress with QuickLaTeX.com.