Làm thế nào để thực hiện một chuỗi các chức năng trang trí?


2755

Làm thế nào tôi có thể tạo hai trình trang trí trong Python sẽ làm như sau?

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

... sẽ trở lại:

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

Tôi không cố gắng thực hiện HTMLtheo cách này trong một ứng dụng thực tế - chỉ cố gắng hiểu cách trang trí và chuỗi trang trí hoạt động.

Câu trả lời:


2926

Kiểm tra các tài liệu để xem làm thế nào trang trí làm việc. Đây là những gì bạn yêu cầu:

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

261
Xem xét sử dụng funcools.wraps hoặc tốt hơn là mô-đun trang trí từ PyPI : chúng bảo tồn một số siêu dữ liệu quan trọng nhất định (chẳng hạn như __name__, và nói về gói trang trí, chữ ký hàm).
Marius Gedminas

31
*args**kwargsnên được thêm vào trong câu trả lời. Hàm trang trí có thể có các đối số và chúng sẽ bị mất nếu không được chỉ định.
Blusky

3
Mặc dù câu trả lời này có lợi thế lớn của chỉ sử dụng stdlib, và làm việc cho ví dụ đơn giản này, nơi không có trang trí tranh luận hay chức năng trang trí tranh cãi, nó có 3 hạn chế lớn: (1) không hỗ trợ đơn giản cho các đối số trang trí tùy chọn (2) không bảo tồn chữ ký (3) không có cách đơn giản nào để trích xuất một đối số được đặt tên từ *args, **kwargs. Một cách dễ dàng để giải quyết 3 vấn đề này cùng một lúc là sử dụng decopatchnhư được giải thích ở đây . Bạn cũng có thể sử dụng decoratornhư đã được đề cập bởi Marius Gedminas, để giải quyết các điểm 2 và 3.
smarie

4209

Nếu bạn không giải thích dài dòng, hãy xem câu trả lời của Paolo Bergantino .

Khái niệm cơ bản về trang trí

Các hàm của Python là các đối tượng

Để hiểu các trình trang trí, trước tiên bạn phải hiểu rằng các hàm là các đối tượng trong Python. Điều này có hậu quả quan trọng. Hãy xem tại sao với một ví dụ đơn giản:

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

Giữ điều này trong tâm trí. Chúng tôi sẽ quay lại với nó trong thời gian ngắn.

Một thuộc tính thú vị khác của các hàm Python là chúng có thể được định nghĩa bên trong một hàm khác!

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

Chức năng tham khảo

Được rồi, vẫn ở đây? Bây giờ là phần thú vị ...

Bạn đã thấy rằng các chức năng là các đối tượng. Do đó, chức năng:

  • có thể được gán cho một biến
  • có thể được định nghĩa trong chức năng khác

Điều đó có nghĩa là một chức năng có thể returnchức năng khác .

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

Còn nữa!

Nếu bạn có thể returnmột hàm, bạn có thể truyền một hàm làm tham số:

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!

Vâng, bạn chỉ cần có mọi thứ cần thiết để hiểu trang trí. Bạn thấy đấy, những người trang trí là những người đóng gói trên máy tính, có nghĩa là họ cho phép bạn thực thi mã trước và sau chức năng họ trang trí mà không sửa đổi chính chức năng đó.

Trang trí thủ công

Cách bạn thực hiện thủ công:

# 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

Bây giờ, bạn có thể muốn rằng mỗi khi bạn gọi a_stand_alone_function, a_stand_alone_function_decoratedđược gọi thay thế. Điều đó thật dễ dàng, chỉ cần ghi đè lên a_stand_alone_functionvới chức năng được trả về bởi 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!

Trang trí làm sáng tỏ

Ví dụ trước, sử dụng cú pháp trang trí:

@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

Vâng, đó là tất cả, nó đơn giản. @decoratorchỉ là một phím tắt để:

another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)

