例子: ClassVar[Dict[str, Any]]
ClassVar[Dict[str, Any]]
是 Python 类型提示(Type Hinting)中的一个表达式,它用于注解类变量的类型。让我们逐步分解它的含义:
1. ClassVar
ClassVar
来自typing
模块,用于标记一个变量是类变量,而不是实例变量。- 类变量是属于类本身的,而不是属于类的实例(对象)。
- 所有实例共享同一个类变量。
2. Dict[str, Any]
Dict
表示字典类型。str
表示字典的键(key)是字符串类型。Any
表示字典的值(value)可以是任意类型。
3. 组合起来
ClassVar[Dict[str, Any]]
表示一个类变量,它的类型是字典。这个字典的键是字符串,值可以是任意类型。
示例
from typing import ClassVar, Dict, Any
class MyClass:
class_data: ClassVar[Dict[str, Any]] = {"count": 0}
def __init__(self):
pass
def increment_count(self):
MyClass.class_data["count"] += 1
# 访问类变量
print(MyClass.class_data) # 输出: {'count': 0}
# 修改类变量
MyClass.class_data["count"] = 10
# 创建实例
obj1 = MyClass()
obj2 = MyClass()
# 所有实例共享同一个类变量
obj1.increment_count()
print(obj1.class_data) # 输出: {'count': 11}
print(obj2.class_data) # 输出: {'count': 11}
{'count': 0}
{'count': 11}
{'count': 11}
在 dataclass 中的应用
在 dataclass 中,ClassVar[Dict[str, Any]]
通常用于注解 __dataclass_fields__
属性。__dataclass_fields__
是一个由 dataclass 自动添加的类属性,它是一个字典,包含了 dataclass 中所有字段的信息(字段名和类型)。
from dataclasses import dataclass
from typing import ClassVar, Dict, Any
@dataclass
class MyData:
x: int
y: str
__dataclass_fields__: ClassVar[Dict[str, Any]] = {} # 实际由 dataclass 自动添加
# MyData.__dataclass_fields__ 会包含 x 和 y 字段的信息
{'x': Field(name='x',type=<class 'int'>,default=<dataclasses._MISSING_TYPE object at 0x000001F9778E7620>,default_factory=<dataclasses._MISSING_TYPE object at 0x000001F9778E7620>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD),
'y': Field(name='y',type=<class 'str'>,default=<dataclasses._MISSING_TYPE object at 0x000001F9778E7620>,default_factory=<dataclasses._MISSING_TYPE object at 0x000001F9778E7620>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD),
'__dataclass_fields__': Field(name='__dataclass_fields__',type=typing.ClassVar[typing.Dict[str, typing.Any]],default={},default_factory=<dataclasses._MISSING_TYPE object at 0x000001F9778E7620>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=<dataclasses._MISSING_TYPE object at 0x000001F9778E7620>,_field_type=_FIELD_CLASSVAR)}
总结
ClassVar[Dict[str, Any]]
用于注解类变量,表示该变量是一个字典,键为字符串,值为任意类型。它在 dataclass 中常用于注解 __dataclass_fields__
属性,用于存储 dataclass 字段的信息。
注意
类型提示只是用于静态类型检查,不会在运行时强制限制变量的类型。