Python'da aşağıdakileri yapacak iki dekoratörü nasıl yapabilirim?

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

... geri dönmesi gereken:

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

HTMLGerçek bir uygulamada bu şekilde yapmaya çalışmıyorum - sadece dekoratörlerin ve dekoratör zincirinin nasıl çalıştığını anlamaya çalışıyorum.

Check out belgelere dekoratörler nasıl çalıştığını görmek için. İşte ne istediniz:

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 hello():
    return "hello world"

@makebold
@makeitalic
def log(s):
    return s

print hello()        # returns "<b><i>hello world</i></b>"
print hello.__name__ # with functools.wraps() this returns "hello"
print log('hello')   # returns "<b><i>hello</i></b>"

Uzun açıklamalara girmiyorsanız Paolo Bergantino'nun cevabına bakınız .

Dekoratör Temel Bilgileri

Python'un fonksiyonları nesnelerdir

Dekoratörleri anlamak için önce işlevlerin Python'daki nesneler olduğunu anlamalısınız. Bunun önemli sonuçları var. Basit bir örnekle nedenini görelim:

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 as e:
    print(e)
    #outputs: "name 'shout' is not defined"

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

Bunu aklında tut. Kısa süre sonra ona geri döneceğiz.

Python fonksiyonlarının bir başka ilginç özelliği, başka bir fonksiyon içinde tanımlanabilmeleridir!

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 as e:
    print(e)
    #outputs : "name 'whisper' is not defined"*
    #Python's functions are objects

Fonksiyon referansları

Tamam, hala burada mısın? Şimdi eğlenceli kısım ...

Fonksiyonların nesne olduğunu gördünüz. Bu nedenle, fonksiyonlar:

• bir değişkene atanabilir
• başka bir fonksiyonda tanımlanabilir

Bu, bir fonksiyonun returnbaşka bir fonksiyon yapabileceği anlamına gelir .

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

Fazlası var!

returnBir işlev yapabiliyorsanız , birini parametre olarak iletebilirsiniz:

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!

Dekoratörleri anlamak için gereken her şeye sahipsiniz. Görüyorsunuz, dekoratörler “sarmalayıcılar” dır, yani , fonksiyonun kendisini değiştirmeden süsledikleri fonksiyondan önce ve sonra kod çalıştırmanıza izin verirler .

El işi dekoratörler

Manuel olarak nasıl yaparsınız:

# 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

Şimdi, muhtemelen çağrı her zaman bunu istiyorum a_stand_alone_function, a_stand_alone_function_decoratedbunun yerine denir. Bu kolay, sadece a_stand_alone_functiondöndürülen işlevle üzerine yaz 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!

Dekoratörler demystified

Dekoratör sözdizimini kullanarak önceki örnek:

@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

Evet, hepsi bu, bu kadar basit. @decoratoryalnızca kısayoludur:

another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)

Dekoratörler, dekoratör tasarım modelinin sadece bir pitonik varyantıdır . Geliştirmeyi kolaylaştırmak için (yineleyiciler gibi) Python'a gömülü birkaç klasik tasarım deseni vardır.

Tabii ki, dekoratörleri biriktirebilirsiniz:

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

Python dekoratör sözdizimini kullanarak:

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

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

Dekoratörleri belirlediğiniz sipariş ÖNEMLİDİR:

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

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

Şimdi: soruyu cevaplamak için ...

Sonuç olarak, soruyu nasıl cevaplayacağınızı kolayca görebilirsiniz:

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

Artık sadece mutlu kalabilir veya beyninizi biraz daha yakabilir ve dekoratörlerin gelişmiş kullanımlarını görebilirsiniz.

Dekoratörleri bir sonraki seviyeye taşımak

Süslü işleve argümanlar iletme

# 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

Dekorasyon yöntemleri

Python ile ilgili şık bir şey, yöntemlerin ve fonksiyonların gerçekten aynı olmasıdır. Tek fark, yöntemlerin ilk argümanlarının geçerli nesneye ( self) bir referans olmasını beklemesidir .

Bu, yöntemler için aynı şekilde bir dekoratör oluşturabileceğiniz anlamına gelir! Sadece selfdikkate almayı unutmayın :

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?

