python - tiefenbegrenzer - sägeketten schärfen mit schärfgerät




Wie erstelle ich eine Kette von Funktionsdekorateuren? (11)

Wie kann ich zwei Dekorateure in Python erstellen, die Folgendes tun würden?

@makebold
@makeitalic
def say():
   return "Hello"

... die zurückkehren sollte:

"<b><i>Hello</i></b>"

Ich versuche nicht, HTML diese Weise in einer echten Anwendung zu erstellen - ich versuche nur zu verstehen, wie Dekorateure und Dekorateur-Verkettungen funktionieren.


Wie kann ich zwei Dekorateure in Python erstellen, die Folgendes tun würden?

Sie möchten beim Aufruf die folgende Funktion:

@makebold
@makeitalic
def say():
    return "Hello"

Zurückgeben:

<b><i>Hello</i></b>

Einfache Lösung

Am einfachsten machen Sie das, indem Sie Dekorateure erstellen, die Lambdas (anonyme Funktionen) zurückgeben, die über die Funktion (Schließungen) schließen und diese aufrufen:

def makeitalic(fn):
    return lambda: '<i>' + fn() + '</i>'

def makebold(fn):
    return lambda: '<b>' + fn() + '</b>'

Verwenden Sie sie jetzt wie gewünscht:

@makebold
@makeitalic
def say():
    return 'Hello'

und nun:

>>> say()
'<b><i>Hello</i></b>'

Probleme mit der einfachen Lösung

Aber wir scheinen die ursprüngliche Funktion fast verloren zu haben.

>>> say
<function <lambda> at 0x4ACFA070>

Um es zu finden, müssten wir in die Schließung jedes Lambda eintauchen, von denen einer im anderen begraben ist:

>>> say.__closure__[0].cell_contents
<function <lambda> at 0x4ACFA030>
>>> say.__closure__[0].cell_contents.__closure__[0].cell_contents
<function say at 0x4ACFA730>

Wenn wir also eine Dokumentation zu dieser Funktion erstellen oder in der Lage sein möchten, Funktionen zu dekorieren, die mehr als ein Argument erfordern, oder wir nur wissen wollten, welche Funktion wir in einer Debugging-Sitzung betrachteten, müssen wir mit unserer etwas mehr tun Verpackung.

Voll ausgestattete Lösung - die meisten dieser Probleme überwinden

Wir haben den Dekorateur wrapsaus dem functoolsModul in der Standardbibliothek!

from functools import wraps

def makeitalic(fn):
    # must assign/update attributes from wrapped function to wrapper
    # __module__, __name__, __doc__, and __dict__ by default
    @wraps(fn) # explicitly give function whose attributes it is applying
    def wrapped(*args, **kwargs):
        return '<i>' + fn(*args, **kwargs) + '</i>'
    return wrapped

