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

Question

我想从（数据）class 中读取所有属性 及其类型 ，如所需（伪）代码所示：

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

我检查了几个answers，但还没有找到我需要的。

有什么想法吗？提前致谢！

Answer 1

看看这个：

from dataclasses import dataclass

@dataclass
class Point:
    x: int
    y: int

Point.__annotations__ returns {'x': <class 'int'>, 'y': <class 'int'>}.

Answer 2

对于一般的 classes，您可以访问 __annotations__:

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

这个returns一个dict映射属性名到注解。

然而，dataclasses 已经使用 dataclass.field 对象来封装大量此类信息。您可以在实例或 class:

上使用 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))

注意：

Starting in Python 3.7, the evaluation of annotations can be postponed:

>>> 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 的类型提示：

>>> 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，其中定义了 class[=61] =].因此，请考虑：

(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'>

但它可能会变得棘手

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

Python: How to get attributes and their type from a dataclass?

python

oop

python-dataclasses