Bagaimana saya bisa membuat dua dekorator dengan Python yang akan melakukan hal berikut?

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

... yang seharusnya kembali:

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

Saya tidak mencoba membuat HTMLcara ini dalam aplikasi nyata - hanya mencoba memahami cara kerja dekorator dan rantai dekorator.

Lihatlah dokumentasi untuk melihat bagaimana dekorator bekerja. Inilah yang Anda minta:

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

Jika Anda tidak menyukai penjelasan panjang, lihat jawaban Paolo Bergantino .

Dasar-Dasar Dekorator

Fungsi Python adalah objek

Untuk memahami dekorator, Anda harus terlebih dahulu memahami bahwa fungsi adalah objek dengan Python. Ini memiliki konsekuensi penting. Mari kita lihat mengapa dengan contoh sederhana:

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

Ingatlah ini. Kami akan segera kembali ke sana.

Properti lain yang menarik dari fungsi Python adalah mereka dapat didefinisikan di dalam fungsi lain!

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

Referensi fungsi

Oke, masih di sini? Sekarang bagian yang menyenangkan ...

Anda telah melihat bahwa fungsi adalah objek. Oleh karena itu, fungsinya:

• dapat ditugaskan ke suatu variabel
• dapat didefinisikan dalam fungsi lain

Itu artinya suatu fungsi dapat returnfungsi lain .

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

Masih ada lagi!

Jika Anda dapat returnsuatu fungsi, Anda dapat mengirimkannya sebagai parameter:

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

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

Nah, Anda hanya memiliki semua yang diperlukan untuk memahami dekorator. Anda lihat, dekorator adalah "pembungkus", yang berarti bahwa mereka membiarkan Anda mengeksekusi kode sebelum dan sesudah fungsi yang mereka hias tanpa memodifikasi fungsi itu sendiri.

Dekorator buatan tangan

Bagaimana Anda akan melakukannya secara manual:

# 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

Sekarang, Anda mungkin ingin itu setiap kali Anda menelepon a_stand_alone_function, a_stand_alone_function_decorateddipanggil sebagai gantinya. Itu mudah, cukup timpa a_stand_alone_functiondengan fungsi yang dikembalikan oleh 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!

Dekorator didemistifikasi

Contoh sebelumnya, menggunakan sintaksis dekorator:

@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

Ya, itu saja, sesederhana itu. @decoratorhanyalah jalan pintas ke:

another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)

Dekorator hanyalah varian pythonic dari pola desain dekorator . Ada beberapa pola desain klasik yang tertanam di Python untuk memudahkan pengembangan (seperti iterators).

Tentu saja, Anda dapat mengakumulasikan dekorator:

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

Menggunakan sintaks dekorator Python:

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

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

Urutan Anda mengatur dekorator MASALAH:

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

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

Sekarang: untuk menjawab pertanyaan ...

Sebagai kesimpulan, Anda dapat dengan mudah melihat bagaimana menjawab pertanyaan:

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

Anda sekarang dapat meninggalkan bahagia, atau membakar otak Anda sedikit lebih banyak dan melihat penggunaan dekorator canggih.

Membawa dekorator ke tingkat berikutnya

Melewati argumen ke fungsi yang didekorasi

# 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

Metode dekorasi

Satu hal bagus tentang Python adalah metode dan fungsi benar-benar sama. Satu-satunya perbedaan adalah metode berharap bahwa argumen pertama mereka adalah referensi ke objek saat ini ( self).

Itu berarti Anda dapat membangun dekorator untuk metode dengan cara yang sama! Ingatlah untuk selfmempertimbangkan:

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?

Jika Anda membuat dekorator serba guna - yang akan Anda terapkan pada fungsi atau metode apa pun, apa pun argumennya - maka gunakan saja *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?

Melewati argumen ke dekorator

Hebat, sekarang apa yang akan Anda katakan tentang memberikan argumen kepada dekorator itu sendiri?

Ini bisa agak bengkok, karena dekorator harus menerima fungsi sebagai argumen. Oleh karena itu, Anda tidak dapat meneruskan argumen fungsi yang didekorasi langsung ke dekorator.

Sebelum bergegas ke solusinya, mari kita menulis sedikit pengingat:

# 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

Persis sama. " my_decorator" Disebut. Jadi saat Anda @my_decorator, Anda memberi tahu Python untuk memanggil fungsi 'dilabeli oleh variabel " my_decorator"'.

Ini penting! Label yang Anda berikan dapat langsung mengarah ke dekorator— atau tidak .

Mari kita menjadi jahat. ☺

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.

Tidak mengherankan di sini.

Mari kita lakukan PERSIS hal yang sama, tetapi lewati semua variabel perantara sial:

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.

Mari kita buat lebih pendek :

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

Hei, apakah kamu melihat itu? Kami menggunakan panggilan fungsi dengan @sintaks " "! :-)