def makebold(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return '<b>' + fn(*args, **kwargs) + '</b>'
    return wrapped

Es ist bedauerlich, dass es immer noch eine Boilerplate gibt, aber dies ist so einfach, wie wir es schaffen können.

In Python 3 werden Sie standardmäßig auch zugewiesen __qualname__und __annotations__zugewiesen.

So jetzt:

@makebold
@makeitalic
def say():
    """This function returns a bolded, italicized 'hello'"""
    return 'Hello'

Und nun:

>>> say
<function say at 0x14BB8F70>
>>> help(say)
Help on function say in module __main__:

say(*args, **kwargs)
    This function returns a bolded, italicized 'hello'

Fazit

Wir sehen also, wrapsdass die Wrapping-Funktion fast alles tut, außer uns genau sagen zu lassen, was die Funktion als Argument akzeptiert.

Es gibt andere Module, die möglicherweise versuchen, das Problem zu lösen, aber die Lösung ist noch nicht in der Standardbibliothek enthalten.


Dekoriere Funktionen mit unterschiedlicher Anzahl von Argumenten:

def frame_tests(fn):
    def wrapper(*args):
        print "\nStart: %s" %(fn.__name__)
        fn(*args)
        print "End: %s\n" %(fn.__name__)
    return wrapper

@frame_tests
def test_fn1():
    print "This is only a test!"

@frame_tests
def test_fn2(s1):
    print "This is only a test! %s" %(s1)

@frame_tests
def test_fn3(s1, s2):
    print "This is only a test! %s %s" %(s1, s2)

if __name__ == "__main__":
    test_fn1()
    test_fn2('OK!')
    test_fn3('OK!', 'Just a test!')

Ergebnis:

Start: test_fn1  
This is only a test!  
End: test_fn1  


Start: test_fn2  
This is only a test! OK!  
End: test_fn2  


Start: test_fn3  
This is only a test! OK! Just a test!  
End: test_fn3  

Es sieht so aus, als hätten Ihnen die anderen schon gesagt, wie Sie das Problem lösen können. Ich hoffe, das hilft Ihnen zu verstehen, was Dekorateure sind.

Dekorateure sind nur syntaktischer Zucker.

Diese

@decorator
def func():
    ...

erweitert zu

def func():
    ...
func = decorator(func)

In der Dokumentation erfahren Sie, wie Dekorateure funktionieren. Hier haben Sie gefragt:

def makebold(fn):
    def wrapped():
        return "<b>" + fn() + "</b>"
    return wrapped

def makeitalic(fn):
    def wrapped():
        return "<i>" + fn() + "</i>"
    return wrapped

@makebold
@makeitalic
def hello():
    return "hello world"

print hello() ## returns "<b><i>hello world</i></b>"

Und natürlich können Sie auch Lambdas von einer Dekorateurfunktion zurückgeben:

def makebold(f): 
    return lambda: "<b>" + f() + "</b>"
def makeitalic(f): 
    return lambda: "<i>" + f() + "</i>"

@makebold
@makeitalic
def say():
    return "Hello"

print say()

Wenn Sie keine langen Erklärungen haben, lesen Sie die Antwort von Paolo Bergantino .

Dekorateur-Grundlagen

Pythons Funktionen sind Objekte

Um Dekorateure zu verstehen, müssen Sie zuerst verstehen, dass Funktionen Objekte in Python sind. Das hat wichtige Konsequenzen. Schauen wir uns das an einem einfachen Beispiel an:

def shout(word="yes"):
    return word.capitalize()+"!"

print(shout())
# outputs : 'Yes!'

# As an object, you can assign the function to a variable like any other object 
scream = shout

# Notice we don't use parentheses: we are not calling the function,
# we are putting the function "shout" into the variable "scream".
# It means you can then call "shout" from "scream":

print(scream())
# outputs : 'Yes!'

# More than that, it means you can remove the old name 'shout',
# and the function will still be accessible from 'scream'

del shout
try:
    print(shout())
except NameError, e:
    print(e)
    #outputs: "name 'shout' is not defined"

print(scream())
# outputs: 'Yes!'

Behalte dies im Kopf. Wir werden in Kürze darauf zurückkommen.

Eine weitere interessante Eigenschaft von Python-Funktionen ist, dass sie in einer anderen Funktion definiert werden können!

def talk():

    # You can define a function on the fly in "talk" ...
    def whisper(word="yes"):
        return word.lower()+"..."

    # ... and use it right away!
    print(whisper())

# You call "talk", that defines "whisper" EVERY TIME you call it, then
# "whisper" is called in "talk". 
talk()
# outputs: 
# "yes..."

# But "whisper" DOES NOT EXIST outside "talk":

try:
    print(whisper())
except NameError, e:
    print(e)
    #outputs : "name 'whisper' is not defined"*
    #Python's functions are objects

Funktionsreferenzen

Okay, immer noch hier? Nun der lustige Teil ...

Sie haben gesehen, dass Funktionen Objekte sind. Daher Funktionen:

  • kann einer Variablen zugewiesen werden
  • kann in einer anderen Funktion definiert werden

Das bedeutet, dass eine Funktion eine andere Funktion zurückgeben kann .

def getTalk(kind="shout"):

    # We define functions on the fly
    def shout(word="yes"):
        return word.capitalize()+"!"

    def whisper(word="yes") :
        return word.lower()+"...";

    # Then we return one of them
    if kind == "shout":
        # We don't use "()", we are not calling the function,
        # we are returning the function object
        return shout  
    else:
        return whisper

# How do you use this strange beast?

# Get the function and assign it to a variable
talk = getTalk()      

# You can see that "talk" is here a function object:
print(talk)
#outputs : <function shout at 0xb7ea817c>

# The object is the one returned by the function:
print(talk())
#outputs : Yes!

# And you can even use it directly if you feel wild:
print(getTalk("whisper")())
#outputs : yes...

Es gibt mehr!

Wenn Sie eine Funktion zurückgeben können, können Sie eine als Parameter übergeben:

def doSomethingBefore(func): 
    print("I do something before then I call the function you gave me")
    print(func())

doSomethingBefore(scream)
#outputs: 
#I do something before then I call the function you gave me
#Yes!

Nun, Sie haben einfach alles, um Dekorateure zu verstehen. Sie sehen, Dekorateure sind „Wrapper“, was bedeutet, dass Sie Code vor und nach der Funktion ausführen können, ohne dass die Funktion selbst geändert wird.

Handgefertigte Dekorateure

Wie würden Sie es manuell machen:

# A decorator is a function that expects ANOTHER function as parameter
def my_shiny_new_decorator(a_function_to_decorate):

    # Inside, the decorator defines a function on the fly: the wrapper.
    # This function is going to be wrapped around the original function
    # so it can execute code before and after it.
    def the_wrapper_around_the_original_function():

        # Put here the code you want to be executed BEFORE the original function is called
        print("Before the function runs")

        # Call the function here (using parentheses)
        a_function_to_decorate()

        # Put here the code you want to be executed AFTER the original function is called
        print("After the function runs")

    # At this point, "a_function_to_decorate" HAS NEVER BEEN EXECUTED.
    # We return the wrapper function we have just created.
    # The wrapper contains the function and the code to execute before and after. It’s ready to use!
    return the_wrapper_around_the_original_function

# Now imagine you create a function you don't want to ever touch again.
def a_stand_alone_function():
    print("I am a stand alone function, don't you dare modify me")

a_stand_alone_function() 
#outputs: I am a stand alone function, don't you dare modify me

# Well, you can decorate it to extend its behavior.
# Just pass it to the decorator, it will wrap it dynamically in 
# any code you want and return you a new function ready to be used:

a_stand_alone_function_decorated = my_shiny_new_decorator(a_stand_alone_function)
a_stand_alone_function_decorated()
#outputs:
#Before the function runs
#I am a stand alone function, don't you dare modify me
#After the function runs

Nun möchten Sie wahrscheinlich, dass bei jedem Aufruf von a_stand_alone_function stattdessen a_stand_alone_function_decorated aufgerufen wird. Das ist einfach, überschreiben a_stand_alone_function einfach a_stand_alone_function mit der von my_shiny_new_decorator zurückgegebenen my_shiny_new_decorator :

a_stand_alone_function = my_shiny_new_decorator(a_stand_alone_function)
a_stand_alone_function()
#outputs:
#Before the function runs
#I am a stand alone function, don't you dare modify me
#After the function runs

# That’s EXACTLY what decorators do!

Dekorateure entmystifiziert

Das vorige Beispiel mit der Decorator-Syntax:

@my_shiny_new_decorator
def another_stand_alone_function():
    print("Leave me alone")

another_stand_alone_function()  
#outputs:  
#Before the function runs
#Leave me alone
#After the function runs

Ja, das ist alles, so einfach ist es. @decorator ist nur eine Verknüpfung zu:

another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)

