Soru Bir işlev dekoratörü zinciri nasıl yapılır?


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

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

... geri dönmesi gerekenler:

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

Yapmaya çalışmıyorum HTML gerçek bir uygulamada bu şekilde - sadece dekoratörler ve dekoratör zincirleme nasıl çalıştığını anlamaya çalışıyorum.


2382
2018-04-11 07:05


Menşei




Cevaplar:


Çıkış yapmak Dökümantasyon dekoratörlerin nasıl çalıştığını görmek için. İstediğin şey buydu:

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

2658
2018-04-11 07:16



Kullanmayı düşünün functools.wraps ya da daha iyisi, PyPI'den dekoratör modülü: Bazı önemli meta verileri korurlar __name__ ve dekoratör paketinden bahsetmek, fonksiyon imzası). - Marius Gedminas
*argsve **kwargs cevaba eklenmelidir. Dekorasyon işlevi argümanlara sahip olabilir ve belirtilmemişse kaybolurlar. - Blusky


Uzun açıklamalara girmiyorsanız, bkz. Paolo Bergantino’nun cevabı.

Dekoratör Temelleri

Python’un işlevleri

Dekoratörleri anlamak için, ilk önce işlevlerin Python'daki nesneler olduğunu anlamanız gerekir. Bunun önemli sonuçları var. Neden basit bir örnekle 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, e:
    print(e)
    #outputs: "name 'shout' is not defined"

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

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

Python işlevlerinin bir başka ilginç özelliği, başka bir işlev 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, e:
    print(e)
    #outputs : "name 'whisper' is not defined"*
    #Python's functions are objects

Fonksiyon referansları

Tamam, hala burada mı? Şimdi eğlenceli bölüm ...

Bu işlevlerin nesneler olduğunu gördünüz. Bu nedenle, fonksiyonlar:

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

Bu şu demek oluyor bir işlev return başka bir işlev.

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!

Yapabilirsen return Bir fonksiyon, bir parametre olarak geçebilirsiniz:

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!

Eh, sadece dekoratörler anlamak için gereken her şey var. Görüyorsun, dekoratörler “sarmalayıcılar”, yani kodladıkları işlevden önce ve sonra kod yürütmenize izin veriyorlar fonksiyonun kendisini değiştirmeden.

El işi dekoratörler

Manuel olarak nasıl yaptı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 her aradığınızı a_stand_alone_function, a_stand_alone_function_decorated yerine çağrılır. Bu kolay, sadece üzerine yaz a_stand_alone_function tarafından döndürülen işlevle 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

Önceki örnek, dekoratör sözdizimini kullanarak:

@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 kadar basit. @decorator sadece bir kısayol:

another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)

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

Tabii ki, dekoratörler 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 kullanma:

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

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

Dekoratörleri ayarladığınız sipariş:

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

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

Şimdi: soruya cevap vermek için ...

Sonuç olarak, soruyu nasıl yanıtlayacağı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 mutlu olabilirsiniz ya da beyninizi biraz daha yakabilir ve dekoratörlerin gelişmiş kullanımlarını görebilirsiniz.


Bir sonraki seviyeye dekoratörler çekmek

Argümanları dekore edilmiş işleve geçirme

# 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 hakkında güzel bir şey, yöntemlerin ve fonksiyonların gerçekten aynı olmasıdır. Tek fark, yöntemlerin ilk argümanının mevcut nesneye bir referans olduğunu beklemektir.self).

Yani aynı şekilde yöntemler için bir dekoratör oluşturabilirsiniz! Sadece almayı unutma self dikkate almak:

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ı bir dekoratörüyorsanız - herhangi bir işlev veya yöntem için geçerli olur, argümanları ne olursa olsun - sadece *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?

Bağımsız değişkenleri dekoratöre geçirme

Harika, şimdi argümanları dekoratörün kendisine aktarma hakkında ne söylerdin?

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

Çözüm için acele etmeden önce biraz 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

Tam olarak aynı. "my_decorator"denir. @my_decorator, Python'a 'değişken tarafından etiketlenmiş' işlevini çağırmasını söylüyorsunuzmy_decorator"'.