Jadi, kembalilah ke dekorator dengan argumen. Jika kita dapat menggunakan fungsi untuk menghasilkan dekorator dengan cepat, kita dapat memberikan argumen ke fungsi itu, kan?

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

Ini dia: dekorator dengan argumen. Argumen dapat diatur sebagai variabel:

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

Seperti yang Anda lihat, Anda bisa meneruskan argumen ke dekorator seperti fungsi apa pun menggunakan trik ini. Anda bahkan dapat menggunakan *args, **kwargsjika Anda mau. Tapi ingat dekorator dipanggil hanya sekali . Tepat ketika Python mengimpor skrip. Anda tidak dapat menetapkan argumen secara dinamis setelahnya. Ketika Anda melakukan "impor x", fungsinya sudah didekorasi , jadi Anda tidak dapat mengubah apa pun.

Ayo berlatih: mendekorasi dekorator

Oke, sebagai bonus, saya akan memberi Anda cuplikan untuk membuat dekorator mana pun menerima argumen apa pun secara umum. Lagi pula, untuk menerima argumen, kami membuat dekorator kami menggunakan fungsi lain.

Kami membungkus dekorator.

Adakah yang kita lihat baru-baru ini yang berfungsi?

Oh ya, dekorator!

Mari bersenang-senang dan menulis dekorator untuk dekorator:

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

Dapat digunakan sebagai berikut:

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

Saya tahu, terakhir kali Anda memiliki perasaan ini, itu setelah mendengarkan seorang pria berkata: "sebelum memahami rekursi, Anda harus terlebih dahulu memahami rekursi". Tetapi sekarang, tidakkah Anda merasa senang menguasai hal ini?

Praktik terbaik: dekorator

• Dekorator diperkenalkan dengan Python 2.4, jadi pastikan kode Anda akan dijalankan pada> = 2.4.
• Dekorator memperlambat panggilan fungsi. Ingatlah itu.
• Anda tidak dapat menghapus-menghias suatu fungsi. (Ada yang hacks untuk membuat dekorator yang dapat dihapus, tapi tidak ada yang menggunakan mereka.) Jadi sekali fungsi dihiasi, itu dihiasi untuk semua kode .
• Dekorator membungkus fungsi, yang dapat membuatnya sulit untuk di-debug. (Ini menjadi lebih baik dari Python> = 2.5; lihat di bawah.)

The functoolsModul diperkenalkan pada Python 2.5. Ini termasuk fungsi functools.wraps(), yang menyalin nama, modul, dan mendokumentasikan fungsi yang didekorasi ke pembungkusnya.

(Fakta menyenangkan: functools.wraps()adalah dekorator! ☺)

# 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

Bagaimana dekorator bisa berguna?

Sekarang pertanyaan besarnya: Untuk apa saya bisa menggunakan dekorator?

Tampak keren dan kuat, tetapi contoh praktisnya akan bagus. Ya, ada 1000 kemungkinan. Penggunaan klasik memperluas perilaku fungsi dari lib eksternal (Anda tidak dapat memodifikasinya), atau untuk debugging (Anda tidak ingin memodifikasinya karena bersifat sementara).

Anda dapat menggunakannya untuk memperluas beberapa fungsi dengan cara KERING, seperti:

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

Tentu saja hal baik dengan dekorator adalah Anda dapat menggunakannya langsung pada hampir semua hal tanpa menulis ulang. KERING, saya berkata:

@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 sendiri menyediakan beberapa dekorator: property, staticmethod, dll

• Django menggunakan dekorator untuk mengelola caching dan melihat izin.
• Dipelintir ke panggilan fungsi asinkron palsu palsu.

Ini benar-benar taman bermain besar.

Atau, Anda dapat menulis fungsi pabrik yang mengembalikan dekorator yang membungkus nilai pengembalian fungsi yang didekorasi dalam tag yang diteruskan ke fungsi pabrik. Sebagai contoh:

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

Ini memungkinkan Anda untuk menulis:

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

atau

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

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

Secara pribadi saya akan menulis dekorator agak berbeda:

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

yang akan menghasilkan:

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

Jangan lupa konstruksi yang merupakan sintaksis dekorator:

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

Sepertinya orang lain sudah memberi tahu Anda cara mengatasi masalah. Saya harap ini akan membantu Anda memahami apa itu dekorator.

Dekorator hanyalah gula sintaksis.

Ini

@decorator
def func():
    ...

meluas ke

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

Dan tentu saja Anda dapat mengembalikan lambdas juga dari fungsi dekorator:

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

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

print say()

Dekorator Python menambahkan fungsionalitas tambahan ke fungsi lain

Bisa jadi dekorator cetak miring

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

