Issue 36553: inspect.is_decorator_call(frame) - Python tracker (original) (raw)
Python decorators are frequently proposed by libraries as an easy way to add functionality to user-written functions: see attrs, pytest, click, marshmallow, etc.
A common pattern in most such libraries, is that they do not want to provide users with two different symbols for the same function. So they end up implementing decorators that can be used both as decorators (no arguments no parenthesis) AND decorator factories (arguments in parenthesis). This is convenient and intuitive for users. Unfortunately this is not something trivial to implement because the python language does not make any difference between a no-parenthesis decorator call and a with-parenthesis decorator factory call.
So these libraries have to rely on "tricks", the most common one being to check existence of a non-default first parameter that is a callable.
Examples:
Implementing these tricks is a bit ugly, but more importantly it is a waste of development time because when one changes his decorators signatures, the trick has to possibly be changed (order of arguments, default values, etc). Therefore it is quite a brake to agile development in the first phase of a project, where the api is not very stable.
I regrouped all known and possible tricks in a library https://github.com/smarie/python-decopatch/ to provide a handy way to solve this problem. But it is still "a bunch of tricks". This library, or the manual implementations such as the examples above, could be much faster/efficient if there were at least, a way to determine if a frame is a call to @.
So this is a request to at least have a inspect.is_decorator_call(frame) feature in the stdlib. That function would return True if the frame is a decorator call using @.
Note that a more convenient way to solve this problem is also proposed in https://smarie.github.io/python-decopatch/pep_proposal/#2-preserving-backwards-compatibility : it would be to offer a @decorator_factory helper in the stdlib. But first feedback from python-ideas mailing list showed that this was maybe too disruptive :)
Quick update on this feature: for the following example to work:
from inspect import is_decorator_call
def set_hello_tag(tag='world'):
if is_decorator_call():
# called without parenthesis!
# the decorated object is tag
return set_hello_tag()(tag) # note that is_decorator_call should not return True for this call
else:
def decorate(f):
setattr(f, 'hello', tag) # set a hello tag on the decorated f
return f
return decorate
Then is_decorator_call should be callable without arguments (default to current frame) and should return True only if the current frame is the one directly following decorator application. In nested frames (such as the one obtained after first recursive call to set_hello_tag above, is_decorator_call should return False.