Jeśli nie lubisz długich wyjaśnień, zobacz odpowiedź Paolo Bergantino .

Podstawy Dekoratora

Funkcje Pythona są obiektami

Aby zrozumieć dekoratory, musisz najpierw zrozumieć, że funkcje są obiektami w Pythonie. Ma to istotne konsekwencje. Zobaczmy dlaczego na prostym przykładzie:

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

Pamiętaj o tym. Wrócimy do tego wkrótce.

Kolejną ciekawą właściwością funkcji Pythona jest to, że można je zdefiniować inside another function!

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

Odwołania do funkcji

Widziałeś, że funkcje są obiektami. Dlatego funkcje:

• można przypisać do zmiennej
• można zdefiniować w innej funkcji

Oznacza to, że funkcja może return inną funkcję .

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

Jeśli możesz return funkcję, możesz przekazać ją jako parametr:

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!

Dekoratorzy ręczni

Jak zrobiłbyś to ręcznie:

# 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

Teraz, prawdopodobnie chcesz tego za każdym razem, gdy dzwonisz a_stand_alone_function, a_stand_alone_function_decorated nazywa się zamiast. To proste, wystarczy zastąpić a_stand_alone_function funkcją return by 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!

Dekoratorzy demystified

Poprzedni przykład, używając składni dekoratora:

@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

another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)

Dekoratorzy są tylko pythonicznym wariantem wzoru projektowego dekoratora . Istnieje kilka klasycznych wzorców projektowych osadzonych w Pythonie w celu ułatwienia rozwoju (jak Iteratory).

Oczywiście można zgromadzić dekoratorów:

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

Używając Składnia dekoratora Pythona:

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

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

Kolejność, którą ustawiasz dekoratorów ma znaczenie:

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

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

Jako wniosek, możesz łatwo zobaczyć, jak odpowiedzieć na pytanie:

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

Możesz teraz po prostu odejść szczęśliwy, lub spalić swój mózg trochę bardziej i zobaczyć zaawansowane zastosowania dekoratorów.

Przenoszenie dekoratorów na kolejny poziom

Przekazywanie argumentów do funkcji

# 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

Dekorowanie metody

Jedną fajną rzeczą w Pythonie jest to, że metody i funkcje są naprawdę takie same. Jedyną różnicą jest to, że metody oczekują, że ich pierwszy argument jest odniesieniem do bieżącego obiektu (self).

Oznacza to, że możesz zbudować dekoratora dla metod w ten sam sposób! Po prostu pamiętaj, aby wziąć pod uwagę self:

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?

Jeśli tworzysz dekorator ogólnego przeznaczenia-taki, który zastosujesz do dowolnej funkcji lub metody, bez względu na jej argumenty - po prostu użyj *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?

Przekazywanie argumentów dekoratorowi

Może to być nieco pokręcone, ponieważ dekorator musi zaakceptować funkcję jako argument. Dlatego nie można przekazać argumentów funkcji dekorowanej bezpośrednio dekoratorowi.

Zanim przejdziemy do rozwiązania, napiszmy małe przypomnienie:

# 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

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.

Zróbmy dokładnie to samo, ale pomiń wszystkie brzydkie zmienne pośrednie:

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.

Zróbmy to jeszcze krócej:

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

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

Oto jest: dekorator z argumentami. Argumenty można ustawić jako zmienną:

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

Jak widzisz, możesz przekazać argumenty do dekoratora jak każda funkcja za pomocą tej sztuczki. Możesz nawet użyć *args, **kwargs, jeśli chcesz. Ale pamiętaj dekoratorów nazywa się tylko raz. Just gdy Python importuje skrypt. Nie można później dynamicznie ustawiać argumentów. Gdy wykonasz "import x", funkcja jest już ozdobiona , więc nie możesz Zmień cokolwiek.

Poćwiczmy: dekorowanie dekoratora

Zapakowaliśmy dekorator.

Coś jeszcze widzieliśmy ostatnio tę zawiniętą funkcję?

Zabawmy się i napiszmy dekoratora dla dekoratorów:

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

Może być stosowany w następujący sposób:

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

Wiem, że ostatnim razem miałeś to uczucie, to było po wysłuchaniu gościa, który powiedział: "zanim zrozumiesz rekurencję, musisz najpierw zrozumieć rekurencję". Ale teraz, nie czujesz się dobrze z opanowaniem tego?

Najlepsze praktyki: dekoratorzy

