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

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

老丽大大_4120

老丽大大_4120

发布时间:2026-08-14 16:59:07

|

933人浏览过

|

来源于php中文网

原创

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

attrs 库默认忽略 typing.ClassVar 注解的字段,因此无法通过 @define 自动生成类变量;需采用继承混入类或类定义后动态赋值的方式显式声明类变量。

`attrs` 库默认忽略 `typing.classvar` 注解的字段,因此无法通过 `@define` 自动生成类变量;需采用继承混入类或类定义后动态赋值的方式显式声明类变量。

在使用 attrs 构建数据类时,其核心优势在于通过类型注解和 field() 自动管理实例属性,大幅提升代码简洁性与可维护性。然而,attrs 明确不支持将 typing.ClassVar 作为字段处理——正如官方文档所强调:“标注为 ClassVar 的属性,以及未标注也未显式调用 field() 的变量,均会被 attrs 忽略”。这意味着以下写法不会生效:

from typing import ClassVar
from attrs import define

@define
class Person:
    name: str
    my_class_var: ClassVar[str] = "shared"  # ❌ 被 attrs 忽略,实例/类上均不可访问

p = Person("Alice")
# AttributeError: 'Person' object has no attribute 'my_class_var'

要正确定义并使用类变量,推荐以下两种可靠且符合 Python 惯例的方式:

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

将类变量定义在独立基类中,再让 @define 类继承该基类。这是最清晰、可复用性强、语义明确的做法:

from attrs import define, field

class SharedConfig:
    VERSION: str = "2.1.0"
    DEFAULT_TIMEOUT: int = 30

@define
class APIRequest(SharedConfig):  # 继承获得类变量
    url: str = field()
    method: str = field(default="GET")

print(APIRequest.VERSION)           # → "2.1.0"
print(APIRequest.DEFAULT_TIMEOUT)   # → 30
req = APIRequest("https://api.example.com")
print(req.VERSION)  # 同样可从实例访问(因类变量可通过实例读取)

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

适用于简单场景或需运行时计算类变量值的情况:

from attrs import define, field

@define
class Logger:
    name: str

# 动态添加类变量(推荐在模块级定义后立即赋值,避免隐式副作用)
Logger.LOG_LEVEL = "INFO"
Logger.FORMAT = "%(asctime)s - %(name)s - %(levelname)s"

print(Logger.LOG_LEVEL)  # → "INFO"
l = Logger("main")
print(l.FORMAT)          # → "%(asctime)s - %(name)s - %(levelname)s"

⚠️ 注意事项

  • 不要混淆 ClassVar 与 field(default=...):后者创建的是所有实例共享的默认值(仍属实例字段),而非真正的类变量;修改该字段会影响单个实例,而非整个类。
  • 类变量不可被 attrs 自动生成 __init__ 参数:ClassVar 字段绝不会出现在 __init__ 签名中,也不参与 repr、eq 或 hash 计算——这正是其设计本意。
  • 优先选择 Mixin 方式:它更利于类型检查器(如 mypy)识别、支持 IDE 自动补全,且便于多类复用同一组配置。

综上,attrs 的设计哲学是“专注实例属性”,类变量应交由 Python 原生机制(继承或类赋值)管理。合理组合二者,既能享受 attrs 的声明式便利,又能保持代码结构的清晰与健壮。

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

热门AI工具

更多
SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

豆包大模型

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

DeepSeek

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

WorkBuddy

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

讯飞绘文

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

切问学术

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

咔片AIPPT

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

相关专题

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

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

1831

2023.07.20

python能做什么
python能做什么

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

4904

2023.07.25

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

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

1789

2023.07.31

python教程
python教程

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

29357

2023.08.03

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

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

3507

2023.08.04

python eval
python eval

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

3507

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

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

40

2026.10.28

热门下载

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

精品课程

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

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