Trang trí chỉ là một biến thể pythonic của mẫu thiết kế trang trí . Có một số mẫu thiết kế cổ điển được nhúng trong Python để dễ dàng phát triển (như các trình vòng lặp).

Tất nhiên, bạn có thể tích lũy trang trí:

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

Sử dụng cú pháp trang trí Python:

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

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

Thứ tự bạn thiết lập các trang trí MATTERS:

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

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

Bây giờ: để trả lời câu hỏi ...

Để kết luận, bạn có thể dễ dàng thấy cách trả lời câu hỏi:

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

Bây giờ bạn có thể để lại hạnh phúc, hoặc đốt cháy não của bạn thêm một chút nữa và xem các ứng dụng trang trí tiên tiến.


Đưa trang trí lên cấp độ tiếp theo

Truyền đối số cho hàm trang trí

# 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

Phương pháp trang trí

Một điều tiện lợi về Python là các phương thức và hàm thực sự giống nhau. Sự khác biệt duy nhất là các phương thức mong đợi rằng đối số đầu tiên của chúng là một tham chiếu đến đối tượng hiện tại ( self).

Điều đó có nghĩa là bạn có thể xây dựng một trình trang trí cho các phương thức theo cùng một cách! Chỉ cần nhớ để selfxem xét:

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?

Nếu bạn đang tạo trang trí cho mục đích chung - một người bạn sẽ áp dụng cho bất kỳ chức năng hoặc phương thức nào, bất kể đối số của nó - thì chỉ cần sử dụng *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?

Truyền lý lẽ cho người trang trí

Tuyệt vời, bây giờ bạn sẽ nói gì về việc truyền các đối số cho chính người trang trí?

Điều này có thể bị xoắn đôi chút, vì một người trang trí phải chấp nhận một chức năng như là một đối số. Do đó, bạn không thể truyền trực tiếp các đối số của hàm trang trí cho trình trang trí.

Trước khi vội vã tìm giải pháp, hãy viết một lời nhắc nhở nhỏ:

# 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

Nó giống hệt nhau. " my_decorator" được gọi. Vì vậy, khi bạn @my_decorator, bạn đang bảo Python gọi hàm 'được gắn nhãn bởi biến " my_decorator"'.

Điều này quan trọng! Nhãn bạn cung cấp có thể trỏ trực tiếp đến trang trí hay không .

Hãy trở nên xấu xa. ☺

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.

Không có gì bất ngờ ở đây.

Chúng ta hãy thực hiện chính xác điều tương tự, nhưng bỏ qua tất cả các biến trung gian phiền phức:

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.

Hãy làm cho nó thậm chí ngắn hơn :

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

Này, bạn có thấy điều đó không? Chúng tôi đã sử dụng một lệnh gọi hàm với @cú pháp ""! :-)

Vì vậy, trở lại trang trí với các đối số. Nếu chúng ta có thể sử dụng các hàm để tạo trình trang trí một cách nhanh chóng, chúng ta có thể truyền các đối số cho hàm đó, phải không?

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

Đây là: một trang trí với các đối số. Các đối số có thể được đặt thành biến:

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

Như bạn có thể thấy, bạn có thể chuyển các đối số cho trình trang trí giống như bất kỳ hàm nào bằng thủ thuật này. Bạn thậm chí có thể sử dụng *args, **kwargsnếu bạn muốn. Nhưng hãy nhớ trang trí chỉ được gọi một lần . Chỉ khi Python nhập tập lệnh. Bạn không thể tự động thiết lập các đối số sau đó. Khi bạn thực hiện "nhập x", chức năng đã được trang trí , do đó bạn không thể thay đổi bất cứ điều gì.


Hãy thực hành: trang trí một trang trí

Được rồi, như một phần thưởng, tôi sẽ cung cấp cho bạn một đoạn để làm cho bất kỳ nhà trang trí nào chấp nhận chung chung bất kỳ đối số. Rốt cuộc, để chấp nhận các đối số, chúng tôi đã tạo ra trang trí của chúng tôi bằng cách sử dụng một chức năng khác.