Bu önemli! Verdiğiniz etiket doğrudan dekoratöre işaret edebilir -ya da değil.

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.

Aynı şeyi EXACTLY 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.

Hadi yapalım daha kısa:

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

Yani, argümanlarla dekoratörlere dönelim. Eğer dekoratörü anında üretmek için fonksiyonlar kullanabilirsek, argümanları bu işleve 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: 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

İşte: argümanlar ile 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 hileyi kullanarak argümanları herhangi bir işlev gibi dekoratöre aktarabilirsiniz. Hatta kullanabilirsiniz *args, **kwargs Eğer istersen. Ama dekoratörlerin çağrıldığını hatırla sadece bir kere. Sadece Python betiği içe aktardığında. Sonra argümanları dinamik olarak ayarlayamazsınız. "İçe aktarma" işlemini yaptığınızda, işlev zaten dekore edilmişyani yapamazsın herhangi bir şeyi değiştir.


Pratik yapalım: bir dekoratör dekorasyon

Tamam, bir bonus olarak, herhangi bir dekoratörün herhangi bir bağımsız değişkeni kabul etmesi için size bir pasaj vereceğim. Sonuçta, argümanları kabul etmek için, başka bir işlev kullanarak dekoratörü yarattık.

Dekoratörü sardık.

Son zamanlarda bu sarılmış işlevi gördük başka bir şey?

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 hissettiğinizde, bir adamı dinledikten sonra: "özyineyi anlamadan önce, özyineyi anlamanız gerekir". Ama şimdi, bunu anlamak konusunda kendini iyi hissetmiyor musun?


