17370845950

Python 如何让一个类自动注册到某个全局列表/字典中
__init_subclass__ 是最干净的子类自动注册方式,它在子类定义完成时触发,支持传参指定注册键名,无运行时开销,且不干扰继承链。

__init_subclass__ 实现子类自动注册

Python 3.6+ 提供的 __init_subclass__ 是最干净、最推荐的方式。它在每个子类定义完成时自动触发,无需修改父类实例化逻辑,也不依赖装饰器或手动调用。

常见错误是试图在 __new____init__ 中注册——那注册的是实例,不是类;而多数场景要的是“所有已定义的子类”(比如插件发现、序列化类型映射)。

  • 父类定义一次,所有未来继承它的类都会自动进注册表
  • 支持传参:比如 registry_name 字段可指定注册键名
  • 不干扰正常继承链,无运行时开销(只在类定义时执行)
REGISTRY = {}

class Plugin: def init_subclass(cls, name=None, **kwargs): super().init_subclass(**kwargs)

默认用类名,也可由子类显式指定

    key = name or cls.__name__
    REGISTRY[key] = cls

class Exporter(Plugin, name="csv"): pass

class Importer(Plugin): pass

print(REGISTRY) # {'csv': main.Exporter'>, 'Importer': main.Importer'>}

用类装饰器注册,适合已有类或需延迟控制

当不能修改基类(比如要注册第三方类),或需要条件性注册(如仅在调试模式*册),类装饰器更灵活。

注意:装饰器必须放在 class 语句上方,且返回原类(否则会替换类对象,可能破坏继承);常见坑是忘了 return cls 导致类变成 None

  • 装饰器内可加任意逻辑:检查属性、读配置、跳过测试类
  • 注册时机是模块导入时,和 __init_subclass__ 一致
  • 多个装饰器叠加时,确保注册逻辑在最外层或明确执行顺序
REGISTRY_BY_TYPE = {}

def register_type(type_key): def decorator(cls): REGISTRY_BY_TYPE[type_key] = cls return cls # 必须返回原类 return decorator

@register_type("json") class JsonHandler: pass

@register_type("xml") class XmlHandler: pass

避免用 __subclasses__() 动态扫描

MyBase.__subclasses__() 看似简单,但实际不可靠:它只返回当前已加载的直接子类,不递归,且依赖导入顺序和模块是否已被执行。

典型问题包括:单元测试中子类未导入 → 返回空列表;热重载时旧类残留;嵌套子类(A→B→C)中 C 不在 A 的 __subclasses__() 里。

  • 仅适合极简 PoC 或调试时临时查类,不要用于生产注册逻辑
  • 若真要用,得递归遍历 + 缓存 + 检查模块状态,复杂度远超直接注册
  • 无法支持别名、禁用类、版本区分等业务需求

注册字典的线程安全与模块隔离

全局注册表本质是模块级变量,多线程导入时 Python 的模块锁能保证类定义阶段安全;但如果你在多线程中动态新增类(如 JIT 编译场景),就得加锁。

更大的隐患是模块污染:不同包都用 R

EGISTRY = {},结果互相覆盖。解决方案很直接:

  • 把注册表封装进专用模块,如 myapp/plugins.py,统一 import 使用
  • 用函数返回注册表(带闭包),避免裸 dict 被意外重赋值
  • 注册键名加前缀,比如 f"{cls.__module__}.{cls.__name__}" 防冲突

真正容易被忽略的是:注册行为发生在模块导入期,而不是程序启动期。如果某个子类定义在条件 import 块里(如 if DEBUG:),它可能根本不会被注册——这点比语法细节更影响功能正确性。