Chúng tôi gói trang trí.

Bất cứ điều gì khác chúng ta thấy gần đây có chức năng bao bọc?

Ồ vâng, trang trí!

Hãy cùng vui vẻ và viết một trang trí cho các nhà trang trí:

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

Nó có thể được sử dụng như sau:

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

Tôi biết, lần cuối cùng bạn có cảm giác này, đó là sau khi nghe một anh chàng nói: "trước khi hiểu đệ quy, trước tiên bạn phải hiểu đệ quy". Nhưng bây giờ, bạn không cảm thấy tốt về việc làm chủ điều này?


Thực hành tốt nhất: trang trí

  • Trình trang trí đã được giới thiệu trong Python 2.4, vì vậy hãy chắc chắn mã của bạn sẽ được chạy trên> = 2.4.
  • Trang trí làm chậm chức năng gọi. Ghi nhớ nó trong tâm trí.
  • Bạn không thể bỏ trang trí một chức năng. (Có các hack để tạo các trang trí có thể được gỡ bỏ, nhưng không ai sử dụng chúng.) Vì vậy, một khi một chức năng được trang trí, nó được trang trí cho tất cả các mã .
  • Chức năng trang trí bọc, có thể làm cho chúng khó gỡ lỗi. (Điều này trở nên tốt hơn từ Python> = 2.5; xem bên dưới.)

Các functoolsmô-đun được giới thiệu vào Python 2.5. Nó bao gồm chức năng functools.wraps(), sao chép tên, mô-đun và chuỗi doc của chức năng được trang trí vào trình bao bọc của nó.

(Sự thật thú vị: functools.wraps()là một người trang trí! ☺)

# 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

Làm thế nào các trang trí có thể hữu ích?

Bây giờ câu hỏi lớn: Tôi có thể sử dụng trang trí để làm gì?

Có vẻ mát mẻ và mạnh mẽ, nhưng một ví dụ thực tế sẽ là tuyệt vời. Vâng, có 1000 khả năng. Việc sử dụng cổ điển đang mở rộng một hành vi chức năng từ một lib bên ngoài (bạn không thể sửa đổi nó) hoặc để gỡ lỗi (bạn không muốn sửa đổi nó vì nó tạm thời).

Bạn có thể sử dụng chúng để mở rộng một số chức năng theo cách của DRY, như vậy:

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

Tất nhiên điều tốt với các nhà trang trí là bạn có thể sử dụng chúng ngay lập tức trên hầu hết mọi thứ mà không cần viết lại. DRY, tôi nói:

@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 chính nó cung cấp một số trang trí: property, staticmethodvv

  • Django sử dụng trang trí để quản lý bộ nhớ đệm và xem quyền.
  • Xoắn để giả mạo nội tuyến gọi hàm chức năng không đồng bộ.

Đây thực sự là một sân chơi lớn.


15
"Bạn không thể bỏ trang trí một chức năng." - Mặc dù bình thường là đúng, có thể tiếp cận bên trong bao đóng trong hàm trả về bởi một trình trang trí (tức là thông qua __closure__thuộc tính của nó ) để kéo ra hàm không được trang trí ban đầu. Một ví dụ sử dụng được ghi lại trong câu trả lời này bao gồm cách có thể đưa chức năng trang trí ở mức thấp hơn trong các trường hợp hạn chế.
metatoaster

8
Trong khi đây là một câu trả lời tuyệt vời, tôi nghĩ rằng nó có một chút sai lệch trong một số cách. @decoratorCú pháp của Python có lẽ thường được sử dụng để thay thế một hàm bằng bao đóng (như câu trả lời mô tả). Nhưng nó cũng có thể thay thế chức năng bằng một cái gì đó khác. Các BUILTIN property, classmethodstaticmethodtrang trí thay thế các chức năng với một mô tả, ví dụ. Một trình trang trí cũng có thể làm một cái gì đó với một chức năng, chẳng hạn như lưu một tham chiếu đến nó trong một sổ đăng ký nào đó, sau đó trả lại nó, không sửa đổi, mà không có bất kỳ trình bao bọc nào.
Blckknght

