登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  文章 >  python教程

Python annotationlib.get_annotate_from_class_namespace 怎样取得注解函数

来源:17golang原创

时间:2026-11-20 12:56:34 235浏览 收藏

在 Python 3.14 的类还没有创建完成时,如果元类需要读取类体里的注解,应该把类命名空间字典交给 annotationlib.get_annotate_from_class_namespace()。它会返回编译器放进命名空间的注解函数;如果当前命名空间没有这样的函数,就返回 None。拿到函数后,再用 call_annotate_function() 选择 Format.FORWARDREF 等格式读取注解。

官方文档:https://docs.python.org/3.14/library/annotationlib.html

记住一个边界:类创建前看 namespace,类创建后看 cls.__annotate__;不要把已经创建的类对象传给 get_annotate_from_class_namespace()。
  • 类体没有注解函数时,返回值是 None,这不是异常。
  • 编译器生成的 annotate 函数直接调用通常只适合 VALUE,需要 FORWARDREF 或 STRING 时使用 call_annotate_function()。
  • 注解可能触发求值或执行代码,扫描不可信对象时不要无条件执行它。

先分清 namespace、annotate 和 __annotations__

get_annotate_from_class_namespace(namespace) 接收的是元类 __new__ 或 __prepare__ 阶段拿到的类命名空间字典。Python 3.14 的延迟注解模型可能在其中放入 __annotate__,这个值就是稍后计算注解的函数。

对象或入口处于哪个阶段应该怎么处理
namespace类尚未创建完成传给 get_annotate_from_class_namespace()
namespace["__annotations__"]字符串注解或已有注解字典直接读取字典,并保留字符串语义
cls.__annotate__类已经创建直接取得类的注解函数
None当前 namespace 没有 annotate 函数走无注解或兼容旧语义的分支
annotationlib 类命名空间、__annotate__ 键、注解函数和 None 返回值的静态关系说明图
图1:结构说明图,查看类命名空间中 __annotate__ 与返回值的边界;这不是截图或运行证据。

在元类中取得注解函数

最实用的场景是元类在调用 type.__new__() 之前检查类体。下面的示例先取得 annotate 函数;存在时用 call_annotate_function() 读取 FORWARDREF,这样尚未解析的类名会保留为 ForwardRef,不会因为扫描时机太早而直接失败。

import annotationlib


class AnnotationMeta(type):
    def __new__(mcls, name, bases, namespace):
        # 类还没创建完成,先从原始命名空间取得注解函数
        annotate = annotationlib.get_annotate_from_class_namespace(namespace)

        if annotate is None:
            # 没有编译器生成的函数时,兼容已有的注解字典
            annotations = dict(namespace.get("__annotations__", {}))
        else:
            # 通过辅助函数选择格式,避免直接调用只支持 VALUE 的函数
            annotations = annotationlib.call_annotate_function(
                annotate,
                format=annotationlib.Format.FORWARDREF,
            )

        # 保存副本,避免后续修改原始 namespace 的注解状态
        namespace["__declared_annotations__"] = annotations
        return super().__new__(mcls, name, bases, namespace)


class User(metaclass=AnnotationMeta):
    user_id: int
    manager: "User"

这里的关键是调用时机:namespace 仍是类体的原始字典,User 这个类对象还不存在,所以不能用 User.__annotate__。FORWARDREF 让 manager 这类自引用保持可检查的代理值,元类可以先记录它,等类型环境完整后再决定是否调用 evaluate()。

为什么优先选择 FORWARDREF

默认的 Format.VALUE 会尝试把注解表达式变成运行时对象。如果表达式中有尚未绑定的名称,读取可能抛出 NameError。这在类创建阶段很常见:类名、自定义字段类型或插件类型可能还没有进入可用作用域。

import annotationlib


class SchemaMeta(type):
    def __new__(mcls, name, bases, namespace):
        # 在类创建前拿到原始 annotate 函数
        annotate = annotationlib.get_annotate_from_class_namespace(namespace)
        if annotate is None:
            return super().__new__(mcls, name, bases, namespace)

        # FORWARDREF 保留暂时无法解析的名称,适合元类扫描
        annotations = annotationlib.call_annotate_function(
            annotate,
            format=annotationlib.Format.FORWARDREF,
        )
        for field_name, field_type in annotations.items():
            if isinstance(field_type, annotationlib.ForwardRef):
                # 记录表达式文本,不在类创建阶段强行求值
                print(field_name, field_type.__forward_arg__)

        return super().__new__(mcls, name, bases, namespace)


class Order(metaclass=SchemaMeta):
    customer: "Customer"

ForwardRef.__forward_arg__ 可以提供待解析的表达式文本。它适合做字段登记、依赖收集和延后解析;如果后续确实拥有正确的作用域,再调用 evaluate()。不要把“收集注解”和“执行注解”混成一个不可控的步骤。

元类、annotate 函数、call_annotate_function、Format.FORWARDREF 与 ForwardRef 的静态关系说明图
图2:结构说明图,查看元类调用 annotate 与类创建后访问 __annotate__ 的边界;不代表某次命令输出。

处理字符串注解和类创建后的访问

如果代码使用 from __future__ import annotations,类命名空间里可能已经有 __annotations__ 字典,里面的值是字符串。这时可以按兼容策略直接复制该字典;不要把它误认为 get_annotate_from_class_namespace() 必须返回的结果。

from __future__ import annotations

import annotationlib


class FutureAwareMeta(type):
    def __new__(mcls, name, bases, namespace):
        # 字符串化注解已有字典,先保留原始文本
        if "__annotations__" in namespace:
            declared = dict(namespace["__annotations__"])
        else:
            # 其他注解语义再尝试取得编译器生成的函数
            annotate = annotationlib.get_annotate_from_class_namespace(namespace)
            declared = (
                annotationlib.call_annotate_function(
                    annotate,
                    format=annotationlib.Format.STRING,
                )
                if annotate is not None
                else {}
            )

        namespace["__declared_annotations__"] = declared
        return super().__new__(mcls, name, bases, namespace)


class Product(metaclass=FutureAwareMeta):
    sku: str

类创建完成后,入口就变成 Product.__annotate__,不再需要把 Product.__dict__ 当成类创建前的 namespace 传入。需要显示文本时可使用 Format.STRING;需要真实对象时再谨慎选择 Format.VALUE,并确认注解来源可信,因为求值可能执行任意代码。

常见问题

没有注解的类为什么返回 None?

这是正常结果。该函数只负责从类命名空间找注解函数,不负责为没有注解的类创建一个空函数。元类把 None 当成无注解分支即可。

为什么不直接调用 annotate?

编译器生成的 annotate 函数直接调用通常只覆盖 VALUE。如果要拿 FORWARDREF 或 STRING,应该交给 call_annotate_function() 选择格式并处理特殊环境。

类创建后还能用这个函数吗?

不应把已创建的类对象当作 namespace 传入。创建前在元类中处理原始字典,创建后从 cls.__annotate__ 取得函数;如果只是读取完整注解字典,也可以按场景使用 annotationlib.get_annotations(cls)。

参考资料

Python 3.14 annotationlib:https://docs.python.org/3.14/library/annotationlib.html

Python 3.14 新特性:https://docs.python.org/3.14/whatsnew/3.14.html

Python 注解最佳实践:https://docs.python.org/3.14/howto/annotations.html

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>