Vraag Hoe maak je een keten van functie-decorateurs?


Hoe kan ik in Python twee decorateurs maken die het volgende zouden doen?

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

... die zou moeten terugkeren:

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

Ik probeer het niet te maken HTML op deze manier in een echte toepassing - gewoon proberen te begrijpen hoe decorateurs en decoratorketens werken.


2377
2018-04-11 07:05


oorsprong


antwoorden:


Uitchecken de documentatie om te zien hoe decorateurs werken. Dit is waar je om vroeg:

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>"

2654
2018-04-11 07:16



Als u niet van een lange uitleg houdt, raadpleegt u Het antwoord van Paolo Bergantino.

Decorator Basics

De functies van Python zijn objecten

Om decorateurs te begrijpen, moet je eerst begrijpen dat functies objecten in Python zijn. Dit heeft belangrijke consequenties. Laten we eens kijken waarom met een eenvoudig voorbeeld:

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!'

Onthoud dit. We zullen er binnenkort op terugkomen.

Een andere interessante eigenschap van Python-functies is dat ze binnen een andere functie kunnen worden gedefinieerd!

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

Verwijzingen naar functies

Oké, nog steeds hier? Nu is het leuke gedeelte ...

Je hebt gezien dat functies objecten zijn. Daarom functies:

  • kan worden toegewezen aan een variabele
  • kan in een andere functie worden gedefinieerd

Dat betekent dat een functie kan return een andere functie.

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...

Er is meer!

Als je kunt return een functie, je kunt een parameter doorgeven als een parameter:

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!

Nou, je hebt gewoon alles wat nodig is om decorateurs te begrijpen. U ziet, decorateurs zijn "wikkels", wat betekent dat ze laten je code uitvoeren voor en na de functie die ze versieren zonder de functie zelf aan te passen.

Handgemaakte decorateurs

Hoe je het handmatig zou doen:

# 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

Nu wil je dat waarschijnlijk elke keer als je belt a_stand_alone_function, a_stand_alone_function_decorated wordt in plaats daarvan genoemd. Dat is gemakkelijk, overschrijf gewoon a_stand_alone_function met de functie geretourneerd door 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!

Decorateurs gedemystificeerd

Het vorige voorbeeld, met behulp van de syntaxis van de decorator:

@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, dat is alles, zo simpel is het. @decorator is slechts een snelkoppeling naar:

another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)

Decorateurs zijn slechts een pythonische variant van de decorateur ontwerppatroon. Er zijn verschillende klassieke ontwerppatronen ingesloten in Python om de ontwikkeling te vergemakkelijken (zoals iterators).

Je kunt natuurlijk decorateurs verzamelen:

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~
#<\______/>

De syntaxis van de Python-decorateur gebruiken:

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

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

De volgorde waarin u de decorateurs hebt ingesteld. MATERIAAL:

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

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

Nu: om de vraag te beantwoorden ...

Als een conclusie kun je gemakkelijk zien hoe je de vraag kunt beantwoorden:

# 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>

Je kunt nu gewoon blij vertrekken, of je hersenen een beetje meer verbranden en geavanceerde toepassingen van decorateurs zien.


Decorateurs naar het volgende niveau brengen

Argumenten doorgeven aan de ingerichte functie

# 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

Decoratiemethoden

Een handige eigenschap van Python is dat de methoden en functies in feite hetzelfde zijn. Het enige verschil is dat methoden verwachten dat hun eerste argument een verwijzing naar het huidige object is (self).

Dat betekent dat u op dezelfde manier een binnenhuisarchitect kunt bouwen! Vergeet niet om te nemen self in overweging:

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?

Als u een decorateur voor algemene doeleinden maakt, een die u toepast op elke functie of methode, ongeacht de argumenten, gebruik deze dan gewoon *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?

Redenen doorgeven aan de binnenhuisarchitect

Geweldig, wat zou je zeggen over het doorgeven van argumenten aan de binnenhuisarchitect zelf?

