dataclass
是从Python3.7
版本开始,作为标准库中的模块被引入。
随着Python
版本的不断更新,dataclass
也逐步发展和完善,为Python
开发者提供了更加便捷的数据类创建和管理方式。
dataclass
的主要功能在于帮助我们简化数据类的定义过程。
本文总结了几个我平时使用较多dataclass
技巧。
1. 传统的类定义方式
首先,从平时量化分析的场景中简化一个关于 币交易 的类用来演示。
简化之后,这里只保留5个字段,分别是交易ID,交易对,价格,是否成功和参与交易的地址列表。
python
复制代码
class CoinTrans:
def __init__(
self,
id: str,
symbol: str,
price: float,
is_success: bool,
addrs: list,
) -> None:
self.id = id
self.symbol = symbol
self.price = price
self.addrs = addrs
self.is_success = is_success
Python
传统定义类的方式,如上通过__init__
函数来初始化对象的各个属性。
通过这个类构造对象并打印:
python
复制代码
if __name__ == "__main__":
coin_trans = CoinTrans("id01", "BTC/USDT", "71000", True, ["0x1111", "0x2222"])
print(coin_trans)
运行结果:
csharp
复制代码
<__main__.CoinTrans object at 0x0000022A891FADD0>
这里只是打印出对象的地址,并没有按照我们期望的那样打印对象各个属性的值。
传统的类中,我们如果希望打印出可读的结果,需要自己去实现__str__
函数。
python
复制代码
# 在上面的 CoinTrans 类中添加下面的方法
def __str__(self) -> str:
return f"交易信息:{self.id}, {self.symbol}, {self.price}, {self.addrs}, {self.is_success}"
再次运行,结果如下:
css
复制代码
交易信息:id01, BTC/USDT, 71000, ['0x1111', '0x2222'], True
2. dataclass装饰器定义类
下面看看使用dataclass
装饰器来定义上面同样的类有多简单。
python
复制代码
from dataclasses import dataclass
@dataclass
class CoinTrans:
id: str
symbol: str
price: float
is_success: bool
addrs: list
再次运行:
python
复制代码
if __name__ == "__main__":
coin_trans = CoinTrans("id01", "BTC/USDT", "71000", True, ["0x1111", "0x2222"])
print(coin_trans)
得到如下结果:
ini
复制代码
CoinTrans(id='id01', symbol='BTC/USDT', price='71000', is_success=True, addrs=['0x1111', '0x2222'])
不需要__init__
,也不需要__str__
,只要通过 @dataclass
装饰之后,就可以打印出对象的具体内容。
2.1. 默认值
dataclass
装饰器的方式来定义类,设置默认值很简单,直接在定义属性时就可以设置。
python
复制代码
@dataclass
class CoinTrans:
id: str = "id01"
symbol: str = "BTC/USDT"
price: float = "71000.8"
is_success: bool = True
addrs: list[str] = ["0x1111", "0x2222"]
if __name__ == "__main__":
coin_trans = CoinTrans()
print(coin_trans)
运行之后发现,在addrs
属性那行会报错:
vbnet
复制代码
ValueError: mutable default <class 'list'> for field addrs is not allowed: use default_factory
大概的意思就是,list
作为一种可变的类型(引用类型,会有被其他对象意外修改的风险),不能直接作为默认值,需要用工厂方法来产生默认值。
其他字符串,数值,布尔类型的数据则没有这个问题。
我们只要定义个函数来产生此默认值即可。
python
复制代码
def gen_list():
return ["0x1111", "0x2222"]
@dataclass
class CoinTrans:
id: str = "id01"
symbol: str = "BTC/USDT"
price: float = "71000.8"
is_success: bool = True
addrs: list[str] = field(default_factory=gen_list)
if __name__ == "__main__":
coin_trans = CoinTrans()
print(coin_trans)
再次运行,可以正常执行:
ini
复制代码
CoinTrans(id='id01', symbol='BTC/USDT', price='71000.8', is_success=True, addrs=['0x1111', '0x2222']
2.2. 隐藏敏感信息
我们打印对象信息的时候,有时执行打印其中几个属性的信息,涉及敏感信息的属性不希望打印出来。
比如,上面的对象,如果不想打印出is_success
和addrs
的信息,可以设置repr=False
。
python
复制代码
@dataclass
class CoinTrans:
id: str = "id01"
symbol: str = "BTC/USDT"
price: float = "71000.8"
is_success: bool = field(default=True, repr=False)
addrs: list[str] = field(default_factory=gen_list, repr=False)
再次运行后显示:
ini
复制代码
CoinTrans(id='id01', symbol='BTC/USDT', price='71000.8')
2.3. 只读对象
数据分析时,大部分下情况下,原始数据读取之后是不能修改的。
这种情况下,我们可以用dataclass
的frozen
属性来设置数据类只读,防止不小心篡改了数据。
未设置frozen
属性之前,可以随意修改对象的属性,比如:
python
复制代码
if __name__ == "__main__":
coin_trans = CoinTrans()
print(f"修改前: {coin_trans}")
coin_trans.symbol = "ETH/USDT"
print(f"修改后: {coin_trans}")
运行结果:
ini
复制代码
修改前: CoinTrans(id='id01', symbol='BTC/USDT', price='71000.8')
修改后: CoinTrans(id='id01', symbol='ETH/USDT', price='71000.8')
设置frozen
属性之后,看看修改属性值会怎么样:
python
复制代码
@dataclass(frozen=True)
class CoinTrans:
id: str = "id01"
#... 省略 ...
再次运行,会发现修改属性会触发异常。
arduino
复制代码
修改前: CoinTrans(id='id01', symbol='BTC/USDT', price='71000.8')
Traceback (most recent call last):
File "D:\projects\python\samples\data_classes\main.py", line 66, in <module>
coin_trans.symbol = "ETH/USDT"
^^^^^^^^^^^^^^^^^
File "<string>", line 4, in __setattr__
dataclasses.FrozenInstanceError: cannot assign to field 'symbol'
2.4. 转化为元组和字典
最后,dataclasses
模块还提供了两个函数可以很方便的将数据类转换为元组和字典。
这在和其他分析程序交互时非常有用,因为和其他程序交互时,参数一般都用元组或者字典这种简单通用的结构,
而不会直接用自己定义的数据类。
python
复制代码
from dataclasses import dataclass, field, astuple, asdict
if __name__ == "__main__":
coin_trans = CoinTrans()
print(astuple(coin_trans))
print(asdict(coin_trans))
运行结果:
python
复制代码
('id01', 'BTC/USDT', '71000.8', True, ['0x1111', '0x2222'])
{'id': 'id01', 'symbol': 'BTC/USDT', 'price': '71000.8', 'is_success': True, 'addrs': ['0x1111', '0x2222']}
3. 总结
在Python
中,数据类主要用于存储数据,并通常包含属性和方法来操作这些数据。
然而,在定义数据类时,我们通常需要编写一些重复性的代码,如构造函数、属性访问器和字符串表示等。
dataclass
装饰器的出现,使得这些通用方法的生成变得自动化,从而极大地简化了数据类的定义过程。
总的来说,dataclass
通过简化数据类的创建和管理过程,提高了开发效率,是我们在数据分析时的一个非常有用的工具。
这里给大家分享一份Python全套学习资料,包括学习路线、软件、源码、视频、面试题等等,都是我自己学习时整理的,希望可以对正在学习或者想要学习Python的朋友有帮助!
CSDN大礼包:全网最全《全套Python学习资料》免费分享🎁
😝有需要的小伙伴,可以点击下方链接免费领取或者V扫描下方二维码免费领取🆓
1️⃣零基础入门
① 学习路线
对于从来没有接触过Python的同学,我们帮你准备了详细的学习成长路线图。可以说是最科学最系统的学习路线,你可以按照上面的知识点去找对应的学习资源,保证自己学得较为全面。
② 路线对应学习视频
还有很多适合0基础入门的学习视频,有了这些视频,轻轻松松上手Python~
③练习题
每节视频课后,都有对应的练习题哦,可以检验学习成果哈哈!
因篇幅有限,仅展示部分资料
2️⃣国内外Python书籍、文档
① 文档和书籍资料
3️⃣Python工具包+项目源码合集
①Python工具包
学习Python常用的开发软件都在这里了!每个都有详细的安装教程,保证你可以安装成功哦!
②Python实战案例
光学理论是没用的,要学会跟着一起敲代码,动手实操,才能将自己的所学运用到实际当中去,这时候可以搞点实战案例来学习。100+实战案例源码等你来拿!
③Python小游戏源码
如果觉得上面的实战案例有点枯燥,可以试试自己用Python编写小游戏,让你的学习过程中增添一点趣味!
4️⃣Python面试题
我们学会了Python之后,有了技能就可以出去找工作啦!下面这些面试题是都来自阿里、腾讯、字节等一线互联网大厂,并且有阿里大佬给出了权威的解答,刷完这一套面试资料相信大家都能找到满意的工作。
5️⃣Python兼职渠道
而且学会Python以后,还可以在各大兼职平台接单赚钱,各种兼职渠道+兼职注意事项+如何和客户沟通,我都整理成文档了。
上述所有资料 ⚡️ ,朋友们如果有需要 📦《全套Python学习资料》的,可以扫描下方二维码免费领取 🆓
😝有需要的小伙伴,可以点击下方链接免费领取或者V扫描下方二维码免费领取🆓