28

我试图找到一种可靠/跨版本(3.5+)的方法来检查类型注释是否是给定泛型类型的“子类”(即从类型注释对象中获取泛型类型)。

在 Python 3.5 / 3.6 上,它可以轻而易举地工作,正如您所期望的:

>>> from typing import List

>>> isinstance(List[str], type)
True

>>> issubclass(List[str], List)
True

在 3.7 上,看起来泛型类型的实例不再是 的实例type,所以它会失败:

>>> from typing import List

>>> isinstance(List[str], type)
False

>>> issubclass(List[str], List)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/lib/python3.7/typing.py", line 716, in __subclasscheck__
    raise TypeError("Subscripted generics cannot be used with"
TypeError: Subscripted generics cannot be used with class and instance checks

想到的其他想法是检查实际的实例类型,但是:

Python 3.6 / 3.5:

>>> type(List[str])
<class 'typing.GenericMeta'>

蟒蛇 3.7:

>>> type(List[str])
<class 'typing._GenericAlias'>

但这并没有真正进一步表明哪个是实际的泛型类型(可能不是 List);此外,以这种方式进行检查感觉非常错误,特别是因为_GenericAliasnow 变成了“私有”类型(注意下划线)。

可以检查的另一件事是__origin__关于类型的参数,但这也不是正确的方法。

它在 3.7 上仍然不同:

>>> List[str].__origin__
<class 'list'>

而 3.5 / 3.6:

>>> List[str].__origin__
typing.List

我一直在寻找这样做的“正确”方式,但在 Python 文档/谷歌搜索中没有找到它。

现在,我假设必须有一种干净的方式来进行这种检查,因为像 mypy 这样的工具会依赖它来进行类型检查..?

更新:关于用例

好的,在这里添加更多上下文..

因此,我的用例是对函数签名(参数类型/默认值、返回类型、文档字符串)使用自省来自动为它们生成 GraphQL 模式(从而减少样板的数量)。

对于这是否是一个好主意,我仍然有点担心。

从可用性的角度来看,我喜欢它(无需学习另一种声明函数签名的方法:只需以通常的方式注释您的类型);请参阅此处的两个代码示例以了解我的意思:https ://github.com/rshk/pyql

我想知道以这种方式使用类型支持泛型类型(列表、字典、联合......)是否typing会增加太多“黑魔法”,这可能会以意想不到的方式破坏。(目前这不是一个大问题,但是未来的 Python 版本,超过 3.7 版本呢?这会成为维护的噩梦吗?)。

当然,替代方法是只使用支持更可靠/面向未来的检查的自定义类型注释,例如:https://github.com/rshk/pyql/blob/master/pyql/schema/types/core。 py#L337-L339

..但不利的一面是,这将迫使人们记住他们必须使用自定义类型注释。此外,我不确定 mypy 将如何处理(我认为需要在某处声明自定义类型与typing.List.. 完全兼容?听起来仍然很骇人听闻)。

(我主要是在寻求有关这两种方法的建议,最重要的是我可能错过的两种选择的任何优点/缺点。希望这不会变得“太宽泛”。)。

4

3 回答 3

11

首先:没有定义 API 来检查typing模块定义的类型提示对象。类型提示工具应该在运行时处理源代码,即文本,而不是 Python 对象;mypy不自省List[str]对象,而是处理源代码的已解析抽象语法树

因此,虽然您始终可以访问诸如 之类的属性__origin__,但您实际上是在处理实现细节(内部簿记),并且这些实现细节可以并且将会随着版本的变化而变化。

也就是说,核心 mypy / typing 贡献者创建了typing_inspect模块来开发类型提示的自省 API。该项目仍然将自己记录为实验性的,您可以期望它也会随着时间而改变,直到它不再是实验性的。它不会在这里解决您的问题,因为它不支持 Python 3.5,并且它的函数返回属性提供get_origin()的完全相同的值。__origin__

排除所有这些警告后,您想要在 Python 3.5 / Python 3.6 上访问的是__extra__属性;这是用于驱动库最初实现的issubclass()/支持的基本内置类型(但在 3.7 中已删除):isinstance()

def get_type_class(typ):
    try:
        # Python 3.5 / 3.6
        return typ.__extra__
    except AttributeError:
        # Python 3.7
        return typ.__origin__

无论如何,这会<class 'list'>在 Python 3.5 及更高版本中产生。它仍然使用内部实现细节,并且很可能在未来的 Python 版本中中断。

于 2019-01-17T17:47:03.237 回答
9

Python 3.8 添加typing.get_origin()typing.get_args()支持基本的自省。

这些 API 也已在https://pypi.org/project/typing-compat/中向后移植到 Python >=3.5 。

请注意,typing.get_args当在裸泛型上调用时, 3.7 中的行为仍然略有不同;在 3.8typing.get_args(typing.Dict)中是(),但在 3.7 中(~KT, ~VT)(对于其他泛型也类似),其中~KT~VT是 类型的对象typing.TypeVar

于 2019-10-14T17:10:54.167 回答
0
pip install typing_utils

然后

>>> typing_utils.issubtype(typing.List[int], list)
True

>>> typing_utils.issubtype(typing.List, typing.List[int])
False

typing_utils也向后移植typing.get_origintyping.get_args从 Python 3.8 到 3.6+。

于 2020-11-21T08:46:33.167 回答