3
Thực tế là "các hàm là các đối tượng", trong khi hoàn toàn đúng trong Python, có một chút sai lệch. Lưu trữ các hàm trong các biến, chuyển chúng dưới dạng đối số và trả về chúng dưới dạng kết quả là hoàn toàn có thể mà không có chức năng thực sự là đối tượng và có nhiều ngôn ngữ khác nhau có chức năng hạng nhất nhưng không có đối tượng.
00dani

1
Đây là một câu trả lời tuyệt vời ngay tại đó ... Cảm ơn rất nhiều! Tuy nhiên, tại sao các đối số mặc định cho một hàm không hiển thị dưới dạng đối số / kwargs trong trình bao bọc của trình trang trí?
Naz

Di chuyển tất cả các cách trở lại đầu câu trả lời này để upvote bởi vì "Làm thế nào các trang trí có thể hữu ích?" phần rất hữu ích.
Noumenon

145

Ngoài ra, bạn có thể viết một hàm xuất xưởng trả về một trình trang trí bao bọc giá trị trả về của hàm được trang trí trong một thẻ được truyền cho hàm xuất xưởng. Ví dụ:

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

Điều này cho phép bạn viết:

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

hoặc là

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

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

Cá nhân tôi sẽ viết trang trí hơi khác:

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

sẽ mang lại:

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

Đừng quên việc xây dựng mà cú pháp trang trí là một tốc ký:

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

5
Theo tôi, tốt hơn là nên tránh nhiều hơn một người trang trí càng xa càng tốt. Nếu tôi phải viết một chức năng của nhà máy, tôi sẽ mã hóa nó bằng * kwargs như def wrap_in_tag(*kwargs)sau đó@wrap_in_tag('b','i')
guneysus

120

Có vẻ như những người khác đã nói với bạn cách giải quyết vấn đề. Tôi hy vọng điều này sẽ giúp bạn hiểu trang trí là gì.

Trang trí chỉ là đường cú pháp.

Điều này

@decorator
def func():
    ...

mở rộng đến

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

3
Điều này thật thanh lịch, đơn giản, dễ hiểu. 10000 upvote cho bạn, thưa ngài Ockham.
eric

2
Câu trả lời tuyệt vời và đơn giản. Muốn thêm rằng khi sử dụng @decorator()(thay vì @decorator) nó là cú pháp đường cho func = decorator()(func). Đây cũng là cách phổ biến khi bạn cần tạo trang trí "nhanh chóng"
Omer Dagan

64

Và tất nhiên bạn cũng có thể trả lại lambdas từ chức năng trang trí:

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

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

print say()

12
Và một bước nữa:makebold = lambda f : lambda "<b>" + f() + "</b>"
Rob

13
@ Robᵩ: Được chính xác về mặt cú pháp:makebold = lambda f: lambda: "<b>" + f() + "</b>"
martineau 20/12/13

11
Đến bữa tiệc muộn, nhưng tôi thực sự muốn đề xuấtmakebold = lambda f: lambda *a, **k: "<b>" + f(*a, **k) + "</b>"
hãy xem

Điều này cần functools.wrapsđể không loại bỏ chuỗi / chữ ký / tên củasay
Eric

Vâng, điều quan trọng là liệu nó được đề cập trong câu trả lời của bạn. Có @wrapsmột nơi nào khác trên trang này sẽ không giúp tôi khi tôi in help(say)và nhận "Trợ giúp về chức năng <lambda>` thay vì "Trợ giúp về chức năng nói" .
Eric

61

Trình trang trí Python thêm chức năng bổ sung cho chức năng khác

Một trang trí in nghiêng có thể giống như

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

