วิธีที่จะทำให้ห่วงโซ่ของนักตกแต่งฟังก์ชั่นหรือไม่?


2755

ฉันจะสร้างสองนักตกแต่งใน Python ที่จะทำสิ่งต่อไปนี้ได้อย่างไร?

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

... ซึ่งควรกลับมา:

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

ฉันไม่ได้พยายามทำHTMLสิ่งนี้ในแอปพลิเคชันจริง - เพียงแค่พยายามเข้าใจว่านักตกแต่งและนักตกแต่งภายในทำงานอย่างไร

คำตอบ:


2926

ตรวจสอบเอกสารเพื่อดูวิธีการทำงานของมัณฑนากร นี่คือสิ่งที่คุณขอ:

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
พิจารณาใช้functools.wrapsหรือดีกว่านั้นโมดูลมัณฑนากรจาก PyPI : พวกเขาเก็บข้อมูลเมตาที่สำคัญบางอย่างไว้ (เช่น__name__และพูดถึงแพคเกจมัณฑนากรลายเซ็นฟังก์ชัน)
Marius Gedminas

31
*argsและ**kwargsควรเพิ่มในคำตอบ ฟังก์ชั่นการตกแต่งสามารถมีข้อโต้แย้งและพวกเขาจะหายไปหากไม่ได้ระบุ
Blusky

3
แม้ว่าคำตอบนี้มีข้อได้เปรียบที่ยอดเยี่ยมเพียงแค่ใช้ stdlib และทำงานกับตัวอย่างง่าย ๆ นี้ที่ไม่มีข้อโต้แย้งมัณฑนากรหรืออาร์กิวเมนต์ของฟังก์ชันการตกแต่งมันมีข้อ จำกัด ที่สำคัญ 3 ประการ: (1) ไม่มีการสนับสนุนอย่างง่ายสำหรับอาร์กิวเมนต์มัณฑนากรเสริม (2) รักษาลายเซ็น (3) ไม่มีวิธีง่ายๆในการแยกอาร์กิวเมนต์ที่มีชื่อจาก*args, **kwargs. วิธีง่ายๆในการแก้ปัญหาเหล่านี้ 3 ประเด็นในครั้งเดียวคือการใช้decopatchตามที่อธิบายไว้ที่นี่ นอกจากนี้คุณยังสามารถใช้decoratorตามที่ Marius Gedminas พูดถึงแล้วเพื่อแก้จุด 2 และ 3
smarie

4209

หากคุณไม่ได้เป็นคำอธิบายที่ยาวลองดูคำตอบของเปาโลเบอร์กันติโน

พื้นฐานมัณฑนากร

ฟังก์ชั่นของไพ ธ อนเป็นวัตถุ

เพื่อทำความเข้าใจกับนักตกแต่งคุณต้องเข้าใจก่อนว่าฟังก์ชั่นเป็นวัตถุใน Python สิ่งนี้มีผลกระทบที่สำคัญ มาดูกันว่าทำไมด้วยตัวอย่างง่ายๆ:

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

จำไว้ในใจ เราจะวนกลับไปหามันในไม่ช้า

คุณสมบัติที่น่าสนใจอีกอย่างของฟังก์ชั่น Python ก็คือมันสามารถนิยามได้ในอีกฟังก์ชั่น!

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

อ้างอิงฟังก์ชั่น

โอเคยังอยู่ที่นี่เหรอ? ตอนนี้ส่วนที่สนุก ...

คุณเคยเห็นว่าฟังก์ชั่นเป็นวัตถุ ดังนั้นฟังก์ชั่น:

  • สามารถกำหนดให้กับตัวแปร
  • สามารถกำหนดได้ในฟังก์ชั่นอื่น

นั่นหมายความว่าฟังก์ชั่นสามารถreturnใช้ฟังก์ชันอื่นได้

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

ยังมีอีก!

หากคุณสามารถreturnใช้งานได้คุณสามารถส่งผ่านหนึ่งพารามิเตอร์

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!

คุณมีทุกอย่างที่จำเป็นเพื่อทำความเข้าใจกับนักตกแต่ง คุณเห็นมัณฑนากรเป็น "wrappers" ซึ่งหมายความว่าพวกเขาให้คุณรันโค้ดก่อนและหลังฟังก์ชั่นที่พวกเขาตกแต่งโดยไม่ต้องแก้ไขฟังก์ชันเอง

ตกแต่งด้วยงานฝีมือ

คุณจะทำเองอย่างไร:

# 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

