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 pickle类库介绍(对象序列化和反序列化)
Nov 21 Python
Python常用内置函数总结
Feb 08 Python
解决python3中解压zip文件是文件名乱码的问题
Mar 22 Python
python语音识别实践之百度语音API
Aug 30 Python
Flask框架踩坑之ajax跨域请求实现
Feb 22 Python
python使用Qt界面以及逻辑实现方法
Jul 10 Python
Pytorch to(device)用法
Jan 08 Python
Python Numpy,mask图像的生成详解
Feb 19 Python
Python如何脚本过滤文件中的注释
May 27 Python
python实现斗地主分牌洗牌
Jun 22 Python
Python urllib库如何添加headers过程解析
Oct 05 Python
python 如何获取页面所有a标签下href的值
May 06 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
PHP操作数组的一些函数整理介绍
2011/07/17 PHP
PHP取进制余数函数代码
2012/01/19 PHP
详解WordPress中调用评论模板和循环输出评论的PHP函数
2016/01/05 PHP
Laravel框架实现即点即改功能的方法分析
2019/10/31 PHP
AJAX架构之Dojo篇
2007/04/10 Javascript
支持ie与FireFox的剪切板操作代码
2009/09/28 Javascript
JavaScript 面向对象的 私有成员和公开成员
2010/05/13 Javascript
js 判断脚本加载完毕的代码
2011/07/13 Javascript
让低版本浏览器支持input的placeholder属性(js方法)
2013/04/03 Javascript
javaScript(JS)替换节点实现思路介绍
2013/04/17 Javascript
一个封装js代码-----展开收起效果示例
2013/07/03 Javascript
js实现带按钮的上下滚动效果
2015/05/12 Javascript
纯HTML5制作围住神经猫游戏-附源码下载
2015/08/23 Javascript
JavaScript中关于iframe滚动条的去除和保留
2016/11/17 Javascript
工厂模式在JS中的实践
2017/01/18 Javascript
JavaScript实现三级联动效果
2017/07/15 Javascript
JavaScript中click和onclick本质区别与用法分析
2018/06/07 Javascript
Vue中使用的EventBus有生命周期
2018/07/12 Javascript
原生JS实现动态加载js文件并在加载成功后执行回调函数的方法
2020/12/30 Javascript
详解Vue CLI3配置解析之css.extract
2018/09/14 Javascript
浅谈React碰到v-if
2018/11/04 Javascript
JS防抖和节流实例解析
2019/09/24 Javascript
laravel实现中文和英语互相切换的例子
2019/09/30 Javascript
小程序接入腾讯位置服务的详细流程
2020/03/03 Javascript
javascript实现图片轮换动作方法
2020/08/07 Javascript
js实现带有动画的返回顶部
2020/08/09 Javascript
[36:20]KG vs SECRET 2019国际邀请赛小组赛 BO2 第二场 8.16
2019/08/19 DOTA
Python爬虫将爬取的图片写入world文档的方法
2018/11/07 Python
美国著名童装品牌:OshKosh B’gosh
2016/08/05 全球购物
BookOutlet加拿大:在网上书店购买廉价折扣图书和小说
2018/10/05 全球购物
土耳其新趋势女装购物网站:Addax
2020/01/07 全球购物
医院总经理职责
2013/12/26 职场文书
2014小学植树节活动总结
2014/03/10 职场文书
Python 使用dict实现switch的操作
2021/04/07 Python
详解GaussDB for MySQL性能优化
2021/05/18 MySQL
Python循环之while无限迭代
2022/04/30 Python