Lưu ý rằng một chức năng được xác định bên trong một chức năng. Những gì nó về cơ bản là thay thế một chức năng với một chức năng mới được xác định. Ví dụ, tôi có lớp học này

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

Bây giờ hãy nói, tôi muốn cả hai chức năng in "---" sau và trước khi chúng được thực hiện. Tôi có thể thêm một bản in "---" trước và sau mỗi câu lệnh in. Nhưng vì tôi không thích lặp lại chính mình, tôi sẽ làm một người trang trí

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

Vì vậy, bây giờ tôi có thể thay đổi lớp học của tôi thành

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

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

Để biết thêm về trang trí, hãy kiểm tra http://www.ibm.com/developerworks/linux/l Library / l-cpdecor.html


Lưu ý là thanh lịch như các chức năng lambda được đề xuất bởi @Rune Kaagaard
rds

1
@Phoenix: Đối selfsố là cần thiết bởi vì newFunction()định nghĩa trong addDashes()được thiết kế riêng để trở thành một trình trang trí phương thức chứ không phải là một trình trang trí hàm chung. Đối selfsố đại diện cho thể hiện của lớp và được truyền cho các phương thức lớp dù chúng có sử dụng hay không - xem phần có tiêu đề Phương thức trang trí trong câu trả lời của @ e-satis.
martineau

1
In đầu ra là tốt xin vui lòng.
dùng1767754

Mất tíchfunctools.wraps
Eric

39

Bạn có thể tạo hai trang trí riêng biệt làm những gì bạn muốn như minh họa ngay bên dưới. Lưu ý việc sử dụng *args, **kwargstrong khai báo wrapped()hàm hỗ trợ hàm được trang trí có nhiều đối số (không thực sự cần thiết cho say()hàm ví dụ , nhưng được bao gồm cho tính tổng quát).

Vì những lý do tương tự, trình functools.wrapstrang trí được sử dụng để thay đổi các thuộc tính meta của hàm được gói thành các thuộc tính được trang trí. Điều này làm cho các thông báo lỗi và tài liệu hàm nhúng ( func.__doc__) là các thông báo của hàm được trang trí thay vì của 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>

Sàng lọc

Như bạn có thể thấy có rất nhiều mã trùng lặp trong hai trang trí này. Thay vào đó là sự tương đồng, tốt hơn là bạn nên tạo ra một cái chung thực sự là một nhà máy trang trí nhà ở , nói cách khác, một chức năng trang trí làm cho các nhà trang trí khác. Bằng cách đó, sẽ có ít sự lặp lại mã hơn và cho phép tuân theo nguyên tắc DRY .

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>

Để làm cho mã dễ đọc hơn, bạn có thể gán tên mô tả nhiều hơn cho các trình trang trí do nhà máy tạo ra:

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>

hoặc thậm chí kết hợp chúng như thế này:

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>

Hiệu quả

Trong khi các ví dụ trên làm tất cả công việc, mã được tạo ra bao gồm một lượng chi phí khá lớn dưới dạng các lệnh gọi hàm ngoài khi nhiều trình trang trí được áp dụng cùng một lúc. Điều này có thể không quan trọng, tùy thuộc vào cách sử dụng chính xác (ví dụ, có thể bị ràng buộc I / O).

Nếu tốc độ của chức năng được trang trí là quan trọng, thì chi phí có thể được giữ cho một lệnh gọi chức năng bổ sung duy nhất bằng cách viết một hàm nhà máy trang trí hơi khác, thực hiện thêm tất cả các thẻ cùng một lúc, do đó nó có thể tạo mã tránh các lệnh gọi hàm gây nghiện phát sinh bằng cách sử dụng các trang trí riêng biệt cho mỗi thẻ.

Điều này đòi hỏi nhiều mã hơn trong chính trình trang trí, nhưng điều này chỉ chạy khi nó được áp dụng cho các định nghĩa hàm, không phải sau này khi chúng được gọi. Điều này cũng áp dụng khi tạo các tên dễ đọc hơn bằng cách sử dụng các lambdachức năng như được minh họa trước đây. Mẫu vật:

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>

