Python 3.7新功能之dataclass装饰器详解


Posted in Python onApril 21, 2018

前言

Python 3.7 将于今年夏天发布,Python 3.7 中将会有许多新东西:

  • 各种字符集的改进
  • 对注释的推迟评估
  • 以及对dataclass的支持

最激动人心的新功能之一是 dataclass 装饰器。

什么是 Data Class

大多数 Python 开发人员编写过很多像下面这样的类:

class MyClass:
 def __init__(self, var_a, var_b):
 self.var_a = var_a
 self.var_b = var_b

dataclass 可以为简单的情况自动生成方法,例如,一个__init__接受这些参数并将其分配给自己,之前的小例子可以重写为:

@dataclass
class MyClass:
 var_a: str
 var_b: str

那么通过一个例子来看看如何使用吧

星球大战 API

可以使用 requests 从星球大战 API 获取资源:

response = requests.get('https://swapi.co/api/films/1/')
dictionary = response.json()

让我们来看看 dictionary (简化过)的结果:

{
 'characters': ['https://swapi.co/api/people/1/',… ],
 'created': '2014-12-10T14:23:31.880000Z',
 'director': 'George Lucas',
 'edited': '2015-04-11T09:46:52.774897Z',
 'episode_id': 4,
 'opening_crawl': 'It is a period of civil war.\r\n … ',
 'planets': ['https://swapi.co/api/planets/2/', … ],
 'producer': 'Gary Kurtz, Rick McCallum',
 'release_date': '1977-05-25',
 'species': ['https://swapi.co/api/species/5/',…],
 'starships': ['https://swapi.co/api/starships/2/',…],
 'title': 'A New Hope',
 'url': 'https://swapi.co/api/films/1/',
 'vehicles': ['https://swapi.co/api/vehicles/4/',…]

封装 API

为了正确地封装一个 API,我们应该创建一个用户可以在其应用程序中使用的对象,因此,在Python 3.6 中定义一个对象来包含requests对 /films/endpoint的响应:

class StarWarsMovie:
 def __init__(self,
   title: str,
   episode_id: int,
   opening_crawl: str,
   director: str,
   producer: str,
   release_date: datetime,
   characters: List[str],
   planets: List[str],
   starships: List[str],
   vehicles: List[str],
   species: List[str],
   created: datetime,
   edited: datetime,
   url: str
   ):

 self.title = title
 self.episode_id = episode_id
 self.opening_crawl= opening_crawl
 self.director = director
 self.producer = producer
 self.release_date = release_date
 self.characters = characters
 self.planets = planets
 self.starships = starships
 self.vehicles = vehicles
 self.species = species
 self.created = created
 self.edited = edited
 self.url = url

 if type(self.release_date) is str:
  self.release_date = dateutil.parser.parse(self.release_date)

 if type(self.created) is str:
  self.created = dateutil.parser.parse(self.created)

 if type(self.edited) is str:
  self.edited = dateutil.parser.parse(self.edited)

仔细的读者可能已经注意到这里有一些重复的代码。

这是使用 dataclass 装饰器的经典案例,我们需要创建一个主要用来保存数据的类,只需一点验证,所以让我们来看看我们需要修改什么。

首先,data class 自动生成一些 dunder 方法,如果我们没有为 data class 装饰器指定任何选项,则生成的方法有:__init__,__eq__和__repr__,如果你已经定义了__repr__但没定义__str__,默认情况下 Python(不仅仅是 data class)将实现返回__repr__的输出__str__方法。因此,只需将代码更改为以下代码即可实现四种 dunder 方法:

@dataclass
class StarWarsMovie:
 title: str
 episode_id: int
 opening_crawl: str
 director: str
 producer: str
 release_date: datetime
 characters: List[str]
 planets: List[str]
 starships: List[str]
 vehicles: List[str]
 species: List[str]
 created: datetime
 edited: datetime
 url: str

我们去掉了__init__方法,以确保 data class 装饰器可以添加它生成的对应方法。不过,我们在这个过程中失去了一些功能,我们的 Python 3.6 构造函数不仅定义了所有的值,还试图解析日期,我们怎样才能用 data class 来做到这一点呢?

如果要覆盖 __init__,我们将失去 data class 的优势,因此,如果要处理任何附加功能可以使用新的 dunder 方法:__post_init__,让我们看看__post_init__方法对于我们的包装类来说是什么样子的:

def __post_init__(self):
 if type(self.release_date) is str:
  self.release_date = dateutil.parser.parse(self.release_date)

 if type(self.created) is str:
  self.created = dateutil.parser.parse(self.created)

 if type(self.edited) is str:
  self.edited = dateutil.parser.parse(self.edited)

就是这样! 我们可以使用 data class 装饰器在用三分之二的代码量实现我们的类。

更多好东西

通过使用装饰器的选项,可以为用例进一步定制 data class,默认选项是:

@dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)
  • init决定是否生成__init__ dunder 方法
  • repr决定是否生成__repr__ dunder方法
  • eq对__eq__ dunder 方法也是如此,它决定相等性检查的行为(your_class_instance == another_instance)
  • order 实际上创建了四种 dunder 方法,它们确定所有检查小于,and/or,大于的行为,如果将其设置为 true,则可以对对象列表进行排序。

