如何获得Python 3.7新的数据类字段类型?

时间:2018-08-21 10:22:45

标签: python python-dataclasses

Python 3.7引入了称为数据类的新功能。

from dataclasses import dataclass

@dataclass
class MyClass:
    id: int = 0
    name: str = ''

在函数参数中使用类型提示(注释)时,可以使用inspect模块轻松获得带注释的类型。如何获取数据类字段类型?

3 个答案:

答案 0 :(得分:12)

检查__annotations__会为您提供原始注释,但是这些注释不一定与数据类的字段类型相对应。诸如ClassVar和InitVar之类的内容显示在__annotations__中,即使它们不是字段,也不会显示继承的字段。

相反,在数据类上调用dataclasses.fields,然后检查字段对象:

field_types = {field.name: field.type for field in fields(MyClass)}

__annotations__fields都不会解析字符串注释。如果要解析字符串注释,最好的方法可能是typing.get_type_hintsget_type_hints将包括ClassVars和InitVars,因此我们使用fields来过滤掉它们:

resolved_hints = typing.get_type_hints(MyClass)
field_names = [field.name for field in fields(MyClass)]
resolved_field_types = {name: resolved_hints[name] for name in field_names}

答案 1 :(得分:3)

from dataclasses import dataclass

@dataclass
class MyClass:
    id: int = 0
    name: str = '' 

myclass = MyClass()

myclass.__annotations__
>> {'id': int, 'name': str}
myclass.__dataclass_fields__
>> {'id': Field(name='id',type=<class 'int'>,default=0,default_factory=<dataclasses._MISSING_TYPE object at 0x0000000004EED668>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD),
 'name': Field(name='name',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object at 0x0000000004EED668>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD)}

在旁注中还有:

myclass.__dataclass_params__
>>_DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False)

答案 2 :(得分:1)

dataclasses.py模块,它提供装饰器和用于通过使用字段注释生成常规类方法的功能。这意味着在处理完类之后,应使用PEP 526 Syntax of Variable annotations来形成用户定义的字段。模块注释可通过__annotations__访问。

根据Runtime effects of type annotations,可以通过__annotations__属性或通过使用typing.get_type_hints(建议使用最后一个)来访问带注释的类型。

请在下面查看一些代码示例:

from typing import Dict, ClassVar, get_type_hints
from dataclasses import dataclass

@dataclass
class Starship:
    hitpoints: int = 50


get_type_hints(Starship) // {'hitpoints': int}
Starship.__annotations__ // {'hitpoints': int}
dataclasses.__annotations__ // The annotations of the dataclasses module.
get_type_hints(get_type_hints)