ตอนนี้คุณอาจต้องการที่ครั้งที่คุณโทรทุกa_stand_alone_function, a_stand_alone_function_decoratedเรียกว่าแทน ง่ายมากเพียงเขียนทับa_stand_alone_functionด้วยฟังก์ชันที่ส่งคืนโดย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!

ตกแต่งมัณฑนา

ตัวอย่างก่อนหน้านี้โดยใช้ไวยากรณ์มัณฑนากร:

@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

ใช่นั่นคือทั้งหมดมันง่ายมาก @decoratorเป็นเพียงทางลัดไปยัง:

another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)

ตกแต่งเป็นเพียงตัวแปร pythonic ของรูปแบบการออกแบบมัณฑนากร มีรูปแบบการออกแบบคลาสสิกหลายรูปแบบที่ฝังอยู่ใน Python เพื่อให้ง่ายต่อการพัฒนา (เช่นตัววนซ้ำ)

แน่นอนคุณสามารถสะสมนักตกแต่ง:

def bread(func):
    def wrapper():
        print("</''''''\>")
        func()
        print("<\______/>")
    return wrapper

def ingredients(func):
    def wrapper():
        print("#tomatoes#")
        func()
        print("~salad~")
    return wrapper

def sandwich(food="--ham--"):
    print(food)

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

การใช้รูปแบบการตกแต่ง Python:

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

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

ลำดับที่คุณตั้งค่าตัวตกแต่งสำคัญ:

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

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

ตอนนี้: ตอบคำถาม ...

โดยสรุปคุณสามารถดูวิธีตอบคำถามได้อย่างง่ายดาย:

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

ตอนนี้คุณสามารถทิ้งความสุขไว้หรือเผาสมองของคุณให้มากขึ้นและดูการใช้งานของนักตกแต่งขั้นสูง


พานักตกแต่งไปสู่อีกระดับ

ผ่านการขัดแย้งไปยังฟังก์ชั่นการตกแต่ง

# 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

วิธีการตกแต่ง

สิ่งหนึ่งที่ดีเกี่ยวกับ Python ก็คือวิธีการและฟังก์ชั่นนั้นเหมือนกันจริงๆ ความแตกต่างเพียงอย่างเดียวคือวิธีการคาดหวังว่าอาร์กิวเมนต์แรกของพวกเขาคือการอ้างอิงถึงวัตถุปัจจุบัน ( self)

นั่นหมายความว่าคุณสามารถสร้างมัณฑนากรได้หลายวิธีเช่นเดียวกัน! อย่าลืมคำนึงselfถึง:

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?

หากคุณสร้างมัณฑนากรทั่วไปคุณจะใช้กับฟังก์ชั่นหรือวิธีการใด ๆ ไม่ว่าจะมีข้อโต้แย้งใด ๆ ให้ใช้*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?

ผ่านการขัดแย้งกับมัณฑนากร

เยี่ยมมากตอนนี้คุณจะพูดอะไรเกี่ยวกับการส่งผ่านข้อโต้แย้งไปยังมัณฑนากร?

สิ่งนี้สามารถบิดได้บ้างเนื่องจากมัณฑนากรต้องยอมรับฟังก์ชั่นเป็นอาร์กิวเมนต์ ดังนั้นคุณไม่สามารถส่งผ่านข้อโต้แย้งของฟังก์ชันการตกแต่งโดยตรงไปยังผู้ตกแต่ง

ก่อนที่จะรีบไปหาทางแก้ปัญหาให้เขียนเตือนเล็กน้อย:

# 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

มันเหมือนกันหมด " my_decorator" ถูกเรียก ดังนั้นเมื่อคุณ@my_decoratorคุณกำลังบอก Python ให้เรียกใช้ฟังก์ชัน 'กำกับโดยตัวแปร " my_decorator"'

นี้เป็นสิ่งสำคัญ! ฉลากคุณให้สามารถชี้ตรงไป decorator- หรือไม่

เรามาทำความชั่ว ☺

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.

ไม่แปลกใจที่นี่

มาทำสิ่งเดียวกันกัน แต่ข้ามตัวแปรกลางที่น่ารำคาญทั้งหมด:

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.

มาทำให้สั้นลง :

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

เฮ้คุณเห็นไหม เราใช้การเรียกฟังก์ชันด้วย@ไวยากรณ์ "" :-)

ดังนั้นกลับไปที่นักตกแต่งด้วยข้อโต้แย้ง หากเราสามารถใช้ฟังก์ชั่นเพื่อสร้างมัณฑนากรได้ในทันทีเราสามารถส่งข้อโต้แย้งไปยังฟังก์ชั่นนั้นได้ใช่ไหม

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

