讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在 attrs 类中正确声明和使用类变量

风芳同学_9885

风芳同学_9885

发布时间:2026-08-16 09:37:05

|

327人浏览过

|

来源于php中文网

原创

如何在 attrs 类中正确声明和使用类变量

attrs 库会自动忽略 typing.ClassVar 注解的字段,因此不能直接通过注解定义类变量;需采用继承混入类或类创建后动态赋值的方式实现。

`attrs` 库会自动忽略 `typing.classvar` 注解的字段,因此不能直接通过注解定义类变量;需采用继承混入类或类创建后动态赋值的方式实现。

attrs 以简洁优雅的方式将类型注解转化为实例字段(即 __init__ 参数与实例属性),但其设计原则明确:所有被 @define 处理的字段均为实例级(instance-level)。这意味着 typing.ClassVar[T] 注解(如 my_class_var: ClassVar[str])会被 attrs 主动跳过——既不参与初始化,也不生成实例属性,更不会自动挂载为类属性。这并非 bug,而是有意为之的设计取舍:attrs 专注实例数据管理,类变量应由 Python 原生机制承担。

✅ 正确添加类变量的两种推荐方式

方式一:通过混入(Mixin)类继承

将类变量定义在独立的基类中,再让 @define 类继承它。这种方式语义清晰、易于复用,且支持 IDE 类型推导(若配合 __class_getitem__ 或 typing.ClassVar 在基类中显式标注):

from attrs import define, field

class ConfigMixin:
    DEFAULT_ROLE: str = "user"
    MAX_ATTEMPTS: int = 3

@define
class User(ConfigMixin):
    username: str = field()
    email: str = field()

# 使用示例
u = User("alice", "alice@example.com")
print(u.DEFAULT_ROLE)      # → "user"
print(User.DEFAULT_ROLE)   # → "user"(也可直接通过类访问)

⚠️ 注意:混入类中的变量是真正的类变量(非 attrs 字段),因此修改 User.DEFAULT_ROLE 会影响所有实例及子类,符合预期行为。

方式二:类定义后动态赋值

在 @define 装饰完成后,直接为类对象设置属性。适用于简单场景或需运行时计算的值:

from attrs import define, field

@define
class Product:
    name: str = field()
    price: float = field()

# 动态添加类变量
Product.CATEGORY = "electronics"
Product.TAX_RATE = 0.08

p = Product("Laptop", 999.99)
print(p.CATEGORY)   # → "electronics"
print(Product.TAX_RATE)  # → 0.08

❌ 为什么 ClassVar 注解无效?

attrs 的文档明确指出:“Annotated as typing.ClassVar, and attributes that are neither annotated nor set to a field() are ignored.”
这意味着 my_class_var: ClassVar[str] 被完全跳过处理——既不生成 __init__ 参数,也不注入 __dict__,甚至不会出现在 attrs.fields(Person) 的结果中。试图访问 p.my_class_var 自然抛出 AttributeError。

? 总结

  • ✅ 类变量 ≠ attrs 字段:永远不要依赖 ClassVar 注解在 @define 类中声明类变量;
  • ✅ 优先用 Mixin:结构清晰、可测试、支持多继承和类型提示;
  • ✅ 次选用动态赋值:适合临时配置或单例常量;
  • ? 避免在 @define 类体内直接写 my_var = ...(虽语法合法,但易与 field(default=...) 混淆,降低可读性)。

通过理解 attrs 的作用域边界,你既能享受其强大的实例构造能力,又能灵活运用 Python 原生的类变量机制,构建更健壮的数据类体系。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1811

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

4824

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1769

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

28717

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3447

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3447

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1223

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

616

2023.08.10

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

100

2026.10.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn