终于解决了使用Python装饰器中的一个痛点,


 前言

如何给装饰器的参数传参,这个问题曾经困扰我好久,虽然Python版本的更新,现在这个问题终于解决了,特此记录。

疑问

首先我有一个这样的装饰器文件路径helper/log_helper.py

  1. import traceback 
  2. from functools import wraps 
  3.  
  4. from loguru import logger 
  5.  
  6.  
  7. def my_logger(count): 
  8.     def step1(foo): 
  9.         @wraps(foo) 
  10.         def step2(*args, **kwargs): 
  11.             try: 
  12.                 result = foo(*args, **kwargs) 
  13.                 logger.info(f"{result=},{count=}") 
  14.             except Exception: 
  15.                 logger.exception(traceback.format_exc()) 
  16.  
  17.         return step2 
  18.  
  19.     return step1 

然后我有个文件需要引用这个装饰器demo.py

  1. from helper.log_helper import my_logger 
  2.  
  3.  
  4. class Demo: 
  5.     @my_logger(count=2) 
  6.     def main(self): 
  7.         return "in main function" 
  8.  
  9.  
  10. if __name__ == '__main__': 
  11.     d = Demo() 
  12.     d.main() 

输出结果如下

  1. 2020-10-16 11:43:12.001 | INFO     | helper.log_helper:step2:18 - result='in main function',count=2 

这个装饰器的作用很简单,就是获取当前函数的返回值,和传入的count值。

好,现在问题来了?

如果给装饰器的参数传值呢,也就是说我的count=2,是通过传值的形式。你想到可能是这样

  1. from helper.log_helper import my_logger 
  2.  
  3. COUNT=2 
  4. class Demo: 
  5.     @my_logger(count=COUNT) 
  6.     def main(self): 
  7.         return "in main function" 
  8.  
  9.  
  10. if __name__ == '__main__': 
  11.     d = Demo() 
  12.     d.main() 

ok,这样确实可以,我们还可以使用再简化一步

  1. from functools import partial 
  2. from helper.log_helper import my_logger 
  3.  
  4. COUNT=2 
  5. my_logger = partial(my_logger,count=2) 
  6.  
  7.  
  8. class Demo: 
  9.     @my_logger() 
  10.     def main(self): 
  11.         return "in main function" 
  12.  
  13.  
  14. if __name__ == '__main__': 
  15.     d = Demo() 
  16.     d.main() 

暂时来看我们搞定了传参数的问题,这时候我们想如果外界调用了Demo类的main方法,并且向指定count的值怎么办呢?

我们知道外界调用Demo类传参的唯一途径就是向__init__里进行传参数,按照这个思路我们只能这么写了,

  1. class Demo: 
  2.     def __init__(self): 
  3.         count =2 
  4.     @my_logger(count=self.count) 
  5.     def main(self): 
  6.         return "in main function" 

但是这样并不可以,我们得到错误信息

  1. NameError: name 'self' is not defined 

在装饰器中无法使用self.形式的参数,难道这个问题解决不了么?

问题解决

在Python3.7之前确实没什么可行的方案。

我们知道在Python3.7的时候引入了dataclasses,我们可以通过它来简化__init__。

改下我们的代码

  1. from functools import partial 
  2.  
  3. from helper.log_helper import my_logger 
  4. from dataclasses import dataclass 
  5.  
  6. @dataclass() 
  7. class Demo: 
  8.     count: int = 2 
  9.     logger: my_logger = partial(my_logger, count) 
  10.  
  11.     @logger() 
  12.     def main(self): 
  13.         return "in main function" 
  14.  
  15.  
  16. if __name__ == '__main__': 
  17.     d = Demo() 
  18.     d.main() 

如果使用Python3.8那么可以直接忽略掉dataclass

  1. class Demo: 
  2.     count: int = 2 
  3.     logger: my_logger = partial(my_logger, count) 
  4.  
  5.     @logger() 
  6.     def main(self): 
  7.         return "in main function" 

这样我们就成功的解决了这个问题,突然想起来之前遇到的这个难题,现在算是解决了,希望对你有帮助。

评论关闭