นี่คือ: มัณฑนากรที่มีข้อโต้แย้ง อาร์กิวเมนต์สามารถตั้งค่าเป็นตัวแปรได้:

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

อย่างที่คุณเห็นคุณสามารถส่งผ่านข้อโต้แย้งไปยังมัณฑนากรเช่นเดียวกับฟังก์ชั่นใด ๆ ที่ใช้เคล็ดลับนี้ คุณสามารถใช้งานได้*args, **kwargsหากต้องการ แต่จำไว้ตกแต่งจะเรียกว่าเพียงครั้งเดียว เมื่อ Python นำเข้าสคริปต์ คุณไม่สามารถตั้งค่าอาร์กิวเมนต์ได้ในภายหลัง เมื่อคุณ "นำเข้า x" ฟังก์ชั่นได้รับการตกแต่งแล้วดังนั้นคุณจึงไม่สามารถเปลี่ยนแปลงอะไรได้


ลองฝึก: การตกแต่งมัณฑนากร

โอเคเป็นโบนัสฉันจะให้ข้อมูลสั้น ๆ แก่คุณเพื่อให้มัณฑนากรยอมรับข้อโต้แย้งใด ๆ ท้ายที่สุดเพื่อยอมรับข้อโต้แย้งเราได้สร้างมัณฑนากรของเราโดยใช้ฟังก์ชั่นอื่น

เราห่อมัณฑนากร

มีอะไรอีกที่เราเห็นเมื่อไม่นานมานี้ที่มีฟังก์ชั่นการพัน

โอ้ใช่มัณฑนากร!

มาสนุกกันแล้วเขียนมัณฑนากรเพื่อมัณฑนากร:

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

มันสามารถใช้ดังนี้:

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

ฉันรู้ว่าครั้งสุดท้ายที่คุณมีความรู้สึกนี้มันเป็นหลังจากฟังผู้ชายพูดว่า: "ก่อนที่จะเข้าใจการเรียกซ้ำคุณต้องเข้าใจการเรียกซ้ำ" แต่ตอนนี้คุณไม่รู้สึกดีกับการเรียนรู้สิ่งนี้หรือไม่?


แนวทางปฏิบัติที่ดี: นักตกแต่ง

  • ตัวตกแต่งได้ถูกนำมาใช้ใน Python 2.4 ดังนั้นตรวจสอบให้แน่ใจว่าโค้ดของคุณจะทำงานบน> = 2.4
  • มัณฑนากรชะลอการเรียกใช้ฟังก์ชัน เก็บไว้ในใจ
  • คุณไม่สามารถยกเลิกการตกแต่งฟังก์ชั่นได้ (มีเป็นแฮ็กเพื่อสร้างตกแต่งที่สามารถลบออก แต่ไม่มีใครใช้พวกเขา.) ดังนั้นเมื่อฟังก์ชั่นการตกแต่งก็ตกแต่งสำหรับทุกรหัส
  • มัณฑนากรห่อหุ้มฟังก์ชั่นซึ่งทำให้ยากต่อการดีบัก (สิ่งนี้ดีขึ้นจาก Python> = 2.5; ดูด้านล่าง)

functoolsโมดูลได้รับการแนะนำในหลาม 2.5 มันมีฟังก์ชั่นfunctools.wraps()ซึ่งคัดลอกชื่อโมดูลและ docstring ของฟังก์ชั่นการตกแต่งไปยังเสื้อคลุม

(ความจริงสนุก: functools.wraps()เป็นมัณฑนากร! ☺)

# 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

นักตกแต่งจะมีประโยชน์อย่างไร?

ตอนนี้คำถามใหญ่:ฉันจะใช้มัณฑนากรทำอะไรได้บ้าง

ดูเท่และมีพลัง แต่ตัวอย่างที่ใช้งานได้จริงจะยอดเยี่ยม มีความเป็นไปได้ 1,000 อย่าง การใช้แบบคลาสสิกเป็นการขยายลักษณะการทำงานของฟังก์ชั่นจาก lib ภายนอก (คุณไม่สามารถแก้ไขได้) หรือสำหรับการดีบั๊ก (คุณไม่ต้องการแก้ไขเพราะเป็นการชั่วคราว)

คุณสามารถใช้ฟังก์ชันนี้เพื่อขยายฟังก์ชั่นต่าง ๆ ในแบบ DRY เช่น:

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

แน่นอนว่าสิ่งที่ดีกับนักตกแต่งคือคุณสามารถใช้มันได้แทบทุกอย่างโดยไม่ต้องเขียนใหม่ แห้งฉันพูดว่า:

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

