python - 使用装饰器作为类来装饰 Python 类
问题描述
需要一些帮助来实现/理解装饰器作为一个类在 Python 中是如何工作的。我发现的大多数示例要么是装饰一个类,但作为一个函数实现,要么是作为一个类实现,但装饰一个函数。我的目标是创建作为类和装饰类实现的装饰器。
更具体地说,我想创建一个@Logger
装饰器并在我的一些课程中使用它。这个装饰器所做的只是self.logger
在类中注入一个属性,所以每次我用它来装饰一个类时,@Logger
我都可以self.logger.debug()
在它的方法中使用它。
一些初步的问题:
- 装饰器
__init__
接收什么作为参数?我将只接收装饰类和一些最终的装饰器参数,这实际上是大多数情况下发生的情况,但请查看下面的输出DOMElementFeatureExtractor
。为什么它会收到所有这些参数? __call__
方法呢?它会收到什么?- 如何为装饰器 (
@Logger(x='y')
) 提供参数?它会传递给__init__
方法吗? - 我真的应该在
__call__
方法中返回类的实例吗?(只有这样我才能让它工作) - 链接装饰器呢?如果之前的装饰器已经返回了该类的一个实例,那将如何工作?为了能够做到,我应该在下面的示例中修复什么
@Logger @Counter MyClass:
?
请看一下这个示例代码。我创建了一些虚拟示例,但最后你可以看到我真实项目中的一些代码。
你可以在最后找到输出。
任何有助于理解作为类实现的 Python 类装饰器将不胜感激。
谢谢
from abc import ABC, abstractmethod
class ConsoleLogger:
def __init__(self):
pass
def info(self, message):
print(f'INFO {message}')
def warning(self, message):
print(f'WARNING {message}')
def error(self, message):
print(f'ERROR {message}')
def debug(self, message):
print(f'DEBUG {message}')
class Logger(object):
""" Logger decorator, adds a 'logger' attribute to the class """
def __init__(self, cls, *args, **kwargs):
print(cls, *args, **kwargs)
self.cls = cls
def __call__(self, *args, **kwargs):
print(self.cls.__name__)
logger = ConsoleLogger()
setattr(self.cls, 'logger', logger)
return self.cls(*args, **kwargs)
class Counter(object):
""" Counter decorator, counts how many times a class has been instantiated """
count = 0
def __init__(self, cls, *args, **kwargs):
self.cls = cls
def __call__(self, *args, **kwargs):
count += 1
print(f'Class {self.cls} has been initialized {count} times')
return self.cls(*args, **kwargs)
@Logger
class A:
""" Simple class, no inheritance, no arguments in the constructor """
def __init__(self):
self.logger.info('Class A __init__()')
class B:
""" Parent class for B1 """
def __init__(self):
pass
@Logger
class B1(B):
""" Child class, still no arguments in the constructor """
def __init__(self):
super().__init__()
self.logger.info('Class B1 __init__()')
class C(ABC):
""" Abstract class """
def __init__(self):
super().__init__()
@abstractmethod
def do_something(self):
pass
@Logger
class C1(C):
""" Concrete class, implements C """
def __init__(self):
self.logger.info('Class C1 __init__()')
def do_something(self):
self.logger.info('something')
@Logger
class D:
""" Class receives parameter on intantiation """
def __init__(self, color):
self.color = color
self.logger.info('Class D __init__()')
self.logger.debug(f'color = {color}')
class AbstractGenerator(ABC):
def __init__(self):
super().__init__()
self.items = None
self.next_item = None
@abstractmethod
def __iter__(self):
pass
def __next__(self):
pass
def __len__(self):
pass
def __getitem__(self, key):
pass
class AbstractDOMElementExtractor(AbstractGenerator):
def __init__(self, parameters, content):
super().__init__()
self.parameters = parameters
self.content = content
@Logger
class DOMElementExtractor(AbstractDOMElementExtractor):
def __init__(self, parameters, content):
super().__init__(parameters, content)
def __iter__(self):
self.logger.debug('__iter__')
def __next__(self):
self.logger.debug('__next__')
def __len__(self):
self.logger.debug('__len__')
def __getitem__(self, key):
self.logger.debug('__getitem__')
class DOMElementFeatureExtractor(DOMElementExtractor):
def __init__(self, parameters, content):
super().__init__(parameters, content)
class DocumentProcessor:
def __init__(self):
self.dom_element_extractor = DOMElementExtractor(parameters={}, content='')
def process(self):
self.dom_element_extractor.__iter__()
a = A()
b1 = B1()
c1 = C1()
c1.do_something()
d = D(color='Blue')
document_processor = DocumentProcessor()
document_processor.process()
输出:
<class '__main__.A'>
<class '__main__.B1'>
<class '__main__.C1'>
<class '__main__.D'>
<class '__main__.DOMElementExtractor'>
DOMElementFeatureExtractor (<__main__.Logger object at 0x7fae27c26400>,) {'__module__': '__main__', '__qualname__': 'DOMElementFeatureExtractor', '__init__': <function DOMElementFeatureExtractor.__init__ at 0x7fae27c25840>, '__classcell__': <cell at 0x7fae27cf09d8: empty>}
A
INFO Class A __init__()
B1
INFO Class B1 __init__()
C1
INFO Class C1 __init__()
INFO something
D
INFO Class D __init__()
DEBUG color = Blue
DOMElementExtractor
DEBUG __iter__
解决方案
不会是一个完整的答案,但我认为复习装饰器的基础知识会很有帮助。这是装饰的样子:
@Logger
class A:
# A's code
根据定义,它相当于这样做:
class A
# A's code
A = Logger(A) # Logger has to be callable because...it's called
消息来源经常说装饰器“修改”,但这实际上只是预期用途。从技术上讲,您所需要的只是A
定义(如函数、方法或类)并Logger
可以调用。如果Logger
返回"Hello, World"
,那就是这样A
。
好吧,让我们假装我们没有装饰A
一下,想想Logger(A)
“修改”需要什么。嗯,A
是一个类,你调用一个类来创建实例:A(*args)
. 因此,Logger(A)(*args)
也必须是 的实例A
。但Logger(A)
不是类A
,它是一个实例Logger
。__call__
幸运的是,您可以通过在其类中定义方法来使实例可调用。Logger
的__call__
方法调用存储在其cls
属性中的类并返回实例。
至于装饰器中的参数,考虑它的等价物也很有帮助。你有兴趣这样做:
@Logger(x='y')
class A:
# A code
所以它等价于:
class A:
# A code
A = Logger(x = 'y')(A)
请注意,Logger
它本身并没有作为A
论据。它'y'
作为参数并返回另一个作为参数的可调用对象A
。所以如果Logger
是一个类,Logger(x = 'y')
将是一个Logger
实例。如果类有__call__
方法,类的实例也可以用作装饰器!
推荐阅读
- qt - Why expanding in QTreeView may work incorrectly?
- mongodb - Create MongoDB External View using SparkSQL Only
- crash - How to check if @EnvironmentObject is set? (SwiftUI)
- windows - GNU make directory listing using $(shell dir ) command
- jinja2 - Access Pelican page and article metadata the same way?
- javascript - 使用 Enter 键(包括 select2)在元素之间切换
- html - 如何在表单字段下定位地图 div?
- elixir - 将 Ecto 片段提取到变量中
- shared-libraries - Blazor 共享组件未呈现
- mongodb - Mongoose 模型数据深于 1 级