数据类适用于Python3.7或更高版本,它不仅可以用作数据容器,还可以编写样板代码,简化创建类的过程。
创建第一个数据类
创建一个数据类,该数据类表示三维坐标系中的一个点。
@dataclass装饰器用于创建数据类。x,y和z是数据类中的字段。注意要使用类型注释来指定字段的数据类型,但是类型注释不是静态类型声明,这意味着仍然可以为x,y或z字段传递除int之外的任何数据类型。
- from dataclasses import dataclass
- @dataclass
- classCoordinate:
- x: int
- y: int
- z: int
默认情况下,数据类附带有init、repr和 eq方法,因此我们不必自己实现。但是如果init、repr和eq没有在Coordinate类中实现,有了数据类,我们仍然可以使用这些方法,这样非常节省时间。
- from dataclasses import dataclass
- @dataclass
- classCoordinate:
- x: int
- y: int
- z: int
- a =Coordinate(4, 5, 3)
- print(a) # output: Coordinate(x=4, y=5, z=3)
字段的默认值
编码者可以为字段分配默认值。如下所示,数据类中的pi字段被分配了默认值:
- from dataclasses import dataclass
- @dataclass
- classCircleArea:
- r: int
- pi: float =3.14
- @property
- defarea(self):
- return self.pi * (self.r **2)
- a =CircleArea(2)
- print(repr(a)) # output: CircleArea(r=2, pi=3.14)
- print(a.area) # output: 12.56
自定义字段和数据类
设置dataclass装饰器或field函数的参数可以自定义字段和数据类。自定义过程将用例子进行说明,本文结尾也会给出字段和数据类的所有参数。
数据类可变还是不可变?
默认情况下,数据类是可变的,这意味着可以为字段分配值。但我们可以通过将frozen参数设置为True来使其不可变
可变示例:
- from dataclasses import dataclass
- @dataclass
- classCircleArea:
- r: int
- pi: float =3.14
- @property
- defarea(self):
- return self.pi * (self.r **2)
- a =CircleArea(2)
- a.r =5
- print(repr(a)) # output: CircleArea(r=5, pi=3.14)
- print(a.area) # output: 78.5
不可变示例:
设置frozen为 True,将无法再为字段分配值。在下面的示例中可以看到异常输出。
- from dataclasses import dataclass
- @dataclass(frozen=True)
- classCircleArea:
- r: int
- pi: float =3.14
- @property
- defarea(self):
- return self.pi * (self.r **2)
- a =CircleArea(2)
- a.r =5
- # Exceptionoccurred: dataclasses.FrozenInstanceError:
- # cannot assign tofield 'r'
比较数据类
假设要创建一个表示Vector的数据类并进行比较,你会怎么做?当然需要使用诸如lt或gt之类的方法啦。
默认情况下,数据类的order参数为 False。将其设置为True,会自动为数据类生成 lt、le、gt和ge方法。因此,可以按顺序比较对象,就像它们是其字段的元组一样。
研究下面的示例:将order设置为True就可以比较v2和v1。这里存在一个逻辑比较的问题。当v2> v1时,它将比较这两个向量,例如(8,15)>(7,20)。因此,v2> v1的输出将为True。
回想一下,元组比较是逐个按照顺序进行的。首先将8和7进行比较,结果为True,那么比较结果就为True。如果它们相等,则比较15> 20,结果为False:
- from dataclasses import dataclass,field
- @dataclass(order=True)
- classVector:
- x: int
- y: int
- v1 =Vector(8, 15)
- v2 =Vector(7, 20)
- print(v2 > v1)
显然这种比较没有任何意义。笔者最初想通过向量的大小来比较它们。但问题是,不可能在创建每个实例时,都要自己计算Vector的大小。
在这种情况下,field函数和post_init方法更有用。field函数能自定义magnitude字段。而post_init方法则会确定初始化后该矢量的大小。
还可以使用数据类中的field函数来自定义magnitude字段。通过将init设置为False,基本可以不需要init方法中的magnitude参数。因为初始化后才使用post_init方法来确定其值:
- from dataclasses import dataclass, field
- @dataclass(order=True)
- classVector:
- magnitude: float =field(init=False)
- x: int
- y: int
- def__post_init__(self):
- self.magnitude = (self.x **2+ self.y **2) **0.5
- v1 =Vector(9, 12)
- print(v1) # output: Vector(magnitude=15.0, x=9,y=12)
- v2 =Vector(8, 15)
- print(v2) # output: Vector(magnitude=17.0, x=8,y=15)
- print(v2 > v1) # output: True
将数据类转换为字典或元组
从元组或字典中获取数据类的属性,只需要从数据类中导入asdict和astuple函数:
- from dataclasses import dataclass,asdict, astuple
- @dataclass
- classVector:
- x: int
- y: int
- z: int
- v =Vector(4, 5, 7)
- print(asdict(v)) # output: {'x': 4, 'y': 5, 'z': 7}
- print(astuple(v)) # output: (4, 5, 7)
继承
可以像Python中的普通类一样对数据类进行子类化:
- from dataclasses import dataclass
- @dataclass
- classEmployee:
- name: str
- lang: str
- @dataclass
- classDeveloper(Employee):
- salary: int
- Halil=Developer('Halil', 'Python', 5000)
- print(Halil) # Output: Developer(name='Halil',lang='Python', salary=5000)
使用继承时经常会忽视一点:默认情况下,当将lang字段设置为Python时,必须为lang字段之后的字段提供默认值:
- from dataclasses import dataclass
- @dataclass
- classEmployee:
- name: str
- lang: str ='Python'
- @dataclass
- classDeveloper(Employee):
- salary: int
- Halil=Developer('Halil', 'Python', 5000)
- # Output:TypeError: non-default argument 'salary' follows default argument
原因在于init方法。回想一下,具有默认值的参数应该位于没有默认值的参数之后:
- def__init__(name: str,lang: str ='Python', salary: int):
- ...
通过对sanlary字段设置默认值来对其进行修复:
- from dataclasses import dataclass
- @dataclass
- classEmployee:
- name: str
- lang: str ='Python'
- @dataclass
- classDeveloper(Employee):
- salary: int =0
- Halil=Developer('Halil', 'Python', 5000)
- print(Halil) # output: Developer(name='Halil',lang='Python', salary=5000)
slots的好处
默认情况下,属性存储在字典中。使用slots可以更快地访问属性并且内存占用更少。
- from dataclasses import dataclass
- @dataclass
- classEmployee:
- name: str
- lang: str
- Halil=Employee('Halil', 'Python')
- print(Halil.__dict__) # name': 'Halil', 'lang': 'Python'}
slots内存占用更小,访问属性更快。
- from dataclasses import dataclass
- @dataclass
- classEmployee:
- __slots__ = ('name', 'lang')
- name: str
- lang: str
- Halil=Employee('Halil', 'Python')
数据类参数
刚刚我们更改了数据类装饰器中的某些参数,以自定义数据类。以下是参数列表:
- nit:如果为True,则在数据类中生成init方法。(默认为True)
- repr:如果为True,则在数据类中生成repr方法。(默认为True)
- eq:如果为True,则在数据类中生成eq方法。(默认为True)
- order:如果为True,则在数据类中生成lt,le,gt和ge方法。(默认为False)
- unsafe_hash:如果为True,则在数据类中生成hash方法。(默认为False)
- frozen:如果为True,则不能给字段分配值。(默认为False。)
注意,如果order为True,eq必须也为True,否则将引发ValueError异常。
字段参数
- init:如果为True,则此字段包含在生成的init方法中。(默认为True)
- repr:如果为True,则此字段包含在生成的repr方法中。(默认为True)
- compare:如果为True,则此字段包含在生成的比较和相等方法中。(默认为True)
- hash:如果为True,则此字段包含在生成的hash方法中。(默认为None)
- default:这是此字段的默认值(如果提供)。
- default_factory:当该字段需要默认值时将调用该参数,此时该参数必须为零阶可调用参数对象。
- metadata:可以是映射,也可以为空,为空则将其视为空字典。
以上就是关于Python中数据类的简要介绍,你掌握了吗?