2
upvote để tham khảo DRY :-)
nitin3685

Cảm ơn bạn đã giải thích "@wraps (vui vẻ)" :)
chú thích

20

Một cách khác để làm điều tương tự:

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'

Hoặc, linh hoạt hơn:

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'

Cần functools.update_wrappergiữ lạisayhi.__name__ == "sayhi"
Eric

19

Làm thế nào tôi có thể tạo hai trình trang trí trong Python sẽ làm như sau?

Bạn muốn các chức năng sau, khi được gọi:

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

Trở về:

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

Giải pháp đơn giản

Để thực hiện điều này một cách đơn giản nhất, hãy tạo các trình trang trí trả về lambdas (các hàm ẩn danh) đóng trên hàm (đóng) và gọi nó:

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

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

Bây giờ sử dụng chúng như mong muốn:

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

và bây giờ:

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

Vấn đề với giải pháp đơn giản

Nhưng chúng ta dường như đã mất chức năng ban đầu.

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

Để tìm ra nó, chúng ta cần đào sâu vào việc đóng từng lambda, một trong số đó được chôn trong cái kia:

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

Vì vậy, nếu chúng ta đặt tài liệu về chức năng này hoặc muốn có thể trang trí các chức năng có nhiều hơn một đối số hoặc chúng ta chỉ muốn biết chức năng nào chúng ta đang xem xét trong phiên gỡ lỗi, chúng ta cần phải làm thêm một chút với vỏ bánh.

Giải pháp đầy đủ tính năng - khắc phục hầu hết các vấn đề này

Chúng tôi có trang trí wrapstừ các functoolsmô-đun trong thư viện tiêu chuẩn!

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

Thật không may là vẫn còn một số nồi hơi, nhưng điều này là đơn giản như chúng ta có thể làm cho nó.

Trong Python 3, bạn cũng nhận __qualname____annotations__gán theo mặc định.

Vậy bây giờ:

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

Và bây giờ:

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

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

Phần kết luận

Vì vậy, chúng ta thấy rằng wrapslàm cho hàm gói thực hiện hầu hết mọi thứ trừ khi cho chúng ta biết chính xác hàm này lấy làm đối số.

Có những mô-đun khác có thể cố gắng giải quyết vấn đề, nhưng giải pháp chưa có trong thư viện chuẩn.


14

Để giải thích trang trí một cách đơn giản:

Với:

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

Khi nào:

func(*args, **kwargs)

Bạn thực sự làm:

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

13

Một trình trang trí lấy định nghĩa hàm và tạo một hàm mới thực thi hàm này và biến đổi kết quả.

@deco
def do():
    ...

tương đương với:

do = deco(do)

Thí dụ:

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

Điều này

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

tương đương với điều này

def do2(number):
    return chr(number)

do2 = deco(do2)

65 <=> 'a'

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

Để hiểu người trang trí, điều quan trọng cần lưu ý là người trang trí đã tạo ra một chức năng mới, đó là bên trong thực thi chức năng và biến đổi kết quả.


Không nên đầu ra của print(do(65))print(do2(65))được AA?
Cá cây Zhang

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

Bạn cũng có thể viết trang trí trong lớp

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

1
Lý do thích một lớp học ở đây là có hành vi liên quan rõ ràng, với hai trường hợp. Bạn thực sự có thể có được hai trình trang trí của mình bằng cách gán các lớp được xây dựng cho các tên bạn muốn, thay vì lặp lại các tham số. Điều này là khó hơn để làm với một chức năng. Thêm nó vào ví dụ sẽ chỉ ra lý do tại sao điều này không chỉ là dư thừa.
Jon Jay Obermark

8

Câu trả lời này đã được trả lời từ lâu, nhưng tôi nghĩ rằng tôi sẽ chia sẻ lớp Trang trí của mình, điều này giúp cho việc viết trang trí mới trở nên dễ dàng và gọn nhẹ.

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)