งูหลามตัวเองให้หลายตกแต่ง: property, staticmethodฯลฯ

  • Django ใช้ผู้ตกแต่งเพื่อจัดการแคชและดูการอนุญาต
  • การเรียกฟังก์ชั่นแบบอะซิงโครนัสแบบบิดเบี้ยวกับปลอม

นี่คือสนามเด็กเล่นขนาดใหญ่จริงๆ


15
"คุณไม่สามารถยกเลิกการตกแต่งฟังก์ชั่นได้" - โดยปกติแล้วเป็นไปได้ที่จะเข้าถึงภายในการปิดในฟังก์ชันส่งคืนโดยมัณฑนากร (เช่นผ่าน__closure__คุณสมบัติ) เพื่อดึงฟังก์ชั่นที่ไม่ได้ตกแต่งดั้งเดิมออกมา ตัวอย่างการใช้งานมีการบันทึกไว้ในคำตอบนี้ซึ่งครอบคลุมถึงความเป็นไปได้ในการฉีดฟังก์ชันมัณฑนากรในระดับที่ต่ำกว่าในสถานการณ์ที่ จำกัด
metatoaster

8
แม้ว่านี่จะเป็นคำตอบที่ยอดเยี่ยม แต่ฉันคิดว่ามันเป็นความเข้าใจผิดในบางวิธี @decoratorไวยากรณ์ของ Python อาจใช้บ่อยที่สุดในการแทนที่ฟังก์ชันด้วยการปิด wrapper (ตามคำตอบที่อธิบายไว้) แต่มันยังสามารถแทนที่ฟังก์ชั่นเป็นอย่างอื่นได้ builtin property, classmethodและstaticmethodตกแต่งเปลี่ยนฟังก์ชั่นที่มีคำอธิบายถึงตัวอย่างเช่น มัณฑนากรสามารถทำบางสิ่งได้ด้วยฟังก์ชั่นเช่นการบันทึกการอ้างอิงไปยังรีจีสทรีบางประเภทจากนั้นส่งคืนโดยไม่ต้องแก้ไขโดยไม่ต้องใช้ตัวคลุม
Blckknght

3
ความจริงที่ว่า "ฟังก์ชั่นเป็นวัตถุ" ในขณะที่ความจริงทั้งหมดใน Python นั้นทำให้เข้าใจผิดเล็กน้อย การจัดเก็บฟังก์ชั่นในตัวแปรส่งผ่านเป็นอาร์กิวเมนต์และส่งคืนเป็นผลลัพธ์ทั้งหมดทำได้โดยไม่มีฟังก์ชั่นเป็นวัตถุจริงและมีภาษาต่าง ๆ ที่มีฟังก์ชั่นชั้นหนึ่ง แต่ไม่มีวัตถุ
00dani

1
นี่เป็นหนึ่งในคำตอบที่ยิ่งใหญ่ที่นั่น ... ขอบคุณมาก! อาร์กิวเมนต์เริ่มต้นที่มาจากฟังก์ชันไม่แสดงเป็น args / kwargs ใน wrapper ของมัณฑนากรอย่างไร
Naz

เลื่อนกลับขึ้นไปด้านบนสุดของคำตอบเพื่อโหวตเพราะ "นักตกแต่งจะมีประโยชน์ได้อย่างไร" ส่วนมีประโยชน์มาก
Noumenon

145

หรือคุณสามารถเขียนฟังก์ชั่นจากโรงงานซึ่งส่งคืนมัณฑนากรซึ่งตัดค่าตอบแทนของฟังก์ชั่นการตกแต่งในแท็กที่ส่งผ่านไปยังฟังก์ชั่นจากโรงงาน ตัวอย่างเช่น:

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

สิ่งนี้ทำให้คุณสามารถเขียน:

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

หรือ

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

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

ส่วนตัวฉันจะเขียนมัณฑนากรค่อนข้างแตกต่าง:

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

ซึ่งจะให้ผล:

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

อย่าลืมโครงสร้างของมัณฑนากรที่เป็นชวเลข:

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

5
ในความคิดของฉันมันจะดีกว่าที่จะหลีกเลี่ยงมากกว่าหนึ่งมัณฑนากรเท่าที่จะทำได้ ถ้าฉันต้องเขียนฟังก์ชั่นจากโรงงานฉันก็จะเขียนมันด้วย * kwargs อย่างdef wrap_in_tag(*kwargs)นั้น@wrap_in_tag('b','i')
guneysus

120

ดูเหมือนว่าคนอื่นจะบอกคุณแล้วว่าจะแก้ปัญหาอย่างไร ฉันหวังว่าสิ่งนี้จะช่วยให้คุณเข้าใจว่านักตกแต่งคืออะไร

