如何在 Python 中自动发现并收集被特定装饰器修饰的类

星强同学_7016

星强同学_7016

2026-10-23

248人浏览

原创

如何在 Python 中自动发现并收集被特定装饰器修饰的类

Python 本身不提供运行时反射式查找“被某装饰器修饰的类”的内置机制,但可通过装饰器自维护注册表实现类似 Spring Boot @ComponentScan 的自动发现能力。核心思路是让装饰器在修饰时主动记录目标对象。

python 本身不提供运行时反射式查找“被某装饰器修饰的类”的内置机制,但可通过装饰器自维护注册表实现类似 spring boot `@componentscan` 的自动发现能力。核心思路是让装饰器在修饰时主动记录目标对象。

在 Python 中,装饰器本质上是函数调用(如 @workflow.defn 等价于 workflow.defn(cls)),而非元数据标签。这意味着:装饰器执行后,原始对象可能已被替换(如返回 wrapper),且标准 inspect 模块无法回溯“谁被哪个装饰器处理过”——正如你在 kafka_listener 函数中观察到的:__dict__、__annotations__ 等均不保留装饰器参数信息,因为装饰器逻辑若未显式保存上下文,该信息即告丢失。

✅ 正确解法不是“事后扫描”,而是事前注册:改造装饰器,使其在应用时主动将被修饰对象(类或函数)添加到一个全局或模块级注册表中。

以下是一个生产就绪的注册式装饰器实现示例:

# registry.py
from typing import List, Type, Callable, Any

# 全局注册表:按装饰器类型分组
_REGISTERED_CLASSES: dict[str, List[Type]] = {}
_REGISTERED_FUNCTIONS: dict[str, List[Callable]] = {}

def register_by_name(name: str):
    """工厂装饰器:为指定名称创建可注册的类装饰器"""
    def decorator(cls: Type) -> Type:
        if name not in _REGISTERED_CLASSES:
            _REGISTERED_CLASSES[name] = []
        _REGISTERED_CLASSES[name].append(cls)
        return cls
    return decorator

def get_registered_classes(name: str) -> List[Type]:
    """获取指定名称下所有已注册的类"""
    return _REGISTERED_CLASSES.get(name, []).copy()

# 使用示例
@register_by_name("workflow.defn")
class PaymentWorkflow:
    pass

@register_by_name("activity.defn")
class ValidateCardActivity:
    pass

# 启动时自动注册到 Temporal Worker
if __name__ == "__main__":
    workflows = get_registered_classes("workflow.defn")
    activities = get_registered_classes("activity.defn")
    print(f"Found workflows: {[w.__name__ for w in workflows]}")   # ['PaymentWorkflow']
    print(f"Found activities: {[a.__name__ for a in activities]}") # ['ValidateCardActivity']

? 对函数装饰器(如 @kafka_listener(topic="foo"))同样适用:

python学习
python学习

Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

下载
def kafka_listener(topic: str):
    def decorator(func: Callable) -> Callable:
        # 注册函数及其配置
        key = f"kafka_listener.{topic}"
        if key not in _REGISTERED_FUNCTIONS:
            _REGISTERED_FUNCTIONS[key] = []
        _REGISTERED_FUNCTIONS[key].append(func)
        return func
    return decorator

@kafka_listener(topic="user_events")
def handle_user_event(record):
    print("Handling:", record)

⚠️ 注意事项:

  • 装饰器必须是“有状态”的:需显式维护注册列表(推荐使用模块级变量或单例管理器,避免闭包导致的多实例隔离问题);
  • 导入顺序影响注册时机:确保所有被装饰的模块在调用 get_registered_*() 前已被导入(可借助 pkgutil.iter_modules 自动导入子包);
  • 避免重复注册:可在装饰器内增加 if cls not in lst: 判断(注意 is 或 == 语义);
  • 不适用于第三方装饰器:若无法修改 workflow.defn 源码,则无法注入注册逻辑——此时需结合 AST 静态分析(复杂,不推荐用于常规场景)。

总结:Python 的装饰器是“主动行为”而非“被动标记”。要实现自动发现,关键在于让装饰器承担注册职责,而非依赖运行时反射。这种模式简洁、高效、可控,也是 FastAPI、SQLModel、Temporal Python SDK 等主流框架的实际采用方案。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1791

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4684

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1749

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

27737

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3347

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3347

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2603

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习