Đối với một người tôi nghĩ rằng điều này làm cho hành vi của người trang trí rất rõ ràng, nhưng nó cũng giúp dễ dàng xác định người trang trí mới rất chính xác. Đối với ví dụ được liệt kê ở trên, sau đó bạn có thể giải quyết nó như sau:

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"

Bạn cũng có thể sử dụng nó để thực hiện các tác vụ phức tạp hơn, ví dụ như trình trang trí tự động làm cho hàm được áp dụng đệ quy cho tất cả các đối số trong một trình vòng lặp:

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

Bản in nào:

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

Lưu ý rằng ví dụ này không bao gồm listloại trong phần khởi tạo của trình trang trí, vì vậy trong câu lệnh in cuối cùng, phương thức được áp dụng cho chính danh sách, không phải các thành phần của danh sách.


7

Dưới đây là một ví dụ đơn giản về trang trí chuỗi. Lưu ý dòng cuối cùng - nó cho thấy những gì đang diễn ra dưới vỏ bọc.

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

Đầu ra trông như sau:

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

6

Nói về ví dụ về bộ đếm - như đã nêu ở trên, bộ đếm sẽ được chia sẻ giữa tất cả các chức năng sử dụng trình trang trí:

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

Bằng cách đó, trình trang trí của bạn có thể được sử dụng lại cho các chức năng khác nhau (hoặc được sử dụng để trang trí cùng một chức năng nhiều lần func_counter1 = counter(func); func_counter2 = counter(func):) và biến đếm sẽ giữ riêng tư cho từng chức năng.


6

Trang trí các hàm với số lượng đối số khác nhau:

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

Kết quả:

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  

1
Điều này có thể dễ dàng được thực hiện linh hoạt hơn nữa bằng cách cung cấp hỗ trợ cho các đối số từ khóa thông qua def wrapper(*args, **kwargs):fn(*args, **kwargs).
martineau 17/05/2015

5

Câu trả lời Paolo Bergantino của có lợi thế lớn của chỉ sử dụng stdlib, và làm việc cho ví dụ này đơn giản mà không có trang trí tranh luận hay chức năng trang trí đối số.

Tuy nhiên, nó có 3 hạn chế lớn nếu bạn muốn giải quyết các trường hợp tổng quát hơn:

  • như đã lưu ý trong một số câu trả lời, bạn không thể dễ dàng sửa đổi mã để thêm các đối số trang trí tùy chọn . Ví dụ, tạo một makestyle(style='bold')trang trí là không tầm thường.
  • bên cạnh đó, các hàm bao được tạo @functools.wraps không bảo toàn chữ ký , do đó, nếu các đối số xấu được cung cấp, chúng sẽ bắt đầu thực thi và có thể gây ra một loại lỗi khác so với thông thường TypeError.
  • cuối cùng, khá khó khăn trong các trình bao bọc được tạo @functools.wrapsđể truy cập một đối số dựa trên tên của nó . Thật vậy, đối số có thể xuất hiện trong *args, trong **kwargshoặc hoàn toàn không xuất hiện (nếu đó là tùy chọn).

Tôi đã viết decopatchđể giải quyết vấn đề đầu tiên, và viết makefun.wrapsđể giải quyết hai vấn đề còn lại. Lưu ý rằng makefuntận dụng thủ thuật tương tự như decoratorlib nổi tiếng .

Đây là cách bạn sẽ tạo một trình trang trí với các đối số, trả về các hàm bao giữ chữ ký thực sự:

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

decopatchcung cấp cho bạn hai phong cách phát triển khác để ẩn hoặc hiển thị các khái niệm python khác nhau, tùy thuộc vào sở thích của bạn. Phong cách nhỏ gọn nhất là như sau:

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

Trong cả hai trường hợp, bạn có thể kiểm tra xem trình trang trí có hoạt động như mong đợi không:

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

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

Vui lòng tham khảo tài liệu để biết chi tiết.

Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.