Dekorateure sind nur eine pythonische Variante des Dekorationsdesignmusters . Es gibt mehrere klassische Entwurfsmuster, die in Python eingebettet sind, um die Entwicklung zu vereinfachen (wie Iteratoren).

Natürlich können Sie Dekorateure sammeln:

def bread(func):
    def wrapper():
        print("</''''''\>")
        func()
        print("<\______/>")
    return wrapper

def ingredients(func):
    def wrapper():
        print("#tomatoes#")
        func()
        print("~salad~")
    return wrapper

def sandwich(food="--ham--"):
    print(food)

sandwich()
#outputs: --ham--
sandwich = bread(ingredients(sandwich))
sandwich()
#outputs:
#</''''''\>
# #tomatoes#
# --ham--
# ~salad~
#<\______/>

Verwenden der Python-Decorator-Syntax:

@bread
@ingredients
def sandwich(food="--ham--"):
    print(food)

sandwich()
#outputs:
#</''''''\>
# #tomatoes#
# --ham--
# ~salad~
#<\______/>

Die Reihenfolge, in der Sie die Dekorateure einstellen:

@ingredients
@bread
def strange_sandwich(food="--ham--"):
    print(food)

strange_sandwich()
#outputs:
##tomatoes#
#</''''''\>
# --ham--
#<\______/>
# ~salad~

Nun, um die Frage zu beantworten ...

Als Schlussfolgerung können Sie leicht sehen, wie Sie die Frage beantworten können:

# The decorator to make it bold
def makebold(fn):
    # The new function the decorator returns
    def wrapper():
        # Insertion of some code before and after
        return "<b>" + fn() + "</b>"
    return wrapper

# The decorator to make it italic
def makeitalic(fn):
    # The new function the decorator returns
    def wrapper():
        # Insertion of some code before and after
        return "<i>" + fn() + "</i>"
    return wrapper

@makebold
@makeitalic
def say():
    return "hello"

print(say())
#outputs: <b><i>hello</i></b>

# This is the exact equivalent to 
def say():
    return "hello"
say = makebold(makeitalic(say))

print(say())
#outputs: <b><i>hello</i></b>

Sie können jetzt einfach glücklich gehen oder Ihr Gehirn ein wenig mehr verbrennen und fortgeschrittene Anwendungen von Dekorateuren sehen.

Dekorateure auf die nächste Stufe bringen

Argumente an die dekorierte Funktion übergeben

# It’s not black magic, you just have to let the wrapper 
# pass the argument:

def a_decorator_passing_arguments(function_to_decorate):
    def a_wrapper_accepting_arguments(arg1, arg2):
        print("I got args! Look: {0}, {1}".format(arg1, arg2))
        function_to_decorate(arg1, arg2)
    return a_wrapper_accepting_arguments