นักตกแต่งเป็นเพียงน้ำตาลทราย

นี้

@decorator
def func():
    ...

ขยายเป็น

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

3
นี่คือสง่างามเรียบง่ายเข้าใจง่าย 10,000 upvotes สำหรับคุณ Sir Ockham
eric

2
คำตอบที่ยอดเยี่ยมและเรียบง่าย ต้องการที่จะเพิ่มว่าเมื่อใช้@decorator()(แทน@decorator) func = decorator()(func)มันเป็นน้ำตาลประโยคสำหรับ นอกจากนี้ยังเป็นเรื่องธรรมดาเมื่อคุณจำเป็นต้องสร้างการตกแต่ง "ในทันที"
Omer Dagan

64

และแน่นอนว่าคุณสามารถส่งคืน lambdas ได้ด้วยฟังก์ชั่นมัณฑนากร:

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
และอีกหนึ่งขั้นตอนต่อไป:makebold = lambda f : lambda "<b>" + f() + "</b>"
Robᵩ

13
@ Robᵩ: ถูกต้องทางไวยากรณ์:makebold = lambda f: lambda: "<b>" + f() + "</b>"
ติเน

11
ไปงานปาร์ตี้สาย แต่ฉันอยากจะแนะนำจริงๆmakebold = lambda f: lambda *a, **k: "<b>" + f(*a, **k) + "</b>"
seequ

สิ่งนี้ต้องการfunctools.wrapsเพื่อที่จะไม่ทิ้ง docstring / signature / ชื่อของsay
Eric

สิ่งที่สำคัญคือไม่ว่าจะเป็นคำตอบของคุณ มี@wrapsที่อื่นในหน้านี้จะไม่ช่วยฉันเมื่อฉันพิมพ์help(say)และได้รับ"ความช่วยเหลือในการทำงาน <แลมบ์ดา>`แทน'ความช่วยเหลือเกี่ยวกับฟังก์ชั่นบอกว่า' .
เอริค

61

Python decorators เพิ่มฟังก์ชันพิเศษให้กับฟังก์ชันอื่น

มัณฑนากรตัวเอียงอาจเป็นเช่นนั้น

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

โปรดทราบว่าฟังก์ชั่นที่กำหนดไว้ภายในฟังก์ชั่น สิ่งที่มันทำคือแทนที่ฟังก์ชั่นด้วยฟังก์ชั่นที่เพิ่งกำหนดใหม่ ตัวอย่างเช่นฉันมีชั้นนี้

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

ตอนนี้พูดว่าฉันต้องการฟังก์ชั่นทั้งสองเพื่อพิมพ์ "---" หลังและก่อนที่จะทำ ฉันสามารถเพิ่มการพิมพ์ "---" ก่อนและหลังแต่ละคำสั่งการพิมพ์ แต่เพราะฉันไม่ชอบทำซ้ำตัวเองฉันจะทำมัณฑนากร

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

ดังนั้นตอนนี้ฉันสามารถเปลี่ยนชั้นเรียนเป็น

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

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

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับนักตกแต่งตรวจสอบที่ http://www.ibm.com/developerworks/linux/library/l-cpdecor.html


หมายเหตุเป็นสง่างามเป็นฟังก์ชั่นแลมบ์ดาที่เสนอโดย @Rune Kaagaard
RDS

1
@ ฟีนิกซ์: selfจำเป็นต้องมีการโต้แย้งเนื่องจากการnewFunction()กำหนดไว้ในaddDashes()นั้นได้รับการออกแบบมาโดยเฉพาะเพื่อเป็นผู้ตกแต่งวิธีการไม่ใช่ผู้ตกแต่งฟังก์ชั่นทั่วไป selfอาร์กิวเมนต์หมายถึงเช่นชั้นและมีการส่งผ่านไปยังวิธีการเรียนไม่ว่าจะใช้หรือไม่ - ดูหัวข้อตกแต่งวิธีการในคำตอบ @ E-พึงพอใจของ
martineau

1
พิมพ์ออกเช่นกันโปรด
user1767754

ไม่มีfunctools.wraps
Eric

39

คุณสามารถทำให้นักตกแต่งสองคนแยกกันทำในสิ่งที่คุณต้องการตามที่แสดงไว้ด้านล่าง สังเกตการใช้งาน*args, **kwargsในการประกาศwrapped()ฟังก์ชั่นที่รองรับฟังก์ชั่นการตกแต่งที่มีอาร์กิวเมนต์หลายตัว (ซึ่งไม่จำเป็นจริงๆสำหรับsay()ฟังก์ชั่นตัวอย่างแต่รวมไว้สำหรับการใช้งานทั่วไป)

