python中`__annotations__` 和 `inspect` 模块区别??

__annotations__inspect 模块在 Python 中都与类型注解(type annotations)有关,但它们的作用范围和使用方式有显著区别。下面我们从多个维度来详细对比这两者。


🧩 一、__annotations__ 是什么?

__annotations__ 是 Python 中类、函数或模块对象的一个内置属性,用于存储类型注解。它是一个字典,其中键是变量名或参数名,值是类型对象。

示例:

python 复制代码
def func(a: int, b: str) -> bool:
    pass
print(func.__annotations__)
# 输出:{'a': <class 'int'>, 'b': <class 'str'>, 'return': <class 'bool'>}

对于类来说,__annotations__ 只包含类级别的变量注解,不包含方法参数或返回值的注解:

python 复制代码
class MyClass:
    x: int
    y: str = "hello"
    def method(self, a: float) -> bool:
        return True
print(MyClass.__annotations__)
# 输出:{'x': <class 'int'>, 'y': <class 'str'>}

🔍 二、inspect 模块是什么?

inspect 是 Python 标准库中的一个模块,用于动态检查对象的结构,包括类、函数、方法、模块等。它不仅可以获取类型注解,还能获取参数列表、默认值、源码、文档字符串等更丰富的信息。

常用功能:

  • inspect.signature():获取函数/方法的签名(包括参数名、默认值、类型注解等)
  • inspect.getmembers():列出对象的所有成员
  • inspect.isfunction() / inspect.ismethod():判断对象是否为函数或方法
  • inspect.getsource():获取源代码

示例:

python 复制代码
import inspect
def func(a: int, b: str = "hi") -> bool:
    return True
sig = inspect.signature(func)
print(sig)
# 输出:(a: int, b: str = 'hi') -> bool
for param in sig.parameters.values():
    print(param.name, ":", param.annotation)
# 输出:
# a : <class 'int'>
# b : <class 'str'>

🆚 三、核心区别对比

项目 __annotations__ inspect 模块
作用范围 只获取类型注解 可获取注解、参数、默认值、源码、文档等
内容丰富度 仅字典结构,仅包含注解 结构化对象,包含完整的函数/方法签名信息
适用对象 类、函数、模块 函数、方法、类、模块、帧对象等
获取方式 直接访问 obj.__annotations__ 通过 inspect.signature() 等函数获取
能否获取默认值 ❌ 不能 ✅ 可以
能否获取参数顺序 ❌ 不能 ✅ 可以
能否获取方法签名 ❌ 只能获取类变量注解 ✅ 可以,包括参数名、类型、默认值、返回值

🧪 四、实际使用场景建议

使用 __annotations__ 的场景:

  • 只需要类型注解,不关心参数顺序、默认值等。
  • 代码简单,不想引入额外的模块。
  • 在元类或装饰器中快速检查类变量类型。

使用 inspect 的场景:

  • 你需要完整的函数/方法签名,包括参数名、顺序、默认值、类型注解等。
  • 需要动态生成文档、进行参数校验、实现依赖注入等高级功能。
  • 需要分析对象结构,如列出所有方法、属性等。

✅ 五、总结

对比项 推荐使用
只需要类型注解 __annotations__
需要完整方法签名 inspect.signature()
需要参数顺序/默认值 inspect
需要动态分析对象 inspect
如果你只是想查看类型注解,__annotations__ 足够轻量;但如果你需要更深入的分析(如参数顺序、默认值、方法签名等),inspect 是更强大的选择。
相关推荐
水无痕simon1 分钟前
8 shiro的web整合
java
葡萄城技术团队1 分钟前
Excel 转在线协作难题破解:SpreadJS 纯前端表格控件的技术方案与实践
前端·excel
我的xiaodoujiao1 分钟前
Windows系统Web UI自动化测试学习系列3--浏览器驱动下载使用
前端·windows·测试工具·ui
一只小风华~3 分钟前
学习笔记:Vue Router 中的嵌套路由详解[特殊字符]概述
前端·javascript·vue.js
泻水置平地4 分钟前
若依前后端分离版实现前端国际化步骤
前端
Villiam_AY6 分钟前
从后端到react框架
前端·react.js·前端框架
CodeCraft Studio9 分钟前
全球知名的Java Web开发平台Vaadin上线慧都网
java·开发语言·前端·vaadin·java开发框架·java全栈开发·java ui 框架
一只小风华~16 分钟前
Vue Router 命名路由学习笔记
前端·javascript·vue.js·笔记·学习·ecmascript
我是华为OD~HR~栗栗呀20 分钟前
前端面经-高级开发(华为od)
java·前端·后端·python·华为od·华为·面试
木头左32 分钟前
跨周期共振效应在ETF网格参数适配中的应用技巧
开发语言·python·算法