# Since when you are calling the function returned by the decorator, you are
# calling the wrapper, passing arguments to the wrapper will let it pass them to 
# the decorated function

@a_decorator_passing_arguments
def print_full_name(first_name, last_name):
    print("My name is {0} {1}".format(first_name, last_name))

print_full_name("Peter", "Venkman")
# outputs:
#I got args! Look: Peter Venkman
#My name is Peter Venkman

Dekorationsmethoden

Eine nette Sache bei Python ist, dass Methoden und Funktionen wirklich gleich sind. Der einzige Unterschied besteht darin, dass Methoden erwarten, dass ihr erstes Argument eine Referenz auf das aktuelle Objekt ( self ) ist.

Das heißt, Sie können auf dieselbe Weise einen Dekorator für Methoden erstellen! Denken Sie daran, sich self zu berücksichtigen:

def method_friendly_decorator(method_to_decorate):
    def wrapper(self, lie):
        lie = lie - 3 # very friendly, decrease age even more :-)
        return method_to_decorate(self, lie)
    return wrapper


class Lucy(object):

    def __init__(self):
        self.age = 32

    @method_friendly_decorator
    def sayYourAge(self, lie):
        print("I am {0}, what did you think?".format(self.age + lie))

l = Lucy()
l.sayYourAge(-3)
#outputs: I am 26, what did you think?

Wenn Sie einen Allzweck-Dekorator erstellen - einen, den Sie auf jede Funktion oder Methode anwenden können, egal welche Argumente -, dann verwenden Sie einfach *args, **kwargs :

def a_decorator_passing_arbitrary_arguments(function_to_decorate):
    # The wrapper accepts any arguments
    def a_wrapper_accepting_arbitrary_arguments(*args, **kwargs):
        print("Do I have args?:")
        print(args)
        print(kwargs)
        # Then you unpack the arguments, here *args, **kwargs
        # If you are not familiar with unpacking, check:
        # http://www.saltycrane.com/blog/2008/01/how-to-use-args-and-kwargs-in-python/
        function_to_decorate(*args, **kwargs)
    return a_wrapper_accepting_arbitrary_arguments

@a_decorator_passing_arbitrary_arguments
def function_with_no_argument():
    print("Python is cool, no argument here.")

function_with_no_argument()
#outputs
#Do I have args?:
#()
#{}
#Python is cool, no argument here.

@a_decorator_passing_arbitrary_arguments
def function_with_arguments(a, b, c):
    print(a, b, c)

function_with_arguments(1,2,3)
#outputs
#Do I have args?:
#(1, 2, 3)
#{}
#1 2 3 

@a_decorator_passing_arbitrary_arguments
def function_with_named_arguments(a, b, c, platypus="Why not ?"):
    print("Do {0}, {1} and {2} like platypus? {3}".format(a, b, c, platypus))

function_with_named_arguments("Bill", "Linus", "Steve", platypus="Indeed!")
#outputs
#Do I have args ? :
#('Bill', 'Linus', 'Steve')
#{'platypus': 'Indeed!'}
#Do Bill, Linus and Steve like platypus? Indeed!

class Mary(object):

    def __init__(self):
        self.age = 31

    @a_decorator_passing_arbitrary_arguments
    def sayYourAge(self, lie=-3): # You can now add a default value
        print("I am {0}, what did you think?".format(self.age + lie))

m = Mary()
m.sayYourAge()
#outputs
# Do I have args?:
#(<__main__.Mary object at 0xb7d303ac>,)
#{}
#I am 28, what did you think?

Argumente an den Dekorateur übergeben

Toll, was würden Sie sagen, wenn Sie dem Dekorateur selbst Argumente übergeben?

Dies kann etwas verdreht werden, da ein Dekorateur eine Funktion als Argument akzeptieren muss. Daher können Sie die Argumente der dekorierten Funktion nicht direkt an den Dekorateur übergeben.

Bevor wir zur Lösung stürzen, schreiben wir eine kleine Erinnerung:

# Decorators are ORDINARY functions
def my_decorator(func):
    print("I am an ordinary function")
    def wrapper():
        print("I am function returned by the decorator")
        func()
    return wrapper

# Therefore, you can call it without any "@"

def lazy_function():
    print("zzzzzzzz")

decorated_function = my_decorator(lazy_function)
#outputs: I am an ordinary function

# It outputs "I am an ordinary function", because that’s just what you do:
# calling a function. Nothing magic.

@my_decorator
def lazy_function():
    print("zzzzzzzz")

#outputs: I am an ordinary function

Es ist genau das gleiche. " my_decorator " wird aufgerufen. Wenn Sie also @my_decorator , @my_decorator Sie Python auf, die Funktion 'beschriftet mit der Variablen " my_decorator "' my_decorator .

Das ist wichtig! Das Etikett, das Sie vergeben, kann direkt auf den Dekorateur verweisen - oder nicht .

Lass uns böse werden. ☺

def decorator_maker():

    print("I make decorators! I am executed only once: "
          "when you make me create a decorator.")

    def my_decorator(func):

        print("I am a decorator! I am executed only when you decorate a function.")

        def wrapped():
            print("I am the wrapper around the decorated function. "
                  "I am called when you call the decorated function. "
                  "As the wrapper, I return the RESULT of the decorated function.")
            return func()

        print("As the decorator, I return the wrapped function.")

        return wrapped

    print("As a decorator maker, I return a decorator")
    return my_decorator

# Let’s create a decorator. It’s just a new function after all.
new_decorator = decorator_maker()       
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator

# Then we decorate the function

def decorated_function():
    print("I am the decorated function.")

decorated_function = new_decorator(decorated_function)
#outputs:
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function

# Let’s call the function:
decorated_function()
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

Keine überraschung hier

Lassen Sie uns genau das Gleiche tun, aber überspringen Sie alle lästigen Zwischenvariablen:

def decorated_function():
    print("I am the decorated function.")
decorated_function = decorator_maker()(decorated_function)
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function.

# Finally:
decorated_function()    
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

Lass es uns noch kürzer machen :

@decorator_maker()
def decorated_function():
    print("I am the decorated function.")
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function.

#Eventually: 
decorated_function()    
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

Hey, hast du das gesehen? Wir haben einen Funktionsaufruf mit der " @ " -Syntax verwendet! :-)

Also zurück zu Dekorateuren mit Argumenten. Wenn wir den Dekorator im Handumdrehen mit Funktionen erzeugen können, können wir der Funktion Argumente übergeben, oder?

def decorator_maker_with_arguments(decorator_arg1, decorator_arg2):

    print("I make decorators! And I accept arguments: {0}, {1}".format(decorator_arg1, decorator_arg2))

    def my_decorator(func):
        # The ability to pass arguments here is a gift from closures.
        # If you are not comfortable with closures, you can assume it’s ok,
        # or read: https://.com/questions/13857/can-you-explain-closures-as-they-relate-to-python
        print("I am the decorator. Somehow you passed me arguments: {0}, {1}".format(decorator_arg1, decorator_arg2))

        # Don't confuse decorator arguments and function arguments!
        def wrapped(function_arg1, function_arg2) :
            print("I am the wrapper around the decorated function.\n"
                  "I can access all the variables\n"
                  "\t- from the decorator: {0} {1}\n"
                  "\t- from the function call: {2} {3}\n"
                  "Then I can pass them to the decorated function"
                  .format(decorator_arg1, decorator_arg2,
                          function_arg1, function_arg2))
            return func(function_arg1, function_arg2)

        return wrapped

    return my_decorator

@decorator_maker_with_arguments("Leonard", "Sheldon")
def decorated_function_with_arguments(function_arg1, function_arg2):
    print("I am the decorated function and only knows about my arguments: {0}"
           " {1}".format(function_arg1, function_arg2))

decorated_function_with_arguments("Rajesh", "Howard")
#outputs:
#I make decorators! And I accept arguments: Leonard Sheldon
#I am the decorator. Somehow you passed me arguments: Leonard Sheldon
#I am the wrapper around the decorated function. 
#I can access all the variables 
#   - from the decorator: Leonard Sheldon 
#   - from the function call: Rajesh Howard 
#Then I can pass them to the decorated function
#I am the decorated function and only knows about my arguments: Rajesh Howard

Hier ist es: ein Dekorateur mit Argumenten. Argumente können als Variable gesetzt werden:

c1 = "Penny"
c2 = "Leslie"

@decorator_maker_with_arguments("Leonard", c1)
def decorated_function_with_arguments(function_arg1, function_arg2):
    print("I am the decorated function and only knows about my arguments:"
           " {0} {1}".format(function_arg1, function_arg2))

decorated_function_with_arguments(c2, "Howard")
#outputs:
#I make decorators! And I accept arguments: Leonard Penny
#I am the decorator. Somehow you passed me arguments: Leonard Penny
#I am the wrapper around the decorated function. 
#I can access all the variables 
#   - from the decorator: Leonard Penny 
#   - from the function call: Leslie Howard 
#Then I can pass them to the decorated function
#I am the decorated function and only know about my arguments: Leslie Howard

Wie Sie sehen, können Sie dem Dekorateur mit diesem Trick Argumente wie jede Funktion übergeben. Sie können sogar *args, **kwargs wenn Sie möchten. Denken Sie daran, Dekorateure werden nur einmal aufgerufen. Nur wenn Python das Skript importiert. Sie können die Argumente danach nicht dynamisch setzen. Wenn Sie "x importieren", ist die Funktion bereits eingerichtet , sodass Sie nichts ändern können.

