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

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

小伟小哥_7225

小伟小哥_7225

发布时间:2026-08-16 15:42:23

|

786人浏览过

|

来源于php中文网

原创

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

attrs 库默认忽略 typing.ClassVar 注解的字段,不将其转为实例属性;若需类变量,应通过继承混入类或直接在类对象上赋值实现,而非依赖字段注解。

`attrs` 库默认忽略 `typing.classvar` 注解的字段,不将其转为实例属性;若需类变量,应通过继承混入类或直接在类对象上赋值实现,而非依赖字段注解。

attrs 以简洁、声明式的方式极大简化了 Python 数据类的定义,尤其擅长将类型注解自动转换为实例字段(instance fields)。但需注意:attrs 明确不支持将 typing.ClassVar 注解作为字段处理——它会直接跳过此类标注,既不生成实例属性,也不设置类属性。因此,如下写法无法达到预期效果:

from typing import ClassVar
from attrs import define

@define
class Person:
    name: str
    my_class_var: ClassVar[str] = "shared"  # ❌ 不生效!该属性不会出现在实例或类上

p = Person("Alice")
# p.my_class_var  # AttributeError!

这是因为 attrs 的设计哲学是专注管理实例状态;类变量属于类本身的命名空间,应由 Python 原生机制管理。

✅ 正确实践:两种推荐方式

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

定义一个仅含类变量的基类,让 @define 类继承它。attrs 不会干扰父类已存在的类属性:

from attrs import define, field

class SharedConfig:
    version: str = "1.0.0"
    default_timeout: int = 30

@define
class Person(SharedConfig):
    name: str = field()
    age: int = field()

p = Person("Bob", 28)
print(p.version)           # → "1.0.0"(来自父类)
print(Person.version)      # → "1.0.0"(类属性可直接访问)

✅ 优势:结构清晰、支持多继承复用、IDE 可识别类型;适用于需跨多个 attrs 类共享配置的场景。

方式二:类定义后动态赋值(推荐用于简单常量)

在 @define 装饰后,直接向类对象绑定属性:

from attrs import define, field

@define
class Person:
    name: str = field()
    age: int = field()

# 显式添加类变量
Person.API_BASE_URL = "https://api.example.com"
Person.MAX_AGE = 150

p = Person("Charlie", 35)
print(p.API_BASE_URL)   # → "https://api.example.com"
print(Person.MAX_AGE)   # → 150

✅ 优势:简洁直观、无额外类开销;适合单点常量或运行时确定的类级配置。

⚠️ 注意事项与最佳实践

  • 不要混淆 ClassVar 与 field(default=...):后者创建的是所有实例共享的默认值(仍是实例属性),而非真正的类变量;修改它会影响单个实例,而非全局。
  • Final 不等于 ClassVar:Final[str] 仅表示该实例字段不应被重新赋值,仍属于实例状态。
  • 类型检查友好性:使用混入类时,建议为类变量添加类型提示(如 version: ClassVar[str]),虽 attrs 忽略它,但 mypy 等工具仍能校验访问合法性。
  • 避免在 __init__ 中覆盖类变量:确保类变量名不与 attrs 字段名冲突,否则可能意外屏蔽类属性。

总之,attrs 的精妙在于“专注做好一件事”——管理实例字段。类变量应交还给 Python 的类机制处理。合理组合混入继承与类后赋值,即可在保持代码简洁的同时,获得类型安全、可维护且符合直觉的类设计。

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

热门AI工具

更多
PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

WorkBuddy

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

切问学术

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

豆包大模型

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

DeepSeek

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

相关专题

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

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

1671

2023.07.20

python能做什么
python能做什么

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

4164

2023.07.25

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

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

1669

2023.07.31

python教程
python教程

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

24157

2023.08.03

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

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

2947

2023.08.04

python eval
python eval

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

2987

2023.08.04

scratch和python区别
scratch和python区别

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

1163

2023.08.11

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

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

596

2023.08.10

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

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

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