Genel amaçlı dekoratör yapıyorsanız - argümanları ne olursa olsun, herhangi bir işlev veya yönteme başvuracaksınız - o zaman şunu kullanın *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?

Dekoratöre argümanlar iletme

Harika, şimdi dekoratörün kendisine argüman iletmek için ne söylerdiniz?

Bir dekoratörün bir işlevi argüman olarak kabul etmesi gerektiğinden, bu biraz bükülebilir. Bu nedenle, dekore edilmiş işlevin argümanlarını doğrudan dekoratöre iletemezsiniz.

Çözüme acele etmeden önce küçük bir hatırlatma yazalım:

# 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

Tamamen aynı. " my_decorator" olarak adlandırılır. Yani siz @my_decorator, Python'a " my_decorator" " değişkeni ile etiketlenmiş işlevi çağırmasını söylüyorsunuz .

Bu önemli! Verdiğiniz etiket doğrudan dekoratöre işaret edebilir veya etmeyebilir .

Kötülük edelim. ☺

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.

Burada sürpriz yok.

Tam olarak aynı şeyi yapalım, ancak tüm sinir bozucu ara değişkenleri atlayın:

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.

Daha da kısaltalım :

@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, gördün mü? " @" Sözdizimi ile bir işlev çağrısı kullandık ! :-)

Yani, tartışmalı dekoratörlere geri dönelim. Dekoratörü anında oluşturmak için işlevleri kullanabiliyorsak, bu işleve argümanlar iletebiliriz, değil mi?

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: /programming/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

İşte: argümanları olan bir dekoratör. Bağımsız değişkenler değişken olarak ayarlanabilir:

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

Gördüğünüz gibi, bu numarayı kullanarak dekoratöre herhangi bir işlev gibi argümanlar iletebilirsiniz. İsterseniz kullanabilirsiniz *args, **kwargs. Ancak dekoratörlerin sadece bir kez çağrıldığını unutmayın . Python betiği aldığında. Daha sonra bağımsız değişkenleri dinamik olarak ayarlayamazsınız. "Import x" yaptığınızda, işlev zaten dekore edilmiştir , böylece hiçbir şeyi değiştiremezsiniz.

Pratik yapalım: bir dekoratörü dekore etmek

Tamam, bonus olarak, herhangi bir dekoratörün genel olarak herhangi bir argümanı kabul etmesini sağlamak için bir pasaj vereceğim. Sonuçta, argümanları kabul etmek için dekoratörünüzü başka bir işlev kullanarak oluşturduk.

Dekoratörü sardık.

Son zamanlarda sarılmış işlevi gördüğümüz başka bir şey var mı?

Ah evet, dekoratörler!

Biraz eğlenelim ve dekoratörler için bir dekoratör yazalım:

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

Aşağıdaki gibi kullanılabilir:

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

Biliyorum, bu hissi en son ne zaman öğrendiyseniz, “özyinelemeyi anlamadan önce özyinelemeyi anlamalısınız” diyen bir adamı dinledikten sonraydı. Ama şimdi, buna hakim olmak konusunda iyi hissetmiyor musun?

En iyi uygulamalar: dekoratörler