Dit kan enigszins verwrongen raken, omdat een binnenhuisarchitect een functie als argument moet accepteren. Daarom kun je de argumenten van de gedecoreerde functie niet direct doorgeven aan de binnenhuisarchitect.

Voordat we naar de oplossing gaan, laten we een kleine herinnering schrijven:

# 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

Het is precies hetzelfde. "my_decorator"wordt genoemd. Dus wanneer jij @my_decorator, je vertelt Python om de functie 'gelabeld door de variabele' te noemenmy_decorator"'.

Dit is belangrijk! Het label dat u geeft, kan rechtstreeks naar de decorateur verwijzenof niet.

Laten we kwaad worden.

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.

Geen verrassing hier.

Laten we EXACT hetzelfde doen, maar alle vervelende tussenvariabelen overslaan:

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.

Laten we het maken nog korter:

@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.

Hé, heb je dat gezien? We gebruikten een functieaanroep met de "@"syntax !:-)

Dus terug naar decorateurs met argumenten. Als we functies kunnen gebruiken om de decorateur on the fly te genereren, kunnen we argumenten doorgeven aan die functie, toch?

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://stackoverflow.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 is het: een decorateur met argumenten. Argumenten kunnen als variabel worden ingesteld:

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

Zoals je kunt zien, kun je argumenten doorgeven aan de binnenhuisarchitect zoals elke functie die deze truc gebruikt. Je kunt zelfs gebruiken *args, **kwargs als je dat wenst. Maar vergeet niet dat decorateurs worden genoemd slechts één keer. Net wanneer Python het script importeert. U kunt de argumenten achteraf niet dynamisch instellen. Wanneer u "x importeert", de functie is al versierd, dus dat kan niet verander alles.


Laten we oefenen: een binnenhuisarchitect decoreren

Oké, als een bonus geef ik je een fragment om elke decorateur in het algemeen een argument te laten accepteren. Om argumenten te accepteren, hebben we onze decorateur immers gemaakt met een andere functie.

We hebben de binnenhuisarchitect ingepakt.

Is er nog iets dat we onlangs hebben gezien met die ingepakte functie?

Oh ja, decorateurs!

Laten we plezier maken en een decorateur voor de decorateurs schrijven:

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

Het kan als volgt worden gebruikt:

# 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!

Ik weet het, de laatste keer dat je dit gevoel had, was het na het luisteren van een man die zei: "voordat je recursie begrijpt, moet je eerst recursie begrijpen". Maar nu, voelt u zich niet goed om dit te beheersen?


Beste werkwijzen: decorateurs

  • Decorators werden geïntroduceerd in Python 2.4, dus zorg ervoor dat je code wordt uitgevoerd op> = 2.4.
  • Decorateurs vertragen de functieaanroep. Onthoud dat.
  • U kunt een functie niet ongedaan maken. (Er zijn hackt om decorateurs te maken die kunnen worden verwijderd, maar niemand gebruikt ze.) Dus zodra een functie is ingericht, is deze versierd voor alle code.
  • Decorateurs wikkelen functies, waardoor ze moeilijk te debuggen zijn. (Dit wordt beter van Python> = 2.5, zie hieronder.)

De functools module werd geïntroduceerd in Python 2.5. Het bevat de functie functools.wraps(), die de naam, module en docstring van de ingerichte functie kopieert naar de omslag.

(Leuk weetje: functools.wraps() is een decorateur! )

# 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

Hoe kunnen de decorateurs nuttig zijn?

Nu de grote vraag: Waar kan ik decorateurs voor gebruiken?

Lijkt cool en krachtig, maar een praktisch voorbeeld zou geweldig zijn. Welnu, er zijn 1000 mogelijkheden. Klassieke toepassingen breiden een functiegedrag uit van een externe lib (u kunt deze niet wijzigen), of voor foutopsporing (u wilt dit niet wijzigen omdat het tijdelijk is).

Je kunt ze gebruiken om verschillende functies op de manier van DRY uit te breiden, zoals:

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

Natuurlijk is het goede bij decorateurs dat je ze meteen kunt gebruiken op bijna alles zonder te herschrijven. DROOG, ik zei:

@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 zelf biedt verschillende decorateurs: property, staticmethod, enz.

  • Django gebruikt decorateurs om caching te beheren en machtigingen te bekijken.
  • Gedraaid naar nep-asynchrone inkomende asynchrone functieaanroepen.

Dit is echt een grote speeltuin.


3805
2018-04-11 08:00



U kunt ook een fabrieksfunctie schrijven die een decorateur retourneert die de geretourneerde waarde van de ingerichte functie in een tag verpakt die is doorgegeven aan de fabrieksfunctie. Bijvoorbeeld:

from functools import wraps

def wrap_in_tag(tag):
    def factory(func):
        @wraps(func)
        def decorator():
            return '<%(tag)s>%(rv)s</%(tag)s>' % (
                {'tag': tag, 'rv': func()})
        return decorator
    return factory

Hiermee kun je schrijven:

@wrap_in_tag('b')
@wrap_in_tag('i')
def say():
    return 'hello'

of

makebold = wrap_in_tag('b')
makeitalic = wrap_in_tag('i')

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

Persoonlijk zou ik de decorateur iets anders hebben geschreven:

from functools import wraps

def wrap_in_tag(tag):
    def factory(func):
        @wraps(func)
        def decorator(val):
            return func('<%(tag)s>%(val)s</%(tag)s>' %
                        {'tag': tag, 'val': val})
        return decorator
    return factory

welke zou opleveren:

@wrap_in_tag('b')
@wrap_in_tag('i')
def say(val):
    return val
say('hello')

Vergeet niet de constructie waarvoor de syntax van de decorateur een afkorting is:

say = wrap_in_tag('b')(wrap_in_tag('i')(say)))

132
2017-10-25 06:18



Het lijkt erop dat de andere mensen je al hebben verteld hoe het probleem op te lossen. Ik hoop dat dit je zal helpen begrijpen wat decorateurs zijn.

Decorateurs zijn gewoon syntactische suiker.

Deze

@decorator
def func():
    ...

breidt uit naar

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

100
2018-04-11 07:19



En natuurlijk kun je ook lambda's uit een decorateurfunctie retourneren:

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

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

print say()

59
2018-05-17 03:26



Python-decorateurs voegen extra functionaliteit toe aan een andere functie

Een cursief decorateur zou kunnen zijn

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

Merk op dat een functie binnen een functie is gedefinieerd. Wat het eigenlijk doet, is een functie vervangen door de nieuw gedefinieerde functie. Ik heb bijvoorbeeld deze klasse

class foo:
    def bar(self):
        print "hi"
    def foobar(self):
        print "hi again"

Zeg nu, ik wil dat beide functies "---" afdrukken nadat en voordat ze klaar zijn. Ik zou vóór en na elke printinstructie een print "---" kunnen toevoegen. Maar omdat ik mezelf niet graag herhaal, zal ik een decorateur maken

def addDashes(fn): # notice it takes a function as an argument
    def newFunction(self): # define a new function
        print "---"
        fn(self) # call the original function
        print "---"
    return newFunction
    # Return the newly defined function - it will "replace" the original

Dus nu kan ik mijn klas veranderen in

class foo:
    @addDashes
    def bar(self):
        print "hi"

    @addDashes
    def foobar(self):
        print "hi again"

Kijk voor meer informatie over decorateurs http://www.ibm.com/developerworks/linux/library/l-cpdecor.html


56
2017-12-26 06:13



U kon maak twee afzonderlijke decorateurs die doen wat je wilt, zoals hieronder afgebeeld. Let op het gebruik van *args, **kwargs in de verklaring van de wrapped() functie die de ingerichte functie ondersteunt met meerdere argumenten (wat niet echt nodig is voor het voorbeeld say() functie, maar is opgenomen voor algemeenheid).