En iyi uygulamalar: dekoratörler

  • Dekoratörler Python 2.4'te tanıtıldı, bu yüzden kodunuzun> = 2.4'te çalıştırılacağından emin olun.
  • Dekoratörler fonksiyon çağrısını yavaşlatır. Bunu aklında tut.
  • Bir işlevi süsleyemezsiniz. (Orada Hangi kaldırılabilen dekoratörler yaratmaya çalışıyor, ama kimse onları kullanmıyor.) Böylece bir işlev dekore edildikten sonra dekore edilmiş. tüm kodlar için.
  • Dekoratörler, hata ayıklamalarını zorlaştıracak işlevleri sarar. (Bu Python'dan daha iyi olur> = 2.5; aşağıya bakın.)

functools modül Python 2.5'te tanıtıldı. Bu işlevi içerir functools.wraps()Bu, süslü işlevin adını, modülünü ve belgesini sarmalayıcıya kopyalar.

(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 yararlı olabilir?

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

Güzel ve güçlü görünüyorsun, ama pratik bir örnek harika olurdu. Eh, 1000 olasılık var. Klasik kullanımlar, bir dış libreden bir işlev davranışını genişletir (bunu değiştiremezsiniz) veya hata ayıklama için (geçici olduğu için değiştirmek istemezsiniz).

DRY’nin çeşitli işlevlerini genişletmek için bunları kullanabilirsiniz:

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

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

@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'un kendisi birkaç dekoratörler sunar: property, staticmethod, vb.

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

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


3811
2018-04-11 08:00



"Bir işlevi süsleyemezsiniz." - Normalde doğru olsa bile, bir dekoratör tarafından işlev dönüşünde kapağın içine ulaşmak mümkündür (yani __closure__ Özniteliksiz orijinal işlevi kaldırmak için Bir örnek kullanımda belgelenmiştir bu cevap Sınırlı durumlarda daha düşük bir seviyede bir dekoratör fonksiyonunun nasıl enjekte edilebileceğini kapsar. - metatoaster
Bu harika bir cevap olsa da, bazı yönlerden biraz yanıltıcı olduğunu düşünüyorum. Python en @decorator sözdizimi büyük olasılıkla en sık bir işlevi bir örtücünün kapatılmasıyla (yanıtın açıkladığı gibi) değiştirmek için kullanılır. Ancak işlevi başka bir şeyle de değiştirebilir. Yerleşik property, classmethod ve staticmethod dekoratörler işlevi örneğin bir tanımlayıcı ile değiştirir. Bir dekoratör ayrıca, bir işleve bir sıralamada bir referans kaydetme, sonra herhangi bir sarıcı olmadan değiştirilemez, bir işlevle bir şey yapabilir. - Blckknght
Python'da tamamen doğru iken "işlevler nesneler" olgusu, biraz yanıltıcıdır. Fonksiyonları değişkenler halinde saklamak, bunları argüman olarak iletmek ve sonuç olarak döndürmek, aslında nesneler olmaksızın fonksiyonlar olmaksızın mümkündür ve birinci sınıf işlevlere sahip ancak nesneler olmayan çeşitli diller vardır. - 00dani
Kolayca web üzerinde dekoratörler hakkında en iyi açıklama, çok iyi açıklanmış örneklerle size yolun her adımında yürümektedir. Detaylara gösterilen ilgiden dolayı gerçekten minnettarım. - Abhi Tk
Çok yardımcı, derinlemesine açıklama. Örnekler çok yardımcı oluyor! - Charles


Alternatif olarak, fabrika işlevine iletilen bir etikette dekore edilmiş işlevin dönüş değerini 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 yazmanızı sağlar:

@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 dekoratörü biraz farklı yazabilirdim:

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 verim:

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

132
2017-10-25 06:18



Benim düşünceme göre, mümkün olduğunca birden fazla dekoratörden kaçınmak daha iyidir. Eğer bir fabrika fonksiyonu yazmak zorunda kalsaydım, * kwargs gibi kodlardı def wrap_in_tag(*kwargs) sonra @wrap_in_tag('b','i') - guneysus


Diğer insanların size sorunu nasıl çözeceklerini anlatmış 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)

101
2018-04-11 07:19



Bu çok zarif, basit, anlaşılması kolay. 10000 zamandır, Sir Ockham. - neuronet
Büyük ve basit bir cevap. Bunu kullanırken eklemek ister @decorator() (yerine @decorator) sözdizimsel şekerdir func = decorator()(func). Bu aynı zamanda "anında" dekoratörler oluşturmanız gerektiğinde de yaygın bir uygulamadır. - Omer Dagan


Ve tabii ki bir dekoratör fonksiyonundan da lambdaları geri alabilirsiniz:

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



Ve bir adım daha: makebold = lambda f : lambda "<b>" + f() + "</b>" - Robᵩ
@ Robᵩ: Sözdizimsel olarak doğru olması için: makebold = lambda f: lambda: "<b>" + f() + "</b>" - martineau
Partiye geç kaldım ama gerçekten öneririm makebold = lambda f: lambda *a, **k: "<b>" + f(*a, **k) + "</b>" - seequ


Python dekoratörler başka bir işleve ekstra işlevsellik katıyor

Bir italik dekoratör gibi olabilir

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

Bir fonksiyonun bir fonksiyon içerisinde tanımlandığını unutmayın. Temel olarak yaptığı şey, yeni tanımlanmış olanla bir işlevin yerini almaktır. Örneğin, bu sınıfa sahibim

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

Şimdi, her iki işlevin de bittikten sonra ve sonra "---" yazmasını istiyorum. Her baskı ifadesinden önce ve sonra "---" bir baskı ekleyebilirim. Ama kendimi tekrarlamayı 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ı 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


56
2017-12-26 06:13



@Rune Kaagaard tarafından önerilen lambda işlevleri kadar zarif not - rds
Burada kendilik anahtar kelimesinin işi nedir? - asit_dhal
@ Phoenix: The self argüman gereklidir çünkü newFunction() içinde tanımlanmış addDashes() özellikle bir olmak için tasarlandı yöntem dekoratör genel bir işlev dekoratör değil. self argüman sınıf örneğini temsil eder ve kullanıp kullanmadıklarını sınıf yöntemlerine geçirir - başlıklı bölüme bakın Dekorasyon yöntemleri@ e-satis'ın cevabı. - martineau
Çıktısı da lütfen yazdırın. - user1767754


Sen could Doğrudan aşağıda gösterildiği gibi istediğiniz şeyi yapan iki ayrı dekoratör yapın. Kullanımı not *args, **kwargs beyanında wrapped() Birden fazla argümanı olan dekore edilmiş fonksiyonu destekleyen fonksiyon (bu örnek için gerçekten gerekli değildir) say() işlev, ancak genellik için dahil edilir.

Benzer sebeplerden dolayı functools.wraps dekoratör, sarılmış fonksiyonun meta niteliklerini, dekore edilmiş olanın niteliklerini değiştirmek için kullanılır. Bu hata mesajları ve gömülü işlev belgelerini yapar (func.__doc__) dekore edilmiş işlevin yerine wrapped()Var.

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 fazla kod var. Bu benzerlik göz önüne alındığında, bunun yerine aslında bir genel olanı yapmak daha iyi olurdu. dekoratör fabrikası- başka bir deyişle, diğer dekoratörler yapan bir dekoratör. Böylece daha az kod tekrarı olur ve KURU izlenecek ilke.

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 fabrika tarafından üretilen 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ı şöyle birleştirin:

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 yararken, oluşturulan kod, bir defada birden fazla dekoratör uygulandığında, fazladan işlev çağrıları biçiminde adil bir ek yükü içerir. Bu, tam kullanıma bağlı olarak önemli olmayabilir (örneğin G / Ç bağlı olabilir).

Dekore edilmiş fonksiyonun hızı önemliyse, ek yük, tek seferde tüm etiketlerin eklenmesini sağlayan biraz farklı bir dekoratör fabrika fonksiyonu yazarak, ekstra bir fonksiyon çağrısı için tutulabilir, böylece yapılan ek fonksiyon çağrılarını engelleyen kod üretebilir Her etiket için ayrı dekoratörler kullanarak.

Bu, dekoratörde daha fazla kod gerektirir, ancak bu, yalnızca kendileri çağrıldıklerinde değil, yalnızca işlev tanımlarına işlenirken çalıştırılır. Bu, aynı zamanda daha okunabilir isimler oluştururken de geçerlidir. lambda Daha önce resmedildiği gibi çalışır. Numune:

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





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 bir şekilde:

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





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

Arandığında aşağıdaki işlevi istiyorsunuz:

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

Geri vermek:

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

Basit bir çözüm

Bunu en basit şekilde yapmak için, fonksiyonu kapatacak lambdaları (anonim işlevler) döndüren dekoratörler yapın (bunu):

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 problemler

Ama neredeyse orijinal işlevi kaybetmiş gibi görünüyor.

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

Onu bulmak için, biri diğerine gömülmüş olan her lambda'nın kapanmasına girmeliyiz:

>>> 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 belgeleri koyarsak veya birden fazla argüman alan işlevleri dekore etmek istersek veya sadece bir hata ayıklama oturumunda hangi işleve baktığımızı bilmek istediğimizde, biraz daha fazla sargı.

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

Dekoratörümüz var wraps itibaren functools standart 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ı olduğu için talihsizlik var, ama bu yapabileceğimiz kadar basit.

Python 3'te, ayrıca __qualname__ ve __annotations__ varsayılan olarak atanmıştır.

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ç

Bunu görüyoruz wraps Sarma işlevinin hemen hemen her şeyi yapması dışında, işlevin argüman olarak ne yaptığını tam olarak söyleyin.

Sorunu çözmeyi deneyebilecek başka modüller vardır, ancak çözüm henüz standart kütüphanede bulunmamaktadır.


15
2018-03-20 09:48





Bir 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():
    ...

eqivarent için:

do = deco(do)

Örnek:

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ğer     def do2 (sayı):         dönüş chr (sayı)

do2 = deco(do2)

65 <=> 'a'

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

Dekoratör anlamak için, bu dekoratör, func yürüten ve sonucu dönüştüren iç olan yeni bir fonksiyon yarattı dikkat etmek önemlidir.


10
2018-04-03 09:43



Çıkmaması gerekir print(do(65)) ve print(do2(65)) olmak A ve A ? - Treefish Zhang