python中使用装饰器为类增加logger属性和实现类型提示

使用过Java的都知道，使用Lombok+@Slf4j可以为类动态注入日志实例。

使用python该如何实现呢？

答案就是使用装饰器。

类装饰器

普通装饰器本质上就是一个函数，它接受函数作为参数，并返回新函数。

本文实现的是在一个类中动态添加属性，所以这里的实现可以称为类装饰器。既然是类装饰器，它要接受的参数就不是函数了，而是一个类。

然后，为这个类添加 logger 属性后，再将类返回。便完成了类装饰器的定义。

定义类装饰器

import logging

def log_decorator(cls):
    cls.logger = logging.getLogger(cls.__name__)
    return cls

使用类装饰器

@log_decorator
class FooService:
	
    def test(self):
        self.logger.info("This is a test log message.")

使用装饰器装饰后，就可以在类中的方法中使用logger属性了。

虽然使用是正常的，但是这里有个问题，就是没有类型提示。略显不完美，对代码可读性和开发体验不友好。

如何解决呢？

就是使用python类型注解。

增加类型提示

增加一条类型注解即可。

第3行是新增代码。

@log_decorator
class FooService:
    logger: logging.Logger
    
    def test(self):
	self.logger.info("This is a test log message.")

我承认了，标题略微有点标题党哈哈。

只使用装饰器是无法直接实现有类型提示功能的。如果要有类型提示，还是要手动处理一下的。略显麻烦，对于开发体验来讲，这点麻烦是值得的。