Câu hỏi Làm thế nào để làm cho một chuỗi các trang trí chức năng?


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

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

... sẽ trả về:

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

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


2382
2018-04-11 07:05


gốc




Các câu trả lời:


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

def makebold(fn):
    def wrapped():
        return "<b>" + fn() + "</b>"
    return wrapped

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

@makebold
@makeitalic
def hello():
    return "hello world"

print hello() ## returns "<b><i>hello world</i></b>"

2658
2018-04-11 07:16



Cân nhắc sử dụng functools.wraps hoặc, tốt hơn, mô-đun trang trí từ PyPI: chúng duy trì một số siêu dữ liệu quan trọng (chẳng hạn như __name__ và, nói về gói trang trí, chữ ký chức năng). - Marius Gedminas
*argsvà **kwargs nên được thêm vào câu trả lời. Chức năng trang trí có thể có đối số và chúng sẽ bị mất nếu không được chỉ định. - Blusky


Nếu bạn không có những lời giải thích dài, 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 trang trí, trước hết 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ó những hậu quả quan trọng. Hãy xem lý do 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, e:
    print(e)
    #outputs: "name 'shout' is not defined"

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

Giữ nó trong tâm trí. Chúng tôi sẽ sớm quay lại.

Một đặc tính thú vị khác của 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, e:
    print(e)
    #outputs : "name 'whisper' is not defined"*
    #Python's functions are objects

Tham chiếu hàm

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

Bạn đã thấy các hàm đó 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 một hàm khác

Đó có nghĩa là một hàm có thể return chứ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ể return một hàm, bạn có thể chuyển một hàm dưới dạng 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 các trang trí. Bạn thấy đấy, người trang trí là "hàm bao", có nghĩa là chúng cho phép bạn thực thi mã trước và sau hàm mà chúng trang trí mà không sửa đổi chính hàm đó.

Trang trí thủ công

Cách bạn thực hiện theo cách 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 mỗi khi bạn gọi a_stand_alone_function, a_stand_alone_function_decorated được gọi thay thế. Thật dễ dàng, chỉ cần ghi đè a_stand_alone_function với hàm 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. @decorator chỉ 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 decorator mô hình thiết kế. 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ư 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 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 là bạn có thể dễ dàng xem 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ể chỉ để lại hạnh phúc, hoặc đốt cháy não của bạn nhiều hơn một chút và xem sử dụng tiên tiến của trang trí.


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

Chuyển đối số cho hàm được 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 đối số đầu tiên của chúng là 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 trang trí cho các phương pháp theo cùng một cách! Chỉ cần nhớ lấy self vào xem 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í theo mục đích chung - bạn sẽ áp dụng cho bất kỳ chức năng hoặc phương pháp 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?

Chuyển đối số cho 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ể hơi bị xoắn, vì một người trang trí phải chấp nhận một hàm làm đối số. Do đó, bạn không thể chuyển các đối số của hàm được trang trí trực tiếp cho người trang trí.

Trước khi đổ xô đến 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ó hoàn toàn giống nhau. "my_decorator"được gọi. Vì vậy, khi bạn @my_decorator, bạn đang yêu cầu Python gọi hàm 'được gắn nhãn bởi biến "my_decorator"'.

Cái 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 để có được cái ác.

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ì ngạc nhiên ở đây.

Hãy làm chính xác điều tương tự, nhưng bỏ qua tất cả các biến trung gian pesky:

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 không? Chúng tôi đã sử dụng cuộc 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 ra trang trí khi đang bay, chúng ta có thể chuyển các đối số cho hàm đó, đúng 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: https://stackoverflow.com/questions/13857/can-you-explain-closures-as-they-relate-to-python
        print("I am the decorator. Somehow you passed me arguments: {0}, {1}".format(decorator_arg1, decorator_arg2))

        # Don't confuse decorator arguments and function arguments!
        def wrapped(function_arg1, function_arg2) :
            print("I am the wrapper around the decorated function.\n"
                  "I can access all the variables\n"
                  "\t- from the decorator: {0} {1}\n"
                  "\t- from the function call: {2} {3}\n"
                  "Then I can pass them to the decorated function"
                  .format(decorator_arg1, decorator_arg2,
                          function_arg1, function_arg2))
            return func(function_arg1, function_arg2)

        return wrapped

    return my_decorator