Lassen Sie uns üben: Dekorateur dekorieren

Okay, als Bonus gebe ich Ihnen einen Ausschnitt, damit jeder Dekorateur generell alle Argumente akzeptiert. Um Argumente zu akzeptieren, haben wir unseren Dekorator mit einer anderen Funktion erstellt.

Wir haben den Dekorateur verpackt.

Gibt es noch etwas, was wir in letzter Zeit gesehen haben?

Oh ja, Dekorateure!

Lass uns Spaß haben und schreibe einen Dekorateur für die Dekorateure:

def decorator_with_args(decorator_to_enhance):
    """ 
    This function is supposed to be used as a decorator.
    It must decorate an other function, that is intended to be used as a decorator.
    Take a cup of coffee.
    It will allow any decorator to accept an arbitrary number of arguments,
    saving you the headache to remember how to do that every time.
    """

    # We use the same trick we did to pass arguments
    def decorator_maker(*args, **kwargs):

        # We create on the fly a decorator that accepts only a function
        # but keeps the passed arguments from the maker.
        def decorator_wrapper(func):

            # We return the result of the original decorator, which, after all, 
            # IS JUST AN ORDINARY FUNCTION (which returns a function).
            # Only pitfall: the decorator must have this specific signature or it won't work:
            return decorator_to_enhance(func, *args, **kwargs)

        return decorator_wrapper

    return decorator_maker

Es kann wie folgt verwendet werden:

# You create the function you will use as a decorator. And stick a decorator on it :-)
# Don't forget, the signature is "decorator(func, *args, **kwargs)"
@decorator_with_args 
def decorated_decorator(func, *args, **kwargs): 
    def wrapper(function_arg1, function_arg2):
        print("Decorated with {0} {1}".format(args, kwargs))
        return func(function_arg1, function_arg2)
    return wrapper

# Then you decorate the functions you wish with your brand new decorated decorator.

@decorated_decorator(42, 404, 1024)
def decorated_function(function_arg1, function_arg2):
    print("Hello {0} {1}".format(function_arg1, function_arg2))

decorated_function("Universe and", "everything")
#outputs:
#Decorated with (42, 404, 1024) {}
#Hello Universe and everything

# Whoooot!

Ich weiß, als Sie das letzte Mal dieses Gefühl hatten, hörte ich einem Mann zu, der sagte: "Bevor Sie Rekursion verstehen, müssen Sie zuerst Rekursion verstehen". Aber fühlst du dich nicht gut, wenn du das beherrschst?

Best Practices: Dekorateure

  • Dekoratoren wurden in Python 2.4 eingeführt. Stellen Sie daher sicher, dass Ihr Code auf> = 2.4 ausgeführt wird.
  • Dekorateure verlangsamen den Funktionsaufruf. Merk dir das.
  • Sie können eine Funktion nicht dekodieren. (Es gibt Hacks, um Dekoratoren zu erstellen, die entfernt werden können, aber niemand verwendet sie.) Sobald eine Funktion dekoriert ist, wird sie für den gesamten Code dekoriert.
  • Dekoratoren wickeln Funktionen ein, die das Debuggen erschweren können. (Dies wird mit Python> = 2.5 besser; siehe unten.)

Das functools Modul wurde in Python 2.5 eingeführt. Es enthält die Funktion functools.wraps() , die den Namen, das Modul und den Dokumentstring der dekorierten Funktion in den Wrapper kopiert.

(Lustige Tatsache: functools.wraps() ist Dekorateur! ☺)

# For debugging, the stacktrace prints you the function __name__
def foo():
    print("foo")

print(foo.__name__)
#outputs: foo

# With a decorator, it gets messy    
def bar(func):
    def wrapper():
        print("bar")
        return func()
    return wrapper

@bar
def foo():
    print("foo")

print(foo.__name__)
#outputs: wrapper

# "functools" can help for that

import functools

def bar(func):
    # We say that "wrapper", is wrapping "func"
    # and the magic begins
    @functools.wraps(func)
    def wrapper():
        print("bar")
        return func()
    return wrapper

@bar
def foo():
    print("foo")

print(foo.__name__)
#outputs: foo

Wie können die Dekorateure nützlich sein?

Nun die große Frage: Wofür kann ich Dekorateure verwenden?

Scheint cool und kraftvoll, aber ein praktisches Beispiel wäre großartig. Nun, es gibt 1000 Möglichkeiten. Klassische Anwendungen erweitern ein Funktionsverhalten von einer externen Bibliothek (Sie können es nicht ändern) oder zum Debuggen (Sie möchten es nicht ändern, da es temporär ist).

Sie können sie verwenden, um mehrere Funktionen wie ein DRY zu erweitern:

