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 函数 | 走无注解或兼容旧语义的分支 |

在元类中取得注解函数
最实用的场景是元类在调用 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()。不要把“收集注解”和“执行注解”混成一个不可控的步骤。

处理字符串注解和类创建后的访问
如果代码使用 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
-
369 收藏
-
344 收藏
-
464 收藏
-
327 收藏
-
349 收藏
-
143 收藏
-
文章 · python教程 | 25分钟前 | 标准库 · HTTP服务 · 多线程 · Python教程 · Python 并发请求 http.server ThreadingHTTPServer ThreadingMixIn BaseHTTPRequestHandler481 收藏
-
308 收藏
-
232 收藏
-
文章 · python教程 | 32分钟前 | 标准库 · 异步编程 · Python教程 · Python asyncio StreamReader readexactly IncompleteReadError 异步流427 收藏
-
336 收藏
-
文章 · python教程 | 51分钟前 | 标准库 · Python教程 · Python warnings catch_warnings simplefilter filterwarnings 警告过滤255 收藏
-
120 收藏
-
文章 · python教程 | 1小时前 | 标准库 · Python教程 · Python 类型注解 Python 3.14 annotationlib get_annotations ForwardRef 延迟注解423 收藏
-
157 收藏
-
151 收藏
-
248 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习