Om vergelijkbare redenen is de functools.wraps decorateur wordt gebruikt om de meta-kenmerken van de ingepakte functie te veranderen in die van degene die wordt versierd. Dit maakt foutmeldingen en ingebedde functiedocumentatie (func.__doc__) zijn die van de ingerichte functie in plaats van wrapped()'S.

from functools import wraps

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

def makeitalic(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return "<i>" + fn(*args, **kwargs) + "</i>"
    return wrapped

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

print(say())  # -> <b><i>Hello</i></b>

verfijningen

Zoals je ziet is er veel dubbele code in deze twee decorateurs. Gezien deze gelijkenis zou het beter zijn om in plaats daarvan een generieke te maken die eigenlijk een was decorateur fabriek- met andere woorden, een binnenhuisarchitect die andere decorateurs maakt. Op die manier zou er minder herhaling van code zijn - en de DROOG principe dat moet worden gevolgd.

def html_deco(tag):
    def decorator(fn):
        @wraps(fn)
        def wrapped(*args, **kwargs):
            return '<%s>' % tag + fn(*args, **kwargs) + '</%s>' % tag
        return wrapped
    return decorator

@html_deco('b')
@html_deco('i')
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

Om de code beter leesbaar te maken, kunt u een meer beschrijvende naam toekennen aan de door de fabriek gemaakte decorateurs:

makebold = html_deco('b')
makeitalic = html_deco('i')

@makebold
@makeitalic
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

of combineer ze zelfs als volgt:

makebolditalic = lambda fn: makebold(makeitalic(fn))

@makebolditalic
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

rendement

Hoewel de bovenstaande voorbeelden allemaal werken, heeft de gegenereerde code betrekking op een aanzienlijke hoeveelheid overhead in de vorm van externe functieaanroepen wanneer meerdere inrichters tegelijk worden toegepast. Dit maakt misschien niet uit, afhankelijk van het exacte gebruik (dat bijvoorbeeld I / O-gebonden kan zijn).

Als de snelheid van de gedecoreerde functie belangrijk is, kan de overhead worden gehandhaafd op een enkele extra functieaanroep door een iets andere decoratorfabrieksfunctie te schrijven die implementeert door alle tags tegelijk toe te voegen, zodat het code kan genereren die de extra functieaanroepen vermijdt die zijn opgelopen door voor elke tag aparte decorateurs te gebruiken.

Hiervoor is meer code nodig in de decorateur zelf, maar deze wordt alleen uitgevoerd wanneer deze is ingesteld op functiedefinities, en niet later wanneer ze zelf worden aangeroepen. Dit is ook van toepassing wanneer u meer leesbare namen maakt met lambda functies zoals eerder geïllustreerd. Monster:

def multi_html_deco(*tags):
    start_tags, end_tags = [], []
    for tag in tags:
        start_tags.append('<%s>' % tag)
        end_tags.append('</%s>' % tag)
    start_tags = ''.join(start_tags)
    end_tags = ''.join(reversed(end_tags))

    def decorator(fn):
        @wraps(fn)
        def wrapped(*args, **kwargs):
            return start_tags + fn(*args, **kwargs) + end_tags
        return wrapped
    return decorator

makebolditalic = multi_html_deco('b', 'i')

@makebolditalic
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

25
2017-12-03 18:09



Een andere manier om hetzelfde te doen:

class bol(object):
  def __init__(self, f):
    self.f = f
  def __call__(self):
    return "<b>{}</b>".format(self.f())

class ita(object):
  def __init__(self, f):
    self.f = f
  def __call__(self):
    return "<i>{}</i>".format(self.f())

@bol
@ita
def sayhi():
  return 'hi'

Of, flexibeler:

class sty(object):
  def __init__(self, tag):
    self.tag = tag
  def __call__(self, f):
    def newf():
      return "<{tag}>{res}</{tag}>".format(res=f(), tag=self.tag)
    return newf

@sty('b')
@sty('i')
def sayhi():
  return 'hi'

18
2017-07-26 16:11