• Dekoratörler Python 2.4'te tanıtıldı, bu nedenle kodunuzun> = 2.4 üzerinde çalışacağından emin olun.
• Dekoratörler işlev çağrısını yavaşlatır. Bunu aklınızda bulundurun.
• Bir fonksiyonun dekorasyonunu kaldıramazsınız. ( Kaldırılabilecek dekoratörler oluşturmak için kesmek vardır , ancak kimse bunları kullanmaz.) Böylece bir işlev bir kez dekore edildiğinde , tüm kod için dekore edilmiştir .
• Dekoratörler, hata ayıklamalarını zorlaştıracak işlevleri sarar. (Bu Python> = 2.5'ten daha iyi olur; aşağıya bakın.)

functoolsModül Python 2.5 kullanılmaya başlandı. functools.wraps()Dekore edilmiş fonksiyonun adını, modülünü ve doktrinini ambalajına kopyalayan fonksiyonu içerir .

(Eğlenceli gerçek: functools.wraps()bir dekoratör! ☺)

# 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

Dekoratörler nasıl faydalı olabilir?

Şimdi büyük soru: Dekoratörleri ne için kullanabilirim?

Havalı ve güçlü görünüyor, ancak pratik bir örnek harika olurdu. 1000 olasılık var. Klasik kullanımlar, bir işlev davranışını harici bir lib'den (değiştiremezsiniz) veya hata ayıklamak için (geçici olduğu için değiştirmek istemezsiniz).

Bunları birkaç işlevi KURU şekilde genişletmek için kullanabilirsiniz, örneğin:

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

Elbette dekoratörler ile iyi olan şey, onları yeniden yazmadan hemen hemen her şeyde hemen kullanabilmenizdir. KURU, dedim ki:

@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 kendisi birkaç dekoratörler sağlamaktadır: property, staticmethodvb

• Django, önbelleğe alma ve görüntüleme izinlerini yönetmek için dekoratörler kullanır.
• Sahte inlining asenkron fonksiyonları çağrıları bükülmüş.

Bu gerçekten büyük bir oyun alanı.

Alternatif olarak, dekore edilmiş işlevin dönüş değerini fabrika işlevine iletilen bir etikete saran bir dekoratörü döndüren bir fabrika işlevi yazabilirsiniz. Örneğin:

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

Bu şunları yazmanıza olanak tanır:

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

veya

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

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

Şahsen ben dekoratörü biraz farklı yazmıştım:

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

hangi sonuç verir:

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

Dekoratör sözdiziminin kısayol olduğu yapıyı unutmayın:

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

Diğer insanlar size sorunu nasıl çözeceğinizi söylemiş gibi görünüyor. Umarım bu, dekoratörlerin ne olduğunu anlamanıza yardımcı olur.

Dekoratörler sadece sözdizimsel şekerdir.

Bu

@decorator
def func():
    ...

genişler

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

Ve elbette lambdaları bir dekoratör işlevinden de geri döndürebilirsiniz:

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

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

print say()

Python dekoratörleri başka bir işleve ekstra işlevsellik ekler

Bir italik dekoratör şöyle olabilir

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

Bir işlevin bir işlevin içinde tanımlandığını unutmayın. Temel olarak yaptığı şey, bir işlevi yeni tanımlanan işlevle değiştirmektir. Örneğin, bu sınıfa sahibim

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

Şimdi her iki fonksiyonun da bittikten sonra ve bitmeden "---" yazmasını istiyorum. Her baskı ifadesinden önce ve sonra bir baskı "---" ekleyebilirim. Ama kendimi tekrar etmeyi sevmediğim için bir dekoratör yapacağım

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

Şimdi sınıfımı şu şekilde değiştirebilirim:

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

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

Dekoratörler hakkında daha fazla bilgi için http://www.ibm.com/developerworks/linux/library/l-cpdecor.html adresini ziyaret edin.

Sen olabilir doğrudan aşağıda gösterildiği gibi ne istersen yap iki ayrı dekoratörler olun. Kullanımına dikkat *args, **kwargsbeyanında wrapped()birden fazla argüman olan dekore işlevini destekler (örneğin için gerçekten gerekli değildir fonksiyonu say()fonksiyonu, ancak genelliği için dahildir).

Benzer nedenlerle, functools.wrapsdekoratör, sarılmış işlevin meta niteliklerini, dekore edilen işlev ile değiştirmek için kullanılır. Bu, hata mesajlarını ve gömülü fonksiyon belgelerini ( func.__doc__) wrapped()'nin yerine dekore edilmiş fonksiyonun belgeleri haline getirir .

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>

Hassaslaştırmalar

Gördüğünüz gibi bu iki dekoratörde çok sayıda yinelenen kod var. Bu benzerlik göz önüne alındığında, aslında bir dekoratör fabrikası olan jenerik bir tane yapmak daha iyi olurdu - başka bir deyişle, diğer dekoratörleri yapan bir dekoratör işlevi. Bu şekilde daha az kod tekrarı olur ve DRY ilkesine uyulmasına izin verilir .

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>

Kodu daha okunabilir hale getirmek için, fabrikada oluşturulan dekoratörlere daha açıklayıcı bir ad atayabilirsiniz:

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>

hatta bunları şu şekilde birleştirebilirsiniz:

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>

verim

Yukarıdaki örneklerin hepsi işe yarasa da, oluşturulan kod, aynı anda birden fazla dekoratör uygulandığında, gereksiz işlev çağrıları biçiminde adil miktarda ek yük içerir. Tam kullanıma bağlı olarak bu önemli olmayabilir (örneğin G / Ç bağlı olabilir).

Dekore edilmiş fonksiyonun hızı önemliyse, genel gider, tek seferde tüm etiketleri eklemeyi uygulayan biraz farklı bir dekoratör fabrika fonksiyonu yazarak tek bir ekstra fonksiyon çağrısına tutulabilir, böylece ek fonksiyon çağrılarını önleyen kod oluşturabilir her etiket için ayrı dekoratörler kullanarak.

Bu, dekoratörün kendisinde daha fazla kod gerektirir, ancak bu yalnızca işlev tanımlarına uygulandığında çalışır, daha sonra kendileri çağrıldığında değil. Bu lambda, daha önce gösterildiği gibi işlevleri kullanarak daha okunabilir adlar oluştururken de geçerlidir . Örneklem:

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>

Aynı şeyi yapmanın başka bir yolu:

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'

Veya daha esnek:

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'

Python'da aşağıdakileri yapacak iki dekoratörü nasıl yapabilirim?

Çağrıldığında aşağıdaki işlevi istiyorsunuz:

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

Geri vermek:

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

Basit çözüm

Bunu en basit şekilde yapmak için, işlevi (kapanışları) kapatan lambdas (anonim işlevler) döndüren dekoratörler yapın ve onu çağırın:

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

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

Şimdi bunları istediğiniz gibi kullanın:

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

ve şimdi:

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

Basit çözümle ilgili sorunlar

Ancak orijinal işlevini neredeyse kaybetmiş gibi görünüyoruz.

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

Bunu bulmak için, biri diğerine gömülü olan her lambda'nın kapanışını kazmamız gerekir:

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

Bu nedenle, bu işleve dokümantasyon koyarsak veya birden fazla argüman alan işlevleri dekore etmek istiyorsak veya sadece bir hata ayıklama oturumunda hangi işleve baktığımızı bilmek istersek, sargı.

Tam özellikli çözüm - bu sorunların çoğunun üstesinden gelmek

Biz dekoratör sahip wrapsgelen functoolsstandart kütüphanede modül!

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

Hala bir kazan plakası olması talihsiz bir durum, ancak bu yapabileceğimiz kadar basit.

Python 3, ayrıca almak __qualname__ve __annotations__varsayılan olarak atanmış.

Peki şimdi:

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

Ve şimdi:

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

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

Sonuç

Bu nedenle wraps, kaydırma işlevinin, işlevin bağımsız değişken olarak tam olarak ne aldığını anlatmak dışında neredeyse her şeyi yapmasını sağladığını görüyoruz .

Sorunu çözmeye çalışabilecek başka modüller de var, ancak çözüm henüz standart kütüphanede değil.

Dekoratörü basit bir şekilde açıklamak için:

İle:

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

Ne zaman:

func(*args, **kwargs)

Gerçekten yapıyorsun:

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

Dekoratör işlev tanımını alır ve bu işlevi yürüten ve sonucu dönüştüren yeni bir işlev oluşturur.

@deco
def do():
    ...

şuna eşittir:

do = deco(do)

Misal:

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

Bu

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

buna eşdeğerdir

def do2(number):
    return chr(number)

do2 = deco(do2)

65 <=> 'a'

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

Dekoratörü anlamak için, dekoratörün, iç işlevi yerine getiren ve sonucu dönüştüren yeni bir işlev yarattığını fark etmek önemlidir.

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

Sınıfta dekoratör de yazabilirsiniz

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

Bu cevap uzun zamandır cevaplandı, ancak yeni dekoratörler yazmayı kolay ve kompakt hale getiren Decorator sınıfımı paylaşacağımı düşündüm.

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)