ด้วยเหตุผลที่คล้ายกันfunctools.wrapsมัณฑนากรจะใช้ในการเปลี่ยนคุณสมบัติเมตาของฟังก์ชั่นห่อเป็นของที่ถูกตกแต่ง สิ่งนี้ทำให้ข้อความแสดงข้อผิดพลาดและเอกสารฟังก์ชันของฟังก์ชันฝังตัว ( func.__doc__) เป็นของฟังก์ชันตกแต่งแทนที่จะ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>

การปรับแต่ง

อย่างที่คุณเห็นว่ามีรหัสซ้ำซ้อนจำนวนมากในเครื่องมือตกแต่งทั้งสองนี้ ให้ความคล้ายคลึงกันนี้จะเป็นการดีกว่าที่คุณจะสร้างโรงงานทั่วไปที่จริงแล้วเป็นโรงงานมัณฑนากร - กล่าวอีกนัยหนึ่งคือฟังก์ชันมัณฑนากรที่ทำให้ผู้ตกแต่งอื่น ๆ วิธีนั้นจะมีการทำซ้ำรหัสน้อยลงและอนุญาตให้มีการติดตามหลักการ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>

ในการทำให้โค้ดอ่านง่ายขึ้นคุณสามารถกำหนดชื่อที่มีความหมายมากขึ้นให้กับผู้ตกแต่งที่สร้างจากโรงงาน:

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>

หรือรวมเข้าด้วยกันเช่นนี้:

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>

อย่างมีประสิทธิภาพ

ในขณะที่ตัวอย่างข้างต้นทำงานได้ทั้งหมดรหัสที่สร้างขึ้นนั้นเกี่ยวข้องกับปริมาณการใช้งานในรูปแบบของการเรียกฟังก์ชั่นภายนอกเมื่อมีการใช้งานมัณฑนากรหลายคนพร้อมกัน สิ่งนี้อาจไม่สำคัญขึ้นอยู่กับการใช้งานที่แน่นอน (เช่น I / O-bound เป็นต้น)

หากความเร็วของฟังก์ชั่นการตกแต่งมีความสำคัญค่าใช้จ่ายสามารถถูกเก็บไว้ในการเรียกฟังก์ชั่นพิเศษเดียวโดยการเขียนฟังก์ชั่นมัณฑนากรโรงงานที่แตกต่างกันเล็กน้อยซึ่งใช้เพิ่มแท็กทั้งหมดในครั้งเดียวดังนั้นจึงสามารถสร้างรหัส โดยใช้เครื่องมือตกแต่งแยกต่างหากสำหรับแต่ละแท็ก

สิ่งนี้ต้องการรหัสเพิ่มเติมในตัวตกแต่งภายใน แต่จะทำงานเฉพาะเมื่อมันถูกนำไปใช้กับคำจำกัดความของฟังก์ชั่นเท่านั้นไม่ใช่ในภายหลังเมื่อมีการเรียกตัวเอง นอกจากนี้ยังใช้เมื่อสร้างชื่อที่อ่านได้มากขึ้นโดยใช้lambdaฟังก์ชั่นตามที่แสดงไว้ก่อนหน้า ตัวอย่าง:

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 สำหรับการอ้างอิงถึง DRY :-)
nitin3685

ขอบคุณสำหรับคำอธิบาย "@wraps (fun)" :)
walknotes

20

อีกวิธีในการทำสิ่งเดียวกัน:

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'

หรือยืดหยุ่นมากขึ้น:

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'

จำเป็นต้องมีfunctools.update_wrapperเพื่อรักษาsayhi.__name__ == "sayhi"
Eric

19

ฉันจะสร้างสองนักตกแต่งใน Python ที่จะทำสิ่งต่อไปนี้ได้อย่างไร?

คุณต้องการฟังก์ชั่นต่อไปนี้เมื่อเรียกว่า:

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

ในการส่งคืน:

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

ทางออกที่ง่าย

ในการทำสิ่งนี้ให้ทำมัณฑนากรที่ส่งกลับ lambdas (ฟังก์ชั่นนิรนาม) ซึ่งปิดฟังก์ชั่น (ปิด) และเรียกมันว่า:

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

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

ตอนนี้ใช้พวกเขาตามที่ต้องการ:

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

และตอนนี้:

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

ปัญหาเกี่ยวกับทางออกที่ง่าย

แต่ดูเหมือนว่าเราจะสูญเสียฟังก์ชั่นดั้งเดิมเกือบไปแล้ว

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

ในการค้นหามันเราจะต้องขุดลงไปในการปิดของแต่ละแลมบ์ดาซึ่งหนึ่งในนั้นถูกฝังไว้ในอีกอันหนึ่ง:

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