@decorator_maker_with_arguments("Leonard", "Sheldon")
def decorated_function_with_arguments(function_arg1, function_arg2):
    print("I am the decorated function and only knows about my arguments: {0}"
           " {1}".format(function_arg1, function_arg2))

decorated_function_with_arguments("Rajesh", "Howard")
#outputs:
#I make decorators! And I accept arguments: Leonard Sheldon
#I am the decorator. Somehow you passed me arguments: Leonard Sheldon
#I am the wrapper around the decorated function. 
#I can access all the variables 
#   - from the decorator: Leonard Sheldon 
#   - from the function call: Rajesh Howard 
#Then I can pass them to the decorated function
#I am the decorated function and only knows about my arguments: Rajesh Howard

Ở đây nó là: một trang trí với các đối số. Đối số có thể được đặt là 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 đối số cho trang trí như bất kỳ hàm nào bằng cách sử dụng thủ thuật này. Bạn thậm chí có thể sử dụng *args, **kwargs nếu bạn ước. Nhưng hãy nhớ rằng người trang trí được gọi là chỉ một lần. Ngay khi Python nhập khẩu tập lệnh. Bạn không thể thiết lập động các đối số sau đó. Khi bạn nhập "x", chức năng đã được trang trínên 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ư là một tiền thưởng, tôi sẽ cung cấp cho bạn một đoạn trích để làm cho bất kỳ trang trí nào chấp nhận chung bất kỳ đối số. Sau khi tất 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 bọc trang trí.

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

Ồ vâng, trang trí!

Hãy cùng vui vẻ và viết một trang trí cho những người 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 sự đệ 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ề làm chủ điều này?


