Python 将类型提示字符串表示形式(来自文档字符串)转换为实际类型/打字对象

标签 python type-hinting docstring

我想知道是否有一个现有的实现可以将类型提示的字符串表示形式(例如从文档字符串)转换回类型(或打字)对象。因此,还应该支持任意深度嵌套类型(参见第三个示例)。

import typing import List, Optional, Union

converter_function("List[str]") == List[str]

converter_function("int") == int

converter_function("Optional[List[Union[str, float]]]") == Optional[List[Union[str,float]]]

converter_function("foobar") # Exception / None

一种选择是简单地使用 eval,但我想不惜一切代价避免这种情况:D

编辑 作为我为什么要这样做的背景:我想编写一个脚本来检查文档字符串是否与函数 100% 匹配、所有类型是否正确等等。

最佳答案

我能找到的最接近的东西(当然除了eval)是typing.get_type_hints。如果您的函数已正确进行类型注释,则 typing.get_type_hints 可以解析注释。它适用于字符串注释、任意嵌套类型和泛型类型;基本上任何有效的注释。例如:

from typing import List, Optional, Union, get_type_hints

def my_func(a: "List[str]", b: "int") -> "Optional[List[Union[str, float]]]":
    pass

print(get_type_hints(my_func))

你会得到

{'a': typing.List[str],
 'b': <class 'int'>,
 'return': typing.Optional[typing.List[typing.Union[str, float]]]}

在内部,get_type_hints 将字符串转换为 typing.ForwardRef,然后对它们进行求值。这些是私有(private) API,因此它们在 Python 版本中可能不稳定,但如果您只有注释字符串而没有函数,您可以尝试一下:

>>> from typing import ForwardRef, _eval_type

>>> _eval_type(ForwardRef("Optional[List[Union[str, float]]]"), globals(), globals())
typing.Optional[typing.List[typing.Union[str, float]]]

但此时,您可能会更好地使用 eval :P

关于Python 将类型提示字符串表示形式(来自文档字符串)转换为实际类型/打字对象,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/67500755/

相关文章:

python - 规则定义中 "threads"通配符的算术运算

python - 给定边缘拆分 DataFrame 的最佳方法

python - 如何将数字列表转换为重新格式化的字符串

python - 从 sqlite 查询中删除格式

Python 类型列表[Dict] 与列表[dict]

python - 在 Visual Studio 代码调试器中测试 Doctests

python - 将文档字符串放在特殊方法上?

php - php 中的对象类型提示

导入模块的 Python 类型提示

Python狮身人面像: How to embed code into a docstring?