Perhatikan bahwa suatu fungsi didefinisikan di dalam suatu fungsi. Apa yang pada dasarnya dilakukannya adalah mengganti fungsi dengan yang baru didefinisikan. Sebagai contoh, saya memiliki kelas ini

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

Sekarang katakan, saya ingin kedua fungsi mencetak "---" setelah dan sebelum selesai. Saya bisa menambahkan cetakan "---" sebelum dan sesudah setiap pernyataan cetak. Tetapi karena saya tidak suka mengulang sendiri, saya akan membuat dekorator

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

Jadi sekarang saya bisa mengubah kelas saya menjadi

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

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

Untuk informasi lebih lanjut tentang dekorator, lihat http://www.ibm.com/developerworks/linux/library/l-cpdecor.html

Anda dapat membuat dua dekorator terpisah yang melakukan apa yang Anda inginkan seperti yang diilustrasikan langsung di bawah ini. Perhatikan penggunaan *args, **kwargsdalam deklarasi wrapped()fungsi yang mendukung fungsi yang didekorasi memiliki beberapa argumen (yang tidak benar-benar diperlukan untuk say()fungsi contoh , tetapi disertakan untuk umum).

Untuk alasan yang sama, functools.wrapsdekorator digunakan untuk mengubah atribut meta dari fungsi yang dibungkus menjadi yang didekorasi. Ini membuat pesan kesalahan dan dokumentasi fungsi yang disematkan ( func.__doc__) menjadi pesan dari fungsi yang didekorasi alih-alih wrapped().

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>

Perbaikan

Seperti yang Anda lihat ada banyak kode duplikat di dua dekorator ini. Dengan kesamaan ini, lebih baik bagi Anda untuk membuat yang generik yang sebenarnya merupakan pabrik dekorator — dengan kata lain, fungsi dekorator yang membuat dekorator lain. Dengan begitu akan ada lebih sedikit pengulangan kode - dan memungkinkan prinsip KERING untuk diikuti.

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>

Untuk membuat kode lebih mudah dibaca, Anda dapat menetapkan nama yang lebih deskriptif untuk dekorator yang dibuat oleh pabrik:

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>

atau bahkan menggabungkannya seperti ini:

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>

Efisiensi

Sementara contoh di atas melakukan semua pekerjaan, kode yang dihasilkan melibatkan cukup banyak overhead dalam bentuk panggilan fungsi asing ketika beberapa dekorator diterapkan sekaligus. Ini mungkin tidak masalah, tergantung penggunaan yang tepat (yang mungkin terikat I / O, misalnya).

Jika kecepatan fungsi yang didekorasi penting, overhead dapat disimpan ke satu panggilan fungsi tambahan dengan menulis fungsi pabrik dekorator yang sedikit berbeda yang mengimplementasikan penambahan semua tag sekaligus, sehingga dapat menghasilkan kode yang menghindari panggilan fungsi tambahan yang dikeluarkan dengan menggunakan dekorator terpisah untuk setiap tag.

Ini membutuhkan lebih banyak kode dalam dekorator itu sendiri, tetapi ini hanya berjalan ketika diterapkan pada definisi fungsi, tidak lebih lama ketika mereka sendiri dipanggil. Ini juga berlaku saat membuat nama yang lebih mudah dibaca dengan menggunakan lambdafungsi seperti yang diilustrasikan sebelumnya. Sampel:

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>

Cara lain untuk melakukan hal yang sama:

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'

Atau, lebih fleksibel:

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'

Bagaimana saya bisa membuat dua dekorator dengan Python yang akan melakukan hal berikut?

Anda ingin fungsi berikut, ketika dipanggil:

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

Mengembalikan:

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

Solusi sederhana

Untuk melakukan hal ini, buat dekorator yang mengembalikan lambdas (fungsi anonim) yang menutup fungsi (penutupan) dan menyebutnya:

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

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

Sekarang gunakan sesuai keinginan:

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

dan sekarang:

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

Masalah dengan solusi sederhana

Tapi sepertinya kita hampir kehilangan fungsi aslinya.

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

Untuk menemukannya, kita perlu menggali ke dalam penutupan setiap lambda, yang salah satunya dikubur di yang lain:

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

Jadi jika kita menempatkan dokumentasi pada fungsi ini, atau ingin dapat menghias fungsi yang membutuhkan lebih dari satu argumen, atau kita hanya ingin tahu fungsi apa yang kita lihat dalam sesi debugging, kita perlu melakukan sedikit lebih banyak dengan pembungkus.

Solusi berfitur lengkap - mengatasi sebagian besar masalah ini

Kami memiliki dekorator wrapsdari functoolsmodul di perpustakaan standar!

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

Sangat disayangkan bahwa masih ada beberapa boilerplate, tapi ini sesederhana yang kita bisa.

Di Python 3, Anda juga mendapatkan __qualname__dan __annotations__ditugaskan secara default.