def benchmark(func):
    """
    A decorator that prints the time a function takes
    to execute.
    """
    import time
    def wrapper(*args, **kwargs):
        t = time.clock()
        res = func(*args, **kwargs)
        print("{0} {1}".format(func.__name__, time.clock()-t))
        return res
    return wrapper


def logging(func):
    """
    A decorator that logs the activity of the script.
    (it actually just prints it, but it could be logging!)
    """
    def wrapper(*args, **kwargs):
        res = func(*args, **kwargs)
        print("{0} {1} {2}".format(func.__name__, args, kwargs))
        return res
    return wrapper


def counter(func):
    """
    A decorator that counts and prints the number of times a function has been executed
    """
    def wrapper(*args, **kwargs):
        wrapper.count = wrapper.count + 1
        res = func(*args, **kwargs)
        print("{0} has been used: {1}x".format(func.__name__, wrapper.count))
        return res
    wrapper.count = 0
    return wrapper

@counter
@benchmark
@logging
def reverse_string(string):
    return str(reversed(string))

print(reverse_string("Able was I ere I saw Elba"))
print(reverse_string("A man, a plan, a canoe, pasta, heros, rajahs, a coloratura, maps, snipe, percale, macaroni, a gag, a banana bag, a tan, a tag, a banana bag again (or a camel), a crepe, pins, Spam, a rut, a Rolo, cash, a jar, sore hats, a peon, a canal: Panama!"))

#outputs:
#reverse_string ('Able was I ere I saw Elba',) {}
#wrapper 0.0
#wrapper has been used: 1x 
#ablE was I ere I saw elbA
#reverse_string ('A man, a plan, a canoe, pasta, heros, rajahs, a coloratura, maps, snipe, percale, macaroni, a gag, a banana bag, a tan, a tag, a banana bag again (or a camel), a crepe, pins, Spam, a rut, a Rolo, cash, a jar, sore hats, a peon, a canal: Panama!',) {}
#wrapper 0.0
#wrapper has been used: 2x
#!amanaP :lanac a ,noep a ,stah eros ,raj a ,hsac ,oloR a ,tur a ,mapS ,snip ,eperc a ,)lemac a ro( niaga gab ananab a ,gat a ,nat a ,gab ananab a ,gag a ,inoracam ,elacrep ,epins ,spam ,arutaroloc a ,shajar ,soreh ,atsap ,eonac a ,nalp a ,nam A

Natürlich ist das Gute bei Dekorateuren, dass man sie auf fast alles anwenden kann, ohne sie neu zu schreiben. TROCKEN sagte ich:

@counter
@benchmark
@logging
def get_random_futurama_quote():
    from urllib import urlopen
    result = urlopen("http://subfusion.net/cgi-bin/quote.pl?quote=futurama").read()
    try:
        value = result.split("<br><b><hr><br>")[1].split("<br><br><hr>")[0]
        return value.strip()
    except:
        return "No, I'm ... doesn't!"


print(get_random_futurama_quote())
print(get_random_futurama_quote())

#outputs:
#get_random_futurama_quote () {}
#wrapper 0.02
#wrapper has been used: 1x
#The laws of science be a harsh mistress.
#get_random_futurama_quote () {}
#wrapper 0.01
#wrapper has been used: 2x
#Curse you, merciful Poseidon!

Python selbst bietet mehrere Dekoratoren an: property , staticmethod usw.

  • Django verwendet Dekorateure, um das Caching und das Anzeigen von Berechtigungen zu verwalten.
  • Verdreht, um asynchrone Funktionsaufrufe zu fälschen.

Das ist wirklich ein großer Spielplatz.


Diese Antwort wurde lange Zeit beantwortet, aber ich dachte, ich würde meine Decorator-Klasse teilen, die das Schreiben neuer Dekorateure einfach und kompakt macht.

from abc import ABCMeta, abstractclassmethod

class Decorator(metaclass=ABCMeta):
    """ Acts as a base class for all decorators """

    def __init__(self):
        self.method = None

    def __call__(self, method):
        self.method = method
        return self.call

    @abstractclassmethod
    def call(self, *args, **kwargs):
        return self.method(*args, **kwargs)

Zum einen denke ich, dass dies das Verhalten von Dekorateuren sehr klar macht, aber es macht es auch leicht, neue Dekorateure sehr knapp zu definieren. Für das oben aufgeführte Beispiel können Sie es dann wie folgt lösen:

class MakeBold(Decorator):
    def call():
        return "<b>" + self.method() + "</b>"

class MakeItalic(Decorator):
    def call():
        return "<i>" + self.method() + "</i>"

@MakeBold()
@MakeItalic()
def say():
   return "Hello"

Sie könnten es auch verwenden, um komplexere Aufgaben zu erledigen, wie zum Beispiel einen Dekorator, der die Funktion automatisch dazu bringt, auf alle Argumente in einem Iterator rekursiv angewendet zu werden:

