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

Python 怎样读取属性定义而不触发 property

来源:17golang原创

时间:2026-11-16 23:09:14 299浏览 收藏

如果你在做对象元数据扫描,直接写 getattr(obj, "price") 可能已经触发了 property 的计算,甚至执行了自定义的 __getattribute__ 或 __getattr__。想先看“这个名字在类上到底定义了什么”,可以使用 inspect.getattr_static(obj, name)。

官方地址:https://docs.python.org/3/library/inspect.html#inspect.getattr_static

结论:getattr_static 返回的是静态属性定义,不主动触发描述符协议、__getattr__ 或 __getattribute__。因此读取到 property 时,拿到的通常是 property 对象本身,而不是 getter 的结果。

先看直接访问为什么会产生副作用

下面的类把 getter 写成了带计数的计算。这个例子只用于观察两种读取方式的差异,实际项目中也可能是数据库查询、懒加载或日志记录。

class Product:
    reads = 0

    def __init__(self, price):
        self._price = price

    @property
    def price(self):
        # getter 每被访问一次就增加计数,模拟一次有副作用的计算
        Product.reads += 1
        return self._price

item = Product(199)
value = getattr(item, "price")
print(value, Product.reads)

这里的 getattr 遵循 Python 的普通属性查找规则,发现 price 是描述符后会调用它的 getter。做文档生成、字段枚举或调试面板时,这种“为了看定义而执行逻辑”的行为通常不是目标。

Python 普通属性查找与静态属性查找的边界说明图
图1:普通查找会进入描述符协议,静态查找保留类属性定义;这是结构说明图,不是运行截图。

用 getattr_static 取得 property 定义

把读取入口换成 inspect.getattr_static 后,返回值不再是 199,而是定义在 Product 上的 property 对象。可以先判断类型,再决定是否需要在明确允许的情况下读取 getter。

import inspect

class Product:
    def __init__(self, price):
        self._price = price

    @property
    def price(self):
        # 这里的计算只有在业务明确读取属性值时才应发生
        return self._price

item = Product(199)
definition = inspect.getattr_static(item, "price")

if isinstance(definition, property):
    # 静态检查阶段只记录 getter 是否存在,不执行 getter
    print("这是 property,存在 getter:", definition.fget is not None)
else:
    # 普通字段可以直接记录其定义对象
    print("静态定义:", definition)

官方文档说明,这个函数不会触发描述符协议、__getattr__ 或 __getattribute__。这正是它适合做“先看定义、后决定动作”的原因。

三种读取方式的结果不是一回事

可以把它们按“是否执行动态查找”来区分:

写法更接近什么适合场景
obj.name完整的普通属性访问业务代码真正需要属性值
getattr(obj, "name")带字符串名字的普通访问允许 getter 或动态属性参与
inspect.getattr_static(obj, "name")不触发动态查找的定义观察元数据扫描、诊断和字段分类

第三种方式的“静态”不是说它一定返回一个简单值,而是说它不会主动把描述符转换成实例值。对 property、槽位属性或 C 扩展暴露的描述符,返回对象可能仍然需要进一步识别。

Python getattr_static 返回 property、普通字段和动态属性的类型关系说明图
图2:静态读取的返回对象分类,展示 property、普通字段和动态属性的边界;这是结构说明图,不是运行截图。

动态属性与默认值要单独处理

getattr_static 不会调用 __getattr__,所以一个只在运行时生成的名字可能被视为不存在。可以传入默认值区分“没有静态定义”和“静态定义就是 None”。

import inspect

class Config:
    timeout = None

    def __getattr__(self, name):
        # 动态属性只在普通访问时生成,静态读取不会进入这里
        if name.startswith("env_"):
            return "from-environment"
        raise AttributeError(name)

missing = object()
config = Config()

timeout_def = inspect.getattr_static(config, "timeout", missing)
env_def = inspect.getattr_static(config, "env_timeout", missing)
print(timeout_def is None, env_def is missing)

这里 timeout 有明确的类定义,因此静态读取结果就是 None;env_timeout 只有在普通访问时才可能出现,静态读取会返回我们传入的哨兵对象。不要因为静态读取不到就断言对象“永远没有”这个属性。

槽位描述符和最终使用建议

带 __slots__ 的类也可能让静态读取返回描述符,而不是你以为的实例值。处理元数据时,推荐固定成下面的顺序:

  1. 先用 inspect.getattr_static 取定义对象,避免扫描阶段触发代码。
  2. 用 isinstance(value, property) 或描述符检查判断它属于哪一类。
  3. 只有业务明确需要真实值,且已经接受 getter 副作用时,才使用 getattr。
  4. 对动态属性、槽位描述符和 C 扩展对象保留“可能无法静态取全”的处理分支。

一句话记忆:getattr 问的是“访问这个名字会得到什么”,getattr_static 问的是“这个名字在当前对象结构里定义成了什么”。做检查工具时先问后者,能把副作用留在可控边界内。

相关问题

getattr_static 能拿到动态生成的属性吗?

不能保证。它不会调用 __getattr__ 或 __getattribute__,因此只能看到静态查找路径上已经存在的定义。

为什么返回的不是 property 的计算结果?

因为它刻意不触发描述符协议。返回 property 对象后,可以读取其 getter 是否存在,但是否执行 getter 应由调用方明确决定。

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