Jadi sekarang:

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

Dan sekarang:

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

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

Kesimpulan

Jadi kita melihat bahwa wrapsmembuat fungsi pembungkus melakukan hampir semua hal kecuali memberi tahu kami apa yang dibutuhkan fungsi sebagai argumen.

Ada modul lain yang mungkin berusaha untuk mengatasi masalah, tetapi solusinya belum ada di perpustakaan standar.

Untuk menjelaskan dekorator dengan cara sederhana:

Dengan:

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

Kapan:

func(*args, **kwargs)

Anda benar-benar melakukannya:

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

Dekorator mengambil definisi fungsi dan membuat fungsi baru yang menjalankan fungsi ini dan mengubah hasilnya.

@deco
def do():
    ...

setara dengan:

do = deco(do)

Contoh:

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

Ini

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

setara dengan ini

def do2(number):
    return chr(number)

do2 = deco(do2)

65 <=> 'a'

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

Untuk memahami dekorator, penting untuk diperhatikan, bahwa dekorator membuat fungsi baru do yang merupakan bagian dalam yang menjalankan fungsi dan mengubah hasilnya.

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

Anda juga dapat menulis dekorator di Kelas

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

Jawaban ini telah lama dijawab, tetapi saya pikir saya akan membagikan kelas Dekorator saya yang membuat menulis dekorator baru menjadi mudah dan ringkas.

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)

Untuk satu saya pikir ini membuat perilaku dekorator sangat jelas, tetapi juga membuatnya mudah untuk mendefinisikan dekorator baru dengan sangat singkat. Untuk contoh yang tercantum di atas, Anda dapat menyelesaikannya sebagai:

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"

Anda juga dapat menggunakannya untuk melakukan tugas yang lebih kompleks, seperti misalnya dekorator yang secara otomatis membuat fungsi diterapkan secara rekursif ke semua argumen di iterator:

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

Yang mencetak:

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

Perhatikan bahwa contoh ini tidak termasuk listjenis di Instantiation dari dekorator, sehingga dalam pernyataan cetak akhir metode akan diterapkan ke daftar itu sendiri, bukan elemen daftar.

Berikut adalah contoh sederhana dari rantai dekorasi. Perhatikan baris terakhir - ini menunjukkan apa yang terjadi di bawah selimut.

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

Outputnya terlihat seperti:

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

Berbicara tentang contoh penghitung - seperti yang diberikan di atas, penghitung akan dibagikan di antara semua fungsi yang menggunakan dekorator:

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

Dengan begitu, dekorator Anda dapat digunakan kembali untuk fungsi yang berbeda (atau digunakan untuk menghias fungsi yang sama beberapa kali :) func_counter1 = counter(func); func_counter2 = counter(func), dan variabel penghitung akan tetap pribadi untuk masing-masing.

Hiasi fungsi dengan jumlah argumen yang berbeda:

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

Hasil:

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  

Jawaban Paolo Bergantino memiliki keuntungan besar hanya dengan menggunakan stdlib, dan berfungsi untuk contoh sederhana ini di mana tidak ada argumen dekorator atau argumen fungsi yang didekorasi .

Namun ia memiliki 3 batasan utama jika Anda ingin menangani kasus yang lebih umum:

• seperti yang telah disebutkan dalam beberapa jawaban, Anda tidak dapat dengan mudah memodifikasi kode untuk menambahkan argumen dekorator opsional . Misalnya membuat makestyle(style='bold')dekorator adalah hal yang tidak sepele.
• selain itu, pembungkus yang dibuat dengan @functools.wraps tidak mempertahankan tanda tangan , jadi jika argumen buruk diberikan mereka akan mulai mengeksekusi, dan mungkin menimbulkan jenis kesalahan yang berbeda dari biasanya TypeError.
• akhirnya, cukup sulit di pembungkus yang dibuat @functools.wrapsuntuk mengakses argumen berdasarkan namanya . Memang argumen tersebut dapat muncul di *args, di **kwargs, atau mungkin tidak muncul sama sekali (jika itu opsional).

Saya menulis decopatchuntuk memecahkan masalah pertama, dan menulis makefun.wrapsuntuk memecahkan dua lainnya. Perhatikan bahwa makefunmemanfaatkan trik yang sama dari decoratorlib terkenal .

Ini adalah bagaimana Anda akan membuat dekorator dengan argumen, mengembalikan pembungkus yang benar-benar melindungi tanda tangan:

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

decopatchmemberi Anda dua gaya pengembangan lain yang menyembunyikan atau menampilkan berbagai konsep python, tergantung pada preferensi Anda. Gaya paling ringkas adalah sebagai berikut:

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

Dalam kedua kasus Anda dapat memeriksa bahwa dekorator berfungsi seperti yang diharapkan:

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

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

Lihat dokumentasi untuk detailnya.