Các phương pháp hay nhất: trang trí

  • 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 cuộc gọi chức năng. Ghi nhớ nó trong tâm trí.
  • Bạn không thể bỏ trang trí một chức năng. (Có  hacks để tạo 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ã.
  • Trang trí bọc chức năng, có thể làm cho họ khó khăn để 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 functools module được giới thiệu trong Python 2.5. Nó bao gồm hàm functools.wraps(), sao chép tên, mô-đun và chuỗi tài liệu của hàm được trang trí thành trình bao bọc của nó.

(Sự thật thú vị: functools.wraps() là một 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

Các trang trí có thể hữu ích như thế nào?

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

Dường như 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. 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ư sau:

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

Bản thân Python cung cấp một số trang trí: property, staticmethod, v.v.

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

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


3811
2018-04-11 08:00



"Bạn không thể bỏ trang trí một chức năng." - Mặc dù thông thường là đúng, có thể tiếp cận bên trong phần đóng trong hàm trả về bởi một người trang trí (tức là thông qua __closure__ thuộc tính) để kéo ra hàm undecorated gốc. Một ví dụ về cách sử dụng được ghi lại trong câu trả lời này bao gồm cách có thể tiêm một hàm trang trí ở mức thấp hơn trong các trường hợp hạn chế. - metatoaster
Trong khi đây là một câu trả lời tuyệt vời, tôi nghĩ rằng nó là một chút sai lầm trong một số cách. Python @decorator cú pháp có lẽ thường được sử dụng để thay thế một hàm có đóng bao bọc (như câu trả lời mô tả). Nhưng nó cũng có thể thay thế chức năng bằng cái gì đó khác. Nội trang property, classmethod và staticmethod trang trí thay thế các chức năng với một descriptor, ví dụ. Một trang trí cũng có thể làm điều 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ý của một số loại, sau đó trả lại, chưa sửa đổi, không có bất kỳ trình bao bọc nào. - Blckknght
Thực tế là "chức năng là đối tượng", trong khi hoàn toàn đúng trong Python, là một chút sai lầm. Lưu trữ các hàm trong các biến, chuyển chúng thành các đối số và trả về chúng dưới dạng kết quả là tất cả có thể không có hàm thực sự là đối tượng và có nhiều ngôn ngữ khác nhau có hàm hạng nhất nhưng không có đối tượng. - 00dani
Dễ dàng giải thích tốt nhất trên web về trang trí, với rất tốt giải thích kiểm tra đi bộ bạn từng bước của con đường. Thực sự đánh giá cao sự chú ý đến từng chi tiết. - Abhi Tk
Rất hữu ích, giải thích sâu sắc. Các ví dụ giúp ích rất nhiều! - Charles


Ngoài ra, bạn có thể viết một hàm nhà máy trả về một trình trang trí kết thúc tốt đẹp giá trị trả lại của hàm được trang trí trong thẻ được chuyển đến chức năng của nhà máy. 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 đã 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

mà 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 cách viết tắt:

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

132
2017-10-25 06:18



Theo tôi, tốt nhất là tránh nhiều hơn một trang trí càng nhiều 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ẽ viết mã với * kwargs như def wrap_in_tag(*kwargs) sau đó @wrap_in_tag('b','i') - guneysus


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 những người trang trí là gì.

Trang trí chỉ là đường hợp pháp.

Điều này

@decorator
def func():
    ...

mở rộng đến

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

101
2018-04-11 07:19



Điều này thật thanh lịch, đơn giản, dễ hiểu. 10000 upvotes cho bạn, Sir Ockham. - neuronet
Câu trả lời tuyệt vời và đơn giản. Muốn thêm điều đó khi sử dụng @decorator() (thay vì @decorator) đó là cú pháp đường cho func = decorator()(func). Đây cũng là thực tế phổ biến khi bạn cần tạo trang trí "trên bay" - Omer Dagan


Và tất nhiên bạn có thể trả lại lambdas cũng như từ mộ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()

59
2018-05-17 03:26



Và thêm một bước nữa: makebold = lambda f : lambda "<b>" + f() + "</b>" - Robᵩ
@ Robᵩ: Để có cú pháp chính xác: makebold = lambda f: lambda: "<b>" + f() + "</b>" - martineau
Muộn cho bữa tiệc, nhưng tôi thực sự sẽ gợi ý makebold = lambda f: lambda *a, **k: "<b>" + f(*a, **k) + "</b>" - seequ


Python trang trí thêm chức năng bổ sung cho một chức năng khác

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

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

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

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

Bây giờ 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 bản in. Nhưng bởi vì tôi không thích lặp lại bản thân 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

Bây giờ tôi có thể đổi lớp của mình 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/library/l-cpdecor.html


56
2017-12-26 06:13



Lưu ý là thanh lịch như các hàm lambda được đề xuất bởi @Rune Kaagaard - rds
công việc của từ khóa tự ở đây là gì? - asit_dhal
@Phoenix: The self đối số là cần thiết vì newFunction() được xác định trong addDashes() được thiết kế đặc biệt để trở thành phương pháp trang trí không phải là một trang trí chức năng chung. Các self đối số đại diện cho cá thể lớp và được chuyển tới các phương thức lớp cho dù chúng có sử dụng hay không - xem phần có tiêu đề Phương pháp trang trí trong câu trả lời của @ e-satis. - martineau
Cũng in đầu ra. - user1767754


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

Vì những lý do tương tự, functools.wraps decorator được sử dụng để thay đổi các thuộc tính meta của hàm được bao bọc 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 được nhúng (func.__doc__) là những chức năng được trang trí thay vì wrapped()'S.

from functools import wraps

def makebold(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return "<b>" + fn(*args, **kwargs) + "</b>"
    return wrapped

def makeitalic(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return "<i>" + fn(*args, **kwargs) + "</i>"
    return wrapped

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

print(say())  # -> <b><i>Hello</i></b>

Tinh 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. Với sự giống nhau này, tốt hơn là bạn nên tạo một cái chung chung thực sự là trang trí nhà máy- nói cách khác, một người trang trí làm cho những người trang trí khác. Bằng cách đó sẽ có ít sự lặp lại mã - và cho phép KHÔ theo nguyên tắc.

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 một tên mô tả hơn cho các trang trí do nhà sản xuất 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ác công việc, mã được tạo ra liên quan đến một số tiền hợp lý của chi phí trong các hình thức của các cuộc gọi chức năng không liên quan khi nhiều 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ụ như có thể là I / O-bound).

Nếu tốc độ của chức năng được trang trí rất quan trọng, chi phí có thể được giữ lại bằng một chức năng 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, vì vậy nó có thể tạo mã tránh các cuộc gọi chức năng bổ sung 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 mã nhiều hơn trong trang trí riêng của mình, nhưng điều này chỉ chạy khi nó đang được appled để định nghĩa chức năng, không muộn hơn khi họ được gọi là chính họ. Điều này cũng áp dụng khi tạo nhiều tên dễ đọc hơn bằng cách sử dụng lambda chức năng như 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>

25
2017-12-03 18:09





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'

18
2017-07-26 16:11