web-dev-qa-db-fra.com

Fonction agissant à la fois comme décorateur et gestionnaire de contexte en Python?

Cela pourrait pousser les choses un peu trop loin, mais surtout par curiosité ..

Serait-il possible d'avoir un objet appelable (fonction/classe) qui agit comme les deux un gestionnaire de contexte et un décorateur en même temps:

def xxx(*args, **kw):
    # or as a class

@xxx(foo, bar)
def im_decorated(a, b):
    print('do the stuff')

with xxx(foo, bar):
    print('do the stuff')
pythondecoratorcontextmanager
52
Jacob Oscarson

À partir de Python 3.2, la prise en charge est même incluse dans la bibliothèque standard. Dérivant de la classe contextlib.ContextDecorator , il est facile d'écrire des classes qui peuvent être utilisé à la fois comme décorateur ou comme gestionnaire de contexte. Cette fonctionnalité pourrait être facilement rétroportée vers Python 2.x - voici une implémentation de base:

class ContextDecorator(object):
    def __call__(self, f):
        @functools.wraps(f)
        def decorated(*args, **kwds):
            with self:
                return f(*args, **kwds)
        return decorated

Dérivez votre gestionnaire de contexte de cette classe et définissez les méthodes __enter__() et __exit__() comme d'habitude.

45
Sven Marnach

Dans Python 3.2+, vous pouvez définir un gestionnaire de contexte qui est également un décorateur en utilisant @contextlib.contextmanager .

De la documentation:

contextmanager() utilise ContextDecorator pour que les gestionnaires de contexte qu'il crée puissent être utilisés aussi bien comme décorateurs que dans with instructions

Exemple d'utilisation:

>>> from contextlib import contextmanager
>>> @contextmanager
... def example_manager(message):
...     print('Starting', message)
...     try:
...         yield
...     finally:
...         print('Done', message)
... 
>>> with example_manager('printing Hello World'):
...     print('Hello, World!')
... 
Starting printing Hello World
Hello, World!
Done printing Hello World
>>> 
>>> @example_manager('running my function')
... def some_function():
...     print('Inside my function')
... 
>>> some_function()
Starting running my function
Inside my function
Done running my function
25
Mark Amery
class Decontext(object):
    """
    makes a context manager also act as decorator
    """
    def __init__(self, context_manager):
        self._cm = context_manager
    def __enter__(self):
        return self._cm.__enter__()
    def __exit__(self, *args, **kwds):
        return self._cm.__exit__(*args, **kwds)
    def __call__(self, func):
        def wrapper(*args, **kwds):
            with self:
                return func(*args, **kwds)
        return wrapper

maintenant vous pouvez faire:

mydeco = Decontext(some_context_manager)

et cela permet à la fois

@mydeco
def foo(...):
    do_bar()

foo(...)

et

with mydeco:
    do_bar()
12
nosklo

Voici un exemple:

class ContextDecorator(object):
    def __init__(self, foo, bar):
        self.foo = foo
        self.bar = bar
        print("init", foo, bar)

    def __call__(self, f):
        print("call")
        def wrapped_f():
            print("about to call")
            f()
            print("done calling")
        return wrapped_f

    def __enter__(self):
        print("enter")

    def __exit__(self, exc_type, exc_val, exc_tb):
        print("exit")

with ContextDecorator(1, 2):
    print("with")

@ContextDecorator(3, 4)
def sample():
    print("sample")

sample()

Cela imprime:

init 1 2
enter
with
exit
init 3 4
call
about to call
sample
done calling
5
jterrace

Bien que je sois d'accord (et surévalué) @jterrace ici, j'ajoute une très légère variation qui renvoie la fonction décorée et inclut des arguments pour le décorateur et la fonction décorée.

class Decon:
    def __init__(self, a=None, b=None, c=True):
        self.a = a
        self.b = b
        self.c = c

    def __enter__(self):
        # only need to return self 
        # if you want access to it
        # inside the context
        return self 

    def __exit__(self, exit_type, exit_value, exit_traceback):
        # clean up anything you need to
        # otherwise, nothing much more here
        pass

    def __call__(self, func):
        def decorator(*args, **kwargs):
            with self:
                return func(*args, **kwargs)
        return decorator
1
openwonk