ดังนั้นหากเราใส่เอกสารเกี่ยวกับฟังก์ชั่นนี้หรือต้องการที่จะสามารถตกแต่งฟังก์ชั่นที่ใช้อาร์กิวเมนต์มากกว่าหนึ่งหรือเราแค่ต้องการที่จะรู้ว่าฟังก์ชั่นที่เรากำลังมองหาในเซสชั่นการแก้จุดบกพร่องเราต้องทำเพิ่มเติม เสื้อคลุม

โซลูชันที่โดดเด่นเต็มรูปแบบ - การเอาชนะปัญหาเหล่านี้ส่วนใหญ่

เรามีมัณฑนากรwrapsจากfunctoolsโมดูลในห้องสมุดมาตรฐาน!

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

มันโชคร้ายที่ยังมีหม้อต้มน้ำอยู่บ้าง แต่มันก็ง่ายพอ ๆ กับที่เราทำ

ใน Python 3 คุณจะได้รับ__qualname__และ__annotations__กำหนดตามค่าเริ่มต้น

ดังนั้นตอนนี้:

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

และตอนนี้:

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

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

ข้อสรุป

ดังนั้นเราจะเห็นว่าการwrapsทำให้ฟังก์ชั่นการตัดทำได้เกือบทุกอย่างยกเว้นบอกเราอย่างชัดเจนว่าฟังก์ชั่นใช้อะไรเป็นอาร์กิวเมนต์

มีโมดูลอื่น ๆ ที่อาจพยายามแก้ไขปัญหา แต่วิธีแก้ไขยังไม่อยู่ในไลบรารีมาตรฐาน


14

หากต้องการอธิบายมัณฑนากรด้วยวิธีง่ายๆ:

ด้วย:

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

ทำเมื่อไหร่:

func(*args, **kwargs)

คุณทำ:

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

13

มัณฑนากรใช้นิยามฟังก์ชันและสร้างฟังก์ชันใหม่ที่เรียกใช้ฟังก์ชันนี้และแปลงผลลัพธ์

@deco
def do():
    ...

เทียบเท่ากับ:

do = deco(do)

ตัวอย่าง:

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

นี้

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

เทียบเท่ากับสิ่งนี้

def do2(number):
    return chr(number)

do2 = deco(do2)

65 <=> 'a'

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

เพื่อให้เข้าใจถึงมัณฑนากรเป็นสิ่งสำคัญที่จะต้องสังเกตว่ามัณฑนากรสร้างฟังก์ชั่นใหม่ซึ่งอยู่ภายในซึ่งประมวลผลฟังก์ชั่นและแปลงผลลัพธ์


ไม่ควรส่งออกของprint(do(65))และ print(do2(65))เป็นAและ A?
Treefish 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()

นอกจากนี้คุณยังสามารถเขียนมัณฑนากรในชั้นเรียน

#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
เหตุผลที่ชอบคลาสที่นี่คือว่ามีพฤติกรรมที่เกี่ยวข้องอย่างชัดเจนมีสองกรณี คุณสามารถตกแต่งภายในได้สองคนโดยการกำหนดคลาสที่สร้างให้กับชื่อที่คุณต้องการแทนที่จะทำการซ้ำพารามิเตอร์อีกครั้ง ฟังก์ชั่นนี้ยากกว่า การเพิ่มลงในตัวอย่างจะชี้ให้เห็นว่าทำไมสิ่งนี้จึงไม่ซ้ำซ้อน
Jon Jay Obermark

8

คำตอบนี้ได้รับการตอบรับมานานแล้ว แต่ฉันคิดว่าฉันจะแบ่งปันคลาสมัณฑนากรของฉันซึ่งทำให้การเขียนมัณฑนากรใหม่ง่ายและกะทัดรัด

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)

สำหรับฉันคิดว่าสิ่งนี้ทำให้พฤติกรรมของนักตกแต่งชัดเจนมาก แต่มันก็ทำให้ง่ายต่อการกำหนดผู้ตกแต่งใหม่อย่างรัดกุม สำหรับตัวอย่างข้างต้นคุณสามารถแก้ไขได้ตาม:

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"

คุณสามารถใช้มันเพื่อทำงานที่ซับซ้อนมากขึ้นเช่นตัวอย่างเช่นมัณฑนากรซึ่งทำให้ฟังก์ชั่นถูกนำไปใช้ซ้ำกับอาร์กิวเมนต์ทั้งหมดในตัววนซ้ำโดยอัตโนมัติ:

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

สิ่งที่พิมพ์:

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

