上文我们简单的聊了一下 dataclass 的一些用法,今天我们一起进一步熟悉它。
field
field 在 dataclasses 里面是比较重要的功能, 用于初处理定义的参数非常有用
在 PEP 557 中是这样描述 field 的Field objects describe each defined field. These objects are created internally, and are returned by the fields() module-level method (see below). Users should never instantiate a Field object directly.
大致意思就是 Field 对象是用于描述定义的字段的,这些对象是内部定义好了的。然后由 field() 方法返回,用户不用直接实例化 Field。
我们先看看 field 是如何使用的
from dataclasses import dataclass, field
@dataclass
class A:
a: str = field(default="123")
可以用于设立默认值,和 a: str = "123" 一个效果,那为什么我们还需要 field 呢?
因为 field 的功能远不止这一个设置默认值,他还有很多有用的功能设置是否加载到 __init__ 里面去
@dataclass
class A:
a: int
b: int = field(default=10, init=False)
a = A(1) # 注意,实例化 A 的时候只需要一个参数,赋给 a 的
等价于:
class A:
b = 10
def __init__(self, a: int):
self.a = a设置是否成为 __repr__ 返回参数
我们在之前实例化 A 的时候,把实例化对象打印出来的话,是这样的:
A(a=1, b=10)
那如果我们不想把特定的对象打印出来,可以这样写:
@dataclass
class A:
a: int
b: int = field(default=1, repr=False)
a = A(1)
print(a)
这时候,打印的结果为 A(a=1)设置是否计算 hash 的对象之一
a: int = field(hash=False)
设置是否成为和其他类进行对比的值之一
a: int = field(compare=False)
定义 field 信息
from dataclasses import field, dataclass, fields
@dataclass
class A:
a: int = field(metadata={"name": "a"}) # metadata 需要接受一个映射对象,也就是 python 的字典
metadata = fields(A)
print(metadata)
打印的结果是
(Field(name='a',type=,default=,default_factory=,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'name': 'a'}),_field_type=_FIELD),)
是一个 tuple,第一个即是 a 字段的 field 定义
可以通过 metadata[0].metadata["name"] 获取值自定义处理定义的参数
有些字段需要我们进行一些预处理,不用传递初始值,由其他函数返回
我们可以这么写
def value():
return "123"
@dataclass
class A:
a: str = field(default_factory=value)
print(A().a) # 实例化 A 的时候已经可以不传递值了
打印的结果是 '123'
使用 dataclass 设定初始方法
使用装饰器 dataclass 的时候,设定一些参数,即可选择是否需要这些初始方法__init__
@dataclass(i