• dekoratory zostały wprowadzone w Pythonie 2.4, więc upewnij się, że Twój kod będzie uruchomiony na >= 2.4.
• dekoratory spowalniają wywołanie funkcji. Pamiętaj o tym.
• nie można odkodować funkcji. (istnieją } hacki do tworzenia dekoratorów, które można usunąć, ale nikt ich nie używa.) Więc gdy funkcja jest dekorowana, jest dekorowana dla całego kodu .
• dekoratory zawijają funkcje, co może utrudnić ich debugowanie. (To jest lepsze od Pythona > = 2.5; patrz poniżej.)

Moduł functools został wprowadzony w Pythonie 2.5. Zawiera ona funkcję functools.wraps(), która kopiuje nazwę, moduł i docstring dekorowanej funkcji do jej opakowania.

(ciekawostka: functools.wraps() jest dekoratorem! ☺)

# 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

Jak dekoratorzy mogą być przydatni?

Teraz wielkie pytanie: do czego mogę używać dekoratorów?

Wydają się fajne i potężne, ale praktyczny przykład mógłby bądź wielki. Jest 1000 możliwości. Klasyczne zastosowania rozszerzają zachowanie funkcji z zewnętrznej biblioteki lib (nie możesz jej modyfikować) lub do debugowania (nie chcesz jej modyfikować, ponieważ jest tymczasowa).

Można ich używać do rozszerzania kilku funkcji w suchy sposób, jak tak:

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

Oczywiście dobrą rzeczą z dekoratorami jest to, że można ich użyć od razu na prawie wszystkim, bez przepisywania. Suche, powiedziałem:

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

Sam Python zapewnia kilka dekoratorzy: property, staticmethod, itd.

• Django używa dekoratorów do zarządzania buforowaniem i uprawnieniami przeglądania.
• Twisted to fake inlining asynchronous functions calls.

Alternatywnie można napisać funkcję fabryczną, która zwraca dekorator, który zawija wartość zwracaną dekorowanej funkcji w znaczniku przekazanym do funkcji fabrycznej. Na przykład:

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

Pozwala to na napisanie:

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

Lub

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

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

Osobiście napisałbym dekoratora nieco inaczej:

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

Co daje:

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

Nie zapomnij o konstrukcji, dla której składnia dekoratora jest skrótem:

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

Wygląda na to, że inni już ci powiedzieli, jak rozwiązać problem. Mam nadzieję, że to pomoże Ci zrozumieć, czym są dekoratorzy.

To

@decorator
def func():
    ...

Rozszerza się do

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

I oczywiście można również zwrócić lambdy z funkcji dekoratora:

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

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

print say()

Dekoratory Pythona dodają dodatkową funkcjonalność do innej funkcji

Kursywą dekorator może być jak

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

Zauważ, że funkcja jest zdefiniowana wewnątrz funkcji. To, co w zasadzie robi, to zastąpienie funkcji nowo zdefiniowaną. Na przykład, mam tę klasę

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

Teraz powiedz, chcę, aby obie funkcje drukowały "- - - " PO i przed ich wykonaniem. Mogę dodać druk "- - - " przed i po każdej instrukcji drukowania. Ale ponieważ nie lubię się powtarzać, będę make a decorator

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

Więc teraz mogę zmienić klasę na

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

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

Aby dowiedzieć się więcej o dekoratorach, sprawdź http://www.ibm.com/developerworks/linux/library/l-cpdecor.html

Możesz zrobić dwa oddzielne dekoratory, które robią to, co chcesz, jak pokazano poniżej. Zwróć uwagę na użycie *args, **kwargs w deklaracji funkcji wrapped(), która wspiera dekorowaną funkcję posiadającą wiele argumentów (co nie jest tak naprawdę konieczne dla przykładu funkcji say(), ale jest uwzględnione dla ogólności).

Z podobnych powodów, dekorator functools.wraps jest używany do zmiany atrybutów meta funkcji zawiniętej na atrybuty dekorowanej. To sprawia, że komunikaty o błędach i wbudowana dokumentacja funkcji (func.__doc__) będą tymi z dekorowanej funkcji zamiast 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>

Udoskonalenia

Jak widać jest dużo duplikatów kodu w tych dwóch dekoratorach. Biorąc pod uwagę to podobieństwo, lepiej byłoby zamiast tego zrobić ogólny, który był w rzeczywistości fabryką dekoratorów - innymi słowy, dekoratorem, który tworzy inne dekoratory. W ten sposób będzie mniej powtórzeń kodu-i pozwolić na suchy zasada, której należy przestrzegać.

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>

