Python 3.7 将引入 dataclass 装饰器

简评：Python 3.7 将于今年夏天发布，Python 3.7 中将会有许多新东西，最激动人心的新功能之一是 dataclass 装饰器。

什么是 Data Class

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

1. class MyClass:

2.    def __init__(self, var_a, var_b):

3.        self.var_a = var_a

4.        self.var_b = var_b

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

1. @dataclass

2. class MyClass:

3.    var_a: str

4.    var_b: str

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

星球大战 API

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

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

2. dictionary = response.json()

让我们来看看 dictionary （简化过）的结果：

1. {

2. 'characters': ['https://swapi.co/api/people/1/',… ],

3. 'created': '2014-12-10T14:23:31.880000Z',

4. 'director': 'George Lucas',

5. 'edited': '2015-04-11T09:46:52.774897Z',

6. 'episode_id': 4,

7. 'opening_crawl': 'It is a period of civil war.\r\n … ',

8. 'planets': ['https://swapi.co/api/planets/2/', … ],

9. 'producer': 'Gary Kurtz, Rick McCallum',

10. 'release_date': '1977-05-25',

11. 'species': ['https://swapi.co/api/species/5/',…],

12. 'starships': ['https://swapi.co/api/starships/2/',…],

13. 'title': 'A New Hope',

14. 'url': 'https://swapi.co/api/films/1/',

15. 'vehicles': ['https://swapi.co/api/vehicles/4/',…]

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

1. class StarWarsMovie:

2.    def __init__(self,

3.            title: str,

4.            episode_id: int,

5.            opening_crawl: str,

6.            director: str,

7.            producer: str,

8.            release_date: datetime,

9.            characters: List[str],

10.            planets: List[str],

11.            starships: List[str],

12.            vehicles: List[str],

13.            species: List[str],

14.            created: datetime,

15.            edited: datetime,

16.            url: str

17.            ):

19.    self.title = title

20.    self.episode_id = episode_id

21.    self.opening_crawl= opening_crawl

22.    self.director = director

23.    self.producer = producer

24.    self.release_date = release_date

25.    self.characters = characters

26.    self.planets = planets

27.    self.starships = starships

28.    self.vehicles = vehicles

29.    self.species = species

30.    self.created = created

31.    self.edited = edited

32.    self.url = url

34.    if type(self.release_date) is str:

35.       self.release_date = dateutil.parser.parse(self.release_date)

37.    if type(self.created) is str:

38.       self.created = dateutil.parser.parse(self.created)

40.    if type(self.edited) is str:

41.       self.edited = dateutil.parser.parse(self.edited)

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

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

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

1. @dataclass

2. class StarWarsMovie:

3.   title: str

4.   episode_id: int

5.   opening_crawl: str

6.   director: str

7.   producer: str

8.   release_date: datetime

9.   characters: List[str]

10.   planets: List[str]

11.   starships: List[str]

12.   vehicles: List[str]

13.   species: List[str]

14.   created: datetime

15.   edited: datetime

16.   url: str

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

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

1. def __post_init__(self):

2.   if type(self.release_date) is str:

3.       self.release_date = dateutil.parser.parse(self.release_date)

5.   if type(self.created) is str:

6.       self.created = dateutil.parser.parse(self.created)

8.   if type(self.edited) is str:

9.       self.edited = dateutil.parser.parse(self.edited)

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

更多好东西

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

1. @dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)

init决定是否生成init dunder 方法 repr决定是否生成repr dunder方法 eq对eq dunder 方法也是如此，它决定相等性检查的行为（yourclassinstance == another_instance） order 实际上创建了四种 dunder 方法，它们确定所有检查小于，and/or，大于的行为，如果将其设置为 true，则可以对对象列表进行排序。 最后两个选项确定对象是否可以被哈希化，如果你想使用你的 class 的对象作为字典键的话，这是必要的。

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