ขอให้สังเกตว่าตัวอย่างนี้ไม่รวมlistประเภทในการสร้างอินสแตนซ์ของมัณฑนากรดังนั้นในคำสั่งพิมพ์สุดท้ายวิธีการที่จะนำไปใช้กับรายการตัวเองไม่ใช่องค์ประกอบของรายการ


7

นี่คือตัวอย่างง่ายๆของการตกแต่งที่ผูกมัด บันทึกบรรทัดสุดท้าย - มันแสดงให้เห็นถึงสิ่งที่เกิดขึ้นภายใต้หน้ากาก

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

ผลลัพธ์ดูเหมือนว่า:

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

6

เมื่อพูดถึงตัวอย่างของตัวนับ - ตามที่ระบุข้างต้นตัวนับจะถูกแชร์ระหว่างฟังก์ชั่นทั้งหมดที่ใช้ตัวตกแต่ง:

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

ด้วยวิธีนี้มัณฑนากรของคุณสามารถนำกลับมาใช้ใหม่สำหรับฟังก์ชั่นที่แตกต่างกัน (หรือใช้ในการตกแต่งฟังก์ชั่นเดียวกันหลายครั้ง:) func_counter1 = counter(func); func_counter2 = counter(func)และตัวแปรตัวนับจะยังคงเป็นส่วนตัวสำหรับแต่ละคน


6

ตกแต่งฟังก์ชั่นที่มีจำนวนอาร์กิวเมนต์ต่างกัน:

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

ผลลัพธ์:

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
นี้ได้อย่างง่ายดายมากยิ่งขึ้นทำที่หลากหลายโดยที่ยังให้การสนับสนุนข้อโต้แย้งคำหลักผ่านทางและdef wrapper(*args, **kwargs): fn(*args, **kwargs)
martineau

5

คำตอบของเปาโลเบอร์กันติโนมีข้อได้เปรียบอย่างมากในการใช้ stdlib เท่านั้นและใช้งานได้กับตัวอย่างง่ายๆนี้ที่ไม่มีข้อโต้แย้งผู้ตกแต่งภายในหรือฟังก์ชั่นการตกแต่งที่ขัดแย้งกัน

อย่างไรก็ตามมีข้อ จำกัด ที่สำคัญ 3 ข้อหากคุณต้องการจัดการกรณีทั่วไปเพิ่มเติม:

  • ตามที่ระบุไว้แล้วในหลายคำตอบคุณไม่สามารถแก้ไขโค้ดเพื่อเพิ่มตัวเลือกข้อโต้แย้งมัณฑนากร ตัวอย่างเช่นการสร้างmakestyle(style='bold')มัณฑนากรนั้นไม่สำคัญ
  • นอกเหนือจากการห่อที่สร้างขึ้นด้วย@functools.wraps ไม่รักษาลายเซ็นTypeErrorดังนั้นหากข้อโต้แย้งที่ไม่ดีที่มีให้พวกเขาจะเริ่มดำเนินการและอาจจะเพิ่มชนิดที่แตกต่างของความผิดพลาดกว่าปกติ
  • ในที่สุดก็เป็นเรื่องยากมากในห่อที่สร้างขึ้นด้วย@functools.wrapsการเข้าถึงการโต้แย้งตามชื่อของมัน อันที่จริงข้อโต้แย้งสามารถปรากฏใน*args, ใน**kwargs, หรืออาจไม่ปรากฏเลย (ถ้ามันเป็นตัวเลือก)

ฉันเขียนdecopatchเพื่อแก้ปัญหาแรกและเขียนmakefun.wrapsเพื่อแก้ปัญหาอีกสองข้อ โปรดทราบว่าการmakefunใช้เล่ห์เหลี่ยมเดียวกันกับdecoratorlib ที่มีชื่อเสียง

นี่คือวิธีที่คุณจะสร้างมัณฑนากรที่มีข้อโต้แย้งส่งคืนห่อหุ้มลายเซ็นที่เก็บรักษาอย่างแท้จริง:

from decopatch import function_decorator, DECORATED
from makefun import wraps

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

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

    return wrapped

decopatchให้คุณมีสองรูปแบบการพัฒนาอื่น ๆ ที่ซ่อนหรือแสดงแนวคิดของหลามต่างๆขึ้นอยู่กับความต้องการของคุณ รูปแบบที่กะทัดรัดที่สุดคือ:

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

ในทั้งสองกรณีคุณสามารถตรวจสอบว่ามัณฑนากรทำงานได้ตามที่คาดไว้:

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

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

โปรดดูเอกสารประกอบสำหรับรายละเอียด

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.