最后两个选项确定对象是否可以被哈希化,如果你想使用你的 class 的对象作为字典键的话,这是必要的。

更多信息请参考:PEP 557 -- Data Classes

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对三水点靠木的支持。

Python 相关文章推荐
Python实现获取某天是某个月中的第几周
Feb 11 Python
深入讲解Python中面向对象编程的相关知识
May 25 Python
python 中split 和 strip的实例详解
Jul 12 Python
Django的分页器实例(paginator)
Dec 01 Python
Python numpy生成矩阵、串联矩阵代码分享
Dec 04 Python
python使用生成器实现可迭代对象
Mar 20 Python
用Python编写一个高效的端口扫描器的方法
Dec 20 Python
python使用pandas处理大数据节省内存技巧(推荐)
May 05 Python
基于pytorch 预训练的词向量用法详解
Jan 06 Python
如何使用python自带IDLE的几种方法
Oct 10 Python
python中使用.py配置文件的方法详解
Nov 23 Python
Python可视化学习之matplotlib内置单颜色
Feb 24 Python
pandas or sql计算前后两行数据间的增值方法
Apr 20 #Python
对pandas进行数据预处理的实例讲解
Apr 20 #Python
pandas 两列时间相减换算为秒的方法
Apr 20 #Python
详谈pandas中agg函数和apply函数的区别
Apr 20 #Python
Python使用pip安装pySerial串口通讯模块
Apr 20 #Python
pandas apply 函数 实现多进程的示例讲解
Apr 20 #Python
python3+PyQt5图形项的自定义和交互 python3实现page Designer应用程序
Jul 20 #Python
You might like
Can't create/write to file 'C:\WINDOWS\TEMP\...MYSQL报错解决方法
2011/06/30 PHP
PHP的魔术常量__METHOD__简介
2014/07/08 PHP
destoon调用企业会员公司形象图片的实现方法
2014/08/21 PHP
PHP中通过fopen()函数访问远程文件示例
2014/11/18 PHP
php获取给定日期相差天数的方法分析
2017/02/20 PHP
用javascript实现的支持lrc歌词的播放器
2007/05/17 Javascript
JavaScript中OnLoad几种使用方法
2012/12/15 Javascript
js字符串截取函数substr substring slice使用对比
2013/11/27 Javascript
简介JavaScript中POSITIVE_INFINITY值的使用
2015/06/05 Javascript
用Move.js配合创建CSS3动画的入门指引
2015/07/22 Javascript
今天抽时间给大家整理jquery和ajax的相关知识
2015/11/17 Javascript
jquery实现刷新随机变化样式特效(tag标签样式)
2017/02/03 Javascript
JavaScript获取中英文混合字符串长度的方法示例
2017/02/04 Javascript
微信小程序开发之toast等弹框提示使用教程
2017/06/08 Javascript
jQuery选取所有复选框被选中的值并用Ajax异步提交数据的实例
2017/08/04 jQuery
浅谈webpack-dev-server的配置和使用
2018/05/17 Javascript
vue计算属性computed、事件、监听器watch的使用讲解
2019/01/21 Javascript
详解Element-UI中上传的文件前端处理
2019/08/07 Javascript
javascript随机变色实例代码
2019/10/15 Javascript
JavaScript实现简单随机点名器
2019/11/21 Javascript
详解Typescript 内置的模块导入兼容方式
2020/05/31 Javascript
python中ASCII码和字符的转换方法
2018/07/09 Python
python批量获取html内body内容的实例
2019/01/02 Python
Python3+OpenCV2实现图像的几何变换(平移、镜像、缩放、旋转、仿射)
2019/05/13 Python
python函数与方法的区别总结
2019/06/23 Python
python 函数中的内置函数及用法详解
2019/07/02 Python
解决python 找不到module的问题
2020/02/12 Python
Big Green Smile德国网上商店:提供各种天然产品
2018/05/23 全球购物
优秀应届毕业生自荐书
2014/06/29 职场文书
2015中学政教处工作总结
2015/07/22 职场文书
入党转正申请自我鉴定
2019/06/25 职场文书
创业计划书之小型广告公司
2019/10/22 职场文书
600字作文之感受大自然
2019/11/27 职场文书
CSS变量实现主题切换的方法
2021/06/23 HTML / CSS
html输入两个数实现加减乘除功能
2021/07/01 HTML / CSS
NoSQL优缺点与MongoDB数据库简介
2022/06/05 MongoDB