class ApplyRecursive(Decorator):
    def __init__(self, *types):
        super().__init__()
        if not len(types):
            types = (dict, list, tuple, set)
        self._types = types

    def call(self, arg):
        if dict in self._types and isinstance(arg, dict):
            return {key: self.call(value) for key, value in arg.items()}

        if set in self._types and isinstance(arg, set):
            return set(self.call(value) for value in arg)

        if tuple in self._types and isinstance(arg, tuple):
            return tuple(self.call(value) for value in arg)

        if list in self._types and isinstance(arg, list):
            return list(self.call(value) for value in arg)

        return self.method(arg)


@ApplyRecursive(tuple, set, dict)
def double(arg):
    return 2*arg

print(double(1))
print(double({'a': 1, 'b': 2}))
print(double({1, 2, 3}))
print(double((1, 2, 3, 4)))
print(double([1, 2, 3, 4, 5]))

Welche drucke:

2
{'a': 2, 'b': 4}
{2, 4, 6}
(2, 4, 6, 8)
[1, 2, 3, 4, 5, 1, 2, 3, 4, 5]

Beachten Sie, dass dieses Beispiel den listTyp nicht in die Instantiierung des Dekorators einbezogen hat. In der abschließenden Druckanweisung wird die Methode auf die Liste selbst und nicht auf die Elemente der Liste angewendet.


Ein Dekorateur übernimmt die Funktionsdefinition und erstellt eine neue Funktion, die diese Funktion ausführt und das Ergebnis transformiert.

@deco
def do():
    ...

ist gleichbedeutend mit:

do = deco(do)

Beispiel:

def deco(func):
    def inner(letter):
        return func(letter).upper()  #upper
    return inner

Diese

@deco
def do(number):
    return chr(number)  # number to letter

ist äquivalent zu diesem def do2 (number): return chr (number)

do2 = deco(do2)

65 <=> 'a'

print(do(65))
print(do2(65))
>>> B
>>> B

Um den Dekorateur zu verstehen, ist es wichtig zu wissen, dass der Dekorateur eine neue Funktion do erstellt hat, die die Funktion ausführt und das Ergebnis transformiert.


Um Dekorateur auf einfachere Weise zu erklären:

Mit:

@decor1
@decor2
def func(*args, **kwargs):
    pass

Wann tun:

func(*args, **kwargs)

Das tust du wirklich:

decor1(decor2(func))(*args, **kwargs)

Hier ist ein einfaches Beispiel für die Verkettung von Dekorateuren. Beachten Sie die letzte Zeile - sie zeigt, was unter den Abdeckungen passiert.

############################################################
#
#    decorators
#
############################################################

def bold(fn):
    def decorate():
        # surround with bold tags before calling original function
        return "<b>" + fn() + "</b>"
    return decorate


def uk(fn):
    def decorate():
        # swap month and day
        fields = fn().split('/')
        date = fields[1] + "/" + fields[0] + "/" + fields[2]
        return date
    return decorate

import datetime
def getDate():
    now = datetime.datetime.now()
    return "%d/%d/%d" % (now.day, now.month, now.year)

@bold
def getBoldDate(): 
    return getDate()

@uk
def getUkDate():
    return getDate()

@bold
@uk
def getBoldUkDate():
    return getDate()


print getDate()
print getBoldDate()
print getUkDate()
print getBoldUkDate()
# what is happening under the covers
print bold(uk(getDate))()

Die Ausgabe sieht folgendermaßen aus:

17/6/2013
<b>17/6/2013</b>
6/17/2013
<b>6/17/2013</b>
<b>6/17/2013</b>

#decorator.py
def makeHtmlTag(tag, *args, **kwds):
    def real_decorator(fn):
        css_class = " class='{0}'".format(kwds["css_class"]) \
                                 if "css_class" in kwds else ""
        def wrapped(*args, **kwds):
            return "<"+tag+css_class+">" + fn(*args, **kwds) + "</"+tag+">"
        return wrapped
    # return decorator dont call it
    return real_decorator

@makeHtmlTag(tag="b", css_class="bold_css")
@makeHtmlTag(tag="i", css_class="italic_css")
def hello():
    return "hello world"

print hello()

Sie können Dekorateur auch in Class schreiben

#class.py
class makeHtmlTagClass(object):
    def __init__(self, tag, css_class=""):
        self._tag = tag
        self._css_class = " class='{0}'".format(css_class) \
                                       if css_class != "" else ""

    def __call__(self, fn):
        def wrapped(*args, **kwargs):
            return "<" + self._tag + self._css_class+">"  \
                       + fn(*args, **kwargs) + "</" + self._tag + ">"
        return wrapped

@makeHtmlTagClass(tag="b", css_class="bold_css")
@makeHtmlTagClass(tag="i", css_class="italic_css")
def hello(name):
    return "Hello, {}".format(name)

print hello("Your name")




python-decorators