Birincisi, bunun dekoratörlerin davranışını çok netleştirdiğini düşünüyorum, ama aynı zamanda yeni dekoratörleri çok kısaca tanımlamayı da kolaylaştırıyor. Yukarıda listelenen örnek için, daha sonra şu şekilde çözebilirsiniz:

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"

Ayrıca, işlevi bir yineleyicideki tüm bağımsız değişkenlere otomatik olarak yinelemeli olarak uygulanmasını sağlayan bir dekoratör gibi daha karmaşık görevler yapmak için de kullanabilirsiniz:

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]))

Hangi baskılar:

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

Bu örnekte listdekoratörün somutlaştırılmasında tür bulunmadığına dikkat edin, bu nedenle son yazdırma deyiminde yöntem listenin öğelerine değil, listenin kendisine uygulanır.

İşte dekoratör zincirlemenin basit bir örneği. Son satırı not edin - kapakların altında neler olduğunu gösterir.

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

Çıktı şöyle görünür:

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

Sayaç örneğinden bahsetmek gerekirse - yukarıda verildiği gibi sayaç, dekoratörü kullanan tüm işlevler arasında paylaşılacaktır:

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

Bu şekilde, dekoratörünüz farklı işlevler için yeniden kullanılabilir (veya aynı işlevi birden çok kez dekore etmek için kullanılabilir:) func_counter1 = counter(func); func_counter2 = counter(func)ve sayaç değişkeni her biri için özel kalır.