Aby Kod był bardziej czytelny, możesz przypisać bardziej opisową nazwę Do fabrycznie wygenerowanych dekoratorów:

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>

Lub nawet połączyć je w ten sposób:

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>

Efektywność

Podczas gdy powyższe przykłady wykonują całą pracę, generowany kod wiąże się z dużą ilością narzutu w postaci obcych wywołań funkcji, gdy jednocześnie stosuje się wiele dekoratorów. Może to nie mieć znaczenia, w zależności od dokładnego użycia (które może być I / o-bound, na przykład).

Jeśli szybkość dekorowanej funkcji jest ważna, narzut może być zachowany do jednego dodatkowego wywołania funkcji, pisząc nieco inną dekoratorską funkcję fabryczną, która implementuje dodawanie wszystkich znaczników naraz, dzięki czemu może generować kod, który pozwala uniknąć dodatkowych wywołań funkcji powstałych przy użyciu oddzielnych dekoratorów dla każdego znacznika.

Wymaga to więcej kodu w samym dekoratorze, ale działa tylko wtedy, gdy jest aplikowany do definicji funkcji, nie później, gdy sami zostaną wezwani. Dotyczy to również tworzenia bardziej czytelnych nazw za pomocą funkcji lambda, jak poprzednio zilustrowano. Próbka:

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>

Inny sposób robienia tego samego:

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'

Lub bardziej elastycznie:

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'

Jak mogę zrobić dwa dekoratory w Pythonie, które wykonałyby następujące czynności?

Chcesz mieć następującą funkcję, gdy zostanie wywołana:

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

Do powrotu:

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

Proste rozwiązanie

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

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

Teraz używaj ich zgodnie z życzeniem:

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

A teraz:

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

Problemy z prostym rozwiązaniem

Ale wydaje się, że prawie straciliśmy pierwotną funkcję.

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

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

Więc jeśli umieściliśmy dokumentację na tej funkcji, lub chcieliśmy mieć możliwość dekorowania funkcji, które wymagają więcej niż jednego argumentu, lub po prostu chcieliśmy wiedzieć, na jaką funkcję patrzymy w sesji debugowania, musimy zrobić trochę więcej z naszym opakowaniem.

Pełne opisywane rozwiązanie-przezwyciężenie większości tych problemów

Mamy dekorator wraps z modułu functools w bibliotece standardowej!

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

W Pythonie 3 domyślnie przypisywane są również __qualname__ i __annotations__.

Więc teraz:

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

A teraz:

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

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

Podsumowanie

Widzimy więc, że wraps sprawia, że funkcja owijania prawie wszystko, z wyjątkiem tego, co dokładnie funkcja przyjmuje jako argumenty.

Istnieją inne moduły, które mogą próbować rozwiązać ten problem, ale rozwiązanie nie znajduje się jeszcze w bibliotece standardowej.

Dekorator przyjmuje definicję funkcji i tworzy nową funkcję, która wykonuje tę funkcję i przekształca wynik.

@deco
def do():
    ...

Jest eqivarent do:

do = deco(do)

Przykład:

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

To

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

Jest równoznaczne z tym def do2(liczba): return chr (Liczba)

do2 = deco(do2)

65 'a"

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

Aby zrozumieć dekoratora, ważne jest, aby zauważyć, że dekorator stworzył nową funkcję do, która jest wewnętrzna, która wykonuje func i przekształca wynik.

Aby wyjaśnić dekorator w prostszy sposób:

Z:

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

Kiedy:

func(*args, **kwargs)

Naprawdę robisz:

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

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

Możesz również napisać dekorator w klasie

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

Mówiąc o przykładzie licznika - jak podano powyżej, licznik będzie współdzielony między wszystkimi funkcjami używającymi dekoratora:

def counter(func):
    def wrapped(*args, **kws):
        print 'Called #%i' % wrapped.count
        wrapped.count += 1
        return func(*args, **kws)
    wrapped.count = 0
    return wrapped

W ten sposób twój dekorator może być ponownie użyty dla różnych funkcji (lub użyty do dekoracji tej samej funkcji wiele razy: func_counter1 = counter(func); func_counter2 = counter(func)), a zmienna counter pozostanie prywatna dla każdej z nich.

Oto prosty przykład łączenia dekoratorów. Zwróć uwagę na ostatnią linijkę-pokazuje, co dzieje się pod pokrywami.

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

Wyjście wygląda następująco:

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

Dekorowanie funkcji z różną liczbą argumentów:

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

Wynik:

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