自动发现 python 装饰器

Question

我想知道是否有一种标准化的方法或最佳实践来扫描/自动发现装饰器，就像它在 here 以及在 Django、Flask 等其他几个库中所做的那样。通常，装饰器在调用内部函数时立即提供额外/包装的功能。

在下面显示的示例中，以及在 Flask/Django（路由装饰器）中，装饰器用于添加总体功能，例如最初在装饰器逻辑中生成 tcp 客户端，然后在收到消息来处理它时调用内部 func。

Flask/ Django 注册一个 url 路由，其中​​内部函数仅在稍后请求 url 时调用。所有示例都需要对装饰器逻辑进行初始注册（扫描/发现），以便初始启动总体功能。对我来说，这似乎是装饰器的另一种用法，如果有的话，我想了解最佳实践方法。

参见下面的Faust 示例，其中装饰器 app.agent() 在异步事件循环中自动触发侦听（kafka 流）客户端，然后传入消息由内部函数 hello() 处理 稍后，仅当存在是收到的消息，需要在脚本开始时首先对相关装饰器逻辑进行初始检查/扫描/发现。

import faust

class Greeting(faust.Record):
    from_name: str
    to_name: str

app = faust.App('hello-app', broker='kafka://localhost')
topic = app.topic('hello-topic', value_type=Greeting)

@app.agent(topic)
async def hello(greetings):
    async for greeting in greetings:
        print(f'Hello from {greeting.from_name} to {greeting.to_name}')

@app.timer(interval=1.0)
async def example_sender(app):
    await hello.send(
        value=Greeting(from_name='Faust', to_name='you'),
    )

if __name__ == '__main__':
    app.main()

Answer 1

没有“发现”。当您 import 包中的模块时，所有代码都会被执行。这就是为什么我们有if __name__ == '__main__' 来阻止某些代码在导入时执行。当您运行代码时，装饰器将被“发现”。

我认为Flask blueprint 是一个很好的例子。 Here 您可以在导入模块时看到它是如何注册 url 端点的。它所做的只是附加到一个列表中：

    def route(self, rule, **options):
        """Like :meth:`Flask.route` but for a blueprint.  The endpoint for the
        :func:`url_for` function is prefixed with the name of the blueprint.
        """
        def decorator(f):
            endpoint = options.pop("endpoint", f.__name__)
            self.add_url_rule(rule, endpoint, f, **options)
            return f
        return decorator

代码运行，装饰器被评估，它们只需要保留一些它们装饰的所有函数的内部列表。这些存储在Blueprint 对象中。