ฉันจะส่งอาร์กิวเมนต์พิเศษไปยังมัณฑนากร Python ได้อย่างไร


99

ฉันมีมัณฑนากรเช่นด้านล่าง

def myDecorator(test_func):
    return callSomeWrapper(test_func)
def callSomeWrapper(test_func):
    return test_func
@myDecorator
def someFunc():
    print 'hello'

ฉันต้องการปรับปรุงมัณฑนากรนี้ให้ยอมรับข้อโต้แย้งอื่นเช่นด้านล่าง

def myDecorator(test_func,logIt):
    if logIt:
        print "Calling Function: " + test_func.__name__
    return callSomeWrapper(test_func)
@myDecorator(False)
def someFunc():
    print 'Hello'

แต่รหัสนี้ให้ข้อผิดพลาด

TypeError: myDecorator () รับ 2 อาร์กิวเมนต์ (ให้ 1 ตัว)

เหตุใดฟังก์ชันจึงไม่ผ่านโดยอัตโนมัติ ฉันจะส่งฟังก์ชันนี้ไปยังฟังก์ชันมัณฑนากรอย่างชัดเจนได้อย่างไร


3
balki: โปรดหลีกเลี่ยงการใช้บูลีนเป็นอาร์กิวเมนต์ของคุณไม่ใช่แนวทาง gd และลดความสามารถในการอ่านโค้ด
Kit Ho

8
@KitHo - เป็นแฟล็กบูลีนดังนั้นการใช้ค่าบูลีนจึงเป็นแนวทางที่ถูกต้อง
AKX

2
@KitHo - "gd" คืออะไร? "ดี" หรือไม่?
Rob Bednark

คำตอบ:


172

เนื่องจากคุณเรียกมัณฑนากรว่าเป็นฟังก์ชันจึงจำเป็นต้องส่งคืนฟังก์ชันอื่นซึ่งเป็นมัณฑนากรตัวจริง:

def my_decorator(param):
    def actual_decorator(func):
        print("Decorating function {}, with parameter {}".format(func.__name__, param))
        return function_wrapper(func)  # assume we defined a wrapper somewhere
    return actual_decorator

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

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

def log_decorator(log_enabled):
    def actual_decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            if log_enabled:
                print("Calling Function: " + func.__name__)
            return func(*args, **kwargs)
        return wrapper
    return actual_decorator

การfunctools.wrapsโทรจะคัดลอกสิ่งต่างๆเช่นชื่อและสตริงไปยังฟังก์ชัน wrapper เพื่อให้คล้ายกับฟังก์ชันดั้งเดิมมากขึ้น

ตัวอย่างการใช้งาน:

>>> @log_decorator(True)
... def f(x):
...     return x+1
...
>>> f(4)
Calling Function: f
5

11
และfunctools.wrapsแนะนำให้ใช้ - มันยังคงชื่อเดิม docstring และอื่น ๆ ของฟังก์ชันที่ห่อไว้
AKX

@AKX: ขอบคุณฉันเพิ่มสิ่งนี้ในตัวอย่างที่สอง
interjay

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

2
@balki: ใช่ถูกต้อง สิ่งที่ทำให้สับสนคือหลายคนจะเรียกฟังก์ชันด้านนอก ( myDecoratorที่นี่) ว่ามัณฑนากร วิธีนี้สะดวกสำหรับผู้ใช้มัณฑนากร แต่อาจทำให้สับสนได้เมื่อคุณพยายามเขียน
interjay

1
รายละเอียดเล็ก ๆ น้อย ๆ ที่ทำให้ฉันสับสน: ถ้าคุณlog_decoratorใช้อาร์กิวเมนต์เริ่มต้นคุณจะใช้ไม่@log_decoratorได้ต้องเป็น@log_decorator()
Stardidi

46

เพียงเพื่อให้มุมมองที่แตกต่าง: ไวยากรณ์

@expr
def func(...): #stuff

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

def func(...): #stuff
func = expr(func)

โดยเฉพาะอย่างยิ่งexprสามารถเป็นอะไรก็ได้ที่คุณต้องการตราบเท่าที่ประเมินว่าสามารถโทรได้ ในโดยเฉพาะอย่างยิ่งโดยเฉพาะอย่างยิ่งexprสามารถเป็นโรงงานมัณฑนากร: คุณให้มันพารามิเตอร์บางและมันจะช่วยให้คุณมัณฑนากร ดังนั้นวิธีที่ดีกว่าในการทำความเข้าใจสถานการณ์ของคุณก็คือ

dec = decorator_factory(*args)
@dec
def func(...):

ซึ่งสามารถย่อเป็น

@decorator_factory(*args)
def func(...):

แน่นอนว่าเนื่องจากดูเหมือนว่าdecorator_factoryเป็นมัณฑนากรผู้คนจึงมักจะตั้งชื่อเพื่อสะท้อนถึงสิ่งนั้น ซึ่งอาจสร้างความสับสนเมื่อคุณพยายามทำตามระดับของทิศทาง


ขอบคุณสิ่งนี้ช่วยให้ฉันเข้าใจเหตุผลเบื้องหลังสิ่งที่เกิดขึ้น
Aditya Sriram

26

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

import functools

def myDecorator(test_func=None,logIt=None):
    if not test_func:
        return functools.partial(myDecorator, logIt=logIt)
    @functools.wraps(test_func)
    def f(*args, **kwargs):
        if logIt==1:
            print 'Logging level 1 for {}'.format(test_func.__name__)
        if logIt==2:
            print 'Logging level 2 for {}'.format(test_func.__name__)
        return test_func(*args, **kwargs)
    return f

#new decorator 
myDecorator_2 = myDecorator(logIt=2)

@myDecorator(logIt=2)
def pow2(i):
    return i**2

@myDecorator
def pow3(i):
    return i**3

@myDecorator_2
def pow4(i):
    return i**4

print pow2(2)
print pow3(2)
print pow4(2)

16

อีกวิธีหนึ่งในการทำมัณฑนากร ฉันคิดว่าวิธีนี้ง่ายที่สุดในการพันศีรษะ

class NiceDecorator:
    def __init__(self, param_foo='a', param_bar='b'):
        self.param_foo = param_foo
        self.param_bar = param_bar

    def __call__(self, func):
        def my_logic(*args, **kwargs):
            # whatever logic your decorator is supposed to implement goes in here
            print('pre action baz')
            print(self.param_bar)
            # including the call to the decorated function (if you want to do that)
            result = func(*args, **kwargs)
            print('post action beep')
            return result

        return my_logic

# usage example from here on
@NiceDecorator(param_bar='baaar')
def example():
    print('example yay')


example()

ขอบคุณ! มองไปที่ "วิธีแก้ปัญหา" ที่ทำให้ใจคิดเป็นเวลาประมาณ 30 นาทีและนี่เป็นวิธีแรกที่สมเหตุสมผลจริงๆ
canhazbits

0

ตอนนี้ถ้าคุณต้องการเรียกใช้ฟังก์ชันfunction1ด้วยมัณฑนากรdecorator_with_argและในกรณีนี้ทั้งฟังก์ชันและมัณฑนากรจะใช้อาร์กิวเมนต์

def function1(a, b):
    print (a, b)

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