İşlevleri farklı sayıda bağımsız değişkenle süsleyin:

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

Sonuç:

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  

Paolo Bergantino'nun cevabı sadece stdlib'i kullanmanın büyük avantajına sahiptir ve dekoratör argümanlarının veya dekore edilmiş işlev argümanlarının olmadığı bu basit örnek için çalışır .

Bununla birlikte, daha genel durumlarla başa çıkmak istiyorsanız 3 büyük sınırlama vardır:

• çeşitli yanıtlarda zaten belirtildiği gibi, isteğe bağlı dekoratör bağımsız değişkenleri eklemek için kodu kolayca değiştiremezsiniz . Örneğin bir makestyle(style='bold')dekoratör oluşturmak önemsiz değildir.
• ayrıca, ile oluşturulan sarmalayıcılar @functools.wraps imzayı korumaz , bu nedenle kötü argümanlar sağlanırsa yürütmeye başlarlar ve her zamankinden farklı bir hata oluşturabilirler TypeError.
• Nihayet, bu oluşturulan sarma oldukça zordur @functools.wrapsetmek adına bağlı bir argümanı erişmek . Aslında, argüman içinde *args, içinde **kwargsveya hiç görünmeyebilir (isteğe bağlıysa).

Yazdığım decopatchilk sorunu çözmek için, ve yazdığı makefun.wrapsdiğer ikisini çözmek için. makefunÜnlü decoratorlib ile aynı hileden yararlandığını unutmayın .

Gerçekten imzayı koruyan sarmalayıcılar döndürerek, argümanlarla bir dekoratör oluşturursunuz:

from decopatch import function_decorator, DECORATED
from makefun import wraps

@function_decorator
def makestyle(st='b', fn=DECORATED):
    open_tag = "<%s>" % st
    close_tag = "</%s>" % st

    @wraps(fn)
    def wrapped(*args, **kwargs):
        return open_tag + fn(*args, **kwargs) + close_tag

    return wrapped

decopatch, tercihlerinize bağlı olarak çeşitli python kavramlarını gizleyen veya gösteren iki geliştirme stili daha sağlar. En kompakt stil şudur:

from decopatch import function_decorator, WRAPPED, F_ARGS, F_KWARGS

@function_decorator
def makestyle(st='b', fn=WRAPPED, f_args=F_ARGS, f_kwargs=F_KWARGS):
    open_tag = "<%s>" % st
    close_tag = "</%s>" % st
    return open_tag + fn(*f_args, **f_kwargs) + close_tag

Her iki durumda da dekoratörün beklendiği gibi çalıştığını kontrol edebilirsiniz:

@makestyle
@makestyle('i')
def hello(who):
    return "hello %s" % who

assert hello('world') == '<b><i>hello world</i></b>'    

Bakınız dokümantasyon detayları için.