Python：如何从数据类获取属性及其类型？

Question

我想从一个（数据）类中读取所有属性及其类型，就像这个期望的（伪）代码所示：

from dataclasses import dataclass


@dataclass
class HelloWorld:
    name: str = 'Earth'
    is_planet: bool = True
    radius: int = 6371


if __name__ == '__main__':
    attrs = get_attributes(HelloWorld)
    for attr in attrs:
        print(attr.name, attr.type)  # name, str

我查看了几篇答案，但还没有找到我需要的。

有任何想法吗？谢谢！

- Mr. B.

Answer 1

对于一般的类，您可以访问__annotations__：

>>> class Foo:
...    bar: int
...    baz: str
...
>>> Foo.__annotations__
{'bar': <class 'int'>, 'baz': <class 'str'>}

这将返回一个dict，其中包含属性名称与注释的映射。

然而，dataclasses使用dataclass.field对象来封装大量信息。您可以在实例或类上使用dataclasses.fields：

>>> import dataclasses
>>> @dataclasses.dataclass
... class Foo:
...     bar: int
...     baz: str
...
>>> dataclasses.fields(Foo)
(Field(name='bar',type=<class 'int'>,default=<dataclasses._MISSING_TYPE object at 0x7f806369bc10>,default_factory=<dataclasses._MISSING_TYPE object at 0x7f806369bc10>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD), Field(name='baz',type=<class 'str'>,default=<dataclasses._MISSING_TYPE object at 0x7f806369bc10>,default_factory=<dataclasses._MISSING_TYPE object at 0x7f806369bc10>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD))

注意:

从Python 3.7开始，注释的评估可以被推迟:

>>> from __future__ import annotations
>>> class Foo:
...     bar: int
...     baz: str
...
>>> Foo.__annotations__
{'bar': 'int', 'baz': 'str'} 

请注意，注释被保留为字符串，这也影响了dataclasses：

>>> @dataclasses.dataclass
... class Foo:
...     bar: int
...     baz: str
...
>>> dataclasses.fields(Foo)
(Field(name='bar',type='int',default=<dataclasses._MISSING_TYPE object at 0x7f806369bc10>,default_factory=<dataclasses._MISSING_TYPE object at 0x7f806369bc10>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD), Field(name='baz',type='str',default=<dataclasses._MISSING_TYPE object at 0x7f806369bc10>,default_factory=<dataclasses._MISSING_TYPE object at 0x7f806369bc10>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD))

因此，请注意，由于这将成为标准行为，您编写的代码应该使用__future__导入并在该假设下工作，因为在Python 3.10中，这将成为标准行为。

这种行为背后的动机是当前会引发错误的以下内容：

>>> class Node:
...    def foo(self) -> Node:
...        return Node()
...
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 2, in Node
NameError: name 'Node' is not defined

但是使用新的行为方式：

>>> from __future__ import annotations
>>> class Node:
...     def foo(self) -> Node:
...         return Node()
...
>>>

处理这个问题的一种方法是使用 typing.get_type_hints，我认为它基本上只是 eval 类型提示：

一种处理此问题的方式是使用 typing.get_type_hints，我相信它只是基本上执行了类型提示的eval。

>>> import typing
>>> typing.get_type_hints(Node.foo)
{'return': <class '__main__.Node'>}
>>> class Foo:
...    bar: int
...    baz: str
...
>>> Foo.__annotations__
{'bar': 'int', 'baz': 'str'}
>>> import typing
>>> typing.get_type_hints(Foo)
{'bar': <class 'int'>, 'baz': <class 'str'>}

我不确定这个函数的可靠性，但基本上它处理了获取适当的globals和locals在类被定义的地方。所以，请考虑：

(py38) juanarrivillaga@Juan-Arrivillaga-MacBook-Pro ~ % cat test.py
from __future__ import annotations

import typing

class Node:
    next: Node

(py38) juanarrivillaga@Juan-Arrivillaga-MacBook-Pro ~ % python
Python 3.8.5 (default, Sep  4 2020, 02:22:02)
[Clang 10.0.0 ] :: Anaconda, Inc. on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import test
>>> test.Node
<class 'test.Node'>
>>> import typing
>>> typing.get_type_hints(test.Node)
{'next': <class 'test.Node'>}

天真地想，您可能会尝试类似于：

>>> test.Node.__annotations__
{'next': 'Node'}
>>> eval(test.Node.__annotations__['next'])
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<string>", line 1, in <module>
NameError: name 'Node' is not defined

你可以拼凑出类似这样的东西：

>>> eval(test.Node.__annotations__['next'], vars(test))
<class 'test.Node'>

但这可能会变得棘手。

- juanpa.arrivillaga

Answer 2

看看这个：

from dataclasses import dataclass

@dataclass
class Point:
    x: int
    y: int

Point.__annotations__ 返回 {'x': <class 'int'>, 'y': <class 'int'>}。

该句话意思是，Point.__annotations__ 方法返回一个字典，其中键为 'x' 和 'y'，对应的值分别为整数类型。

- Julia