类型 "Type[Array]" 不是泛型且不可索引。

Question

该程序：

class Array:
    def __init__(self, underlying):
        self.underlying = underlying

    def __class_getitem__(cls, key):
        return Array(key)

    def __getitem__(self, key):
        pass

    def __str__(self):
        return f"Array({self.underlying=})"

def foo(name, kind):
    pass

foo(name="x", kind=Array["int"])

在运行 mypy 检查时会收到如下错误提示：

x.py:17: error: The type "Type[Array]" is not generic and not indexable  [misc]

这个 __getitem__ 方法是我尝试添加的，看看能否解决问题（但实际上并未奏效）。在这里，我并不打算将 Array 作为类型（在 typing 意义上）来使用，只是想用一种简洁的方式来传递某种数组类型的表示。

那么，这个 mypy 错误是什么意思？除了使用 # ignore 注释之外，还有其他方法可以修复这个问题吗？

James Donnelly · Answer

我注意到您希望利用__class_getitem__方法以可爱的语法形式传递数组类型，但实际上，根据Python官方文档的描述，__class_getitem__方法主要用于类型提示，并不推荐在非类型提示场景下使用。

引用Python 3参考文档：

classmethod object.__class_getitem__(cls, key)

返回一个对象，表示通过在key中找到类型参数对通用类进行特化的情况。

以及更具体的说明：

将__class_getitem__()用于除类型提示以外的任何类的目的都是不推荐的。

因此，不幸的是，您所期望的做法在这里不可行。建议您采用常规构造器语法，即Array("int")来创建实例。

另外，需要指出的是，特殊方法应遵循其明确规定用途，避免误用：

任何上下文中对__*__名称的任何不符合明确文档说明的使用，都可能在未来无预警地导致代码失效。

Seth Ladd · Answer

如前所述，__class_getitem__方法确实保留用于处理类型提示中的泛型。不过，未被保留且依然可用的是元类的__getitem__方法，它允许您提供类似的API。

利用这个特性，您可以为示例引入一个带有__getitem__方法的虚拟元类，从而使代码能够通过类型检查器的验证。以下是一个例子（在mypy Playground和Pyright Playground中可运行）：

from __future__ import annotations

import typing_extensions as t

if t.TYPE_CHECKING:    
    class _ArrayMeta(type):
        def __getitem__(self, key: str, /) -> Array: ...
else:
    _ArrayMeta = type


class Array(metaclass=_ArrayMeta):
    # 其余代码保持不变
    def __init__(self, underlying):
        self.underlying = underlying

    def __str__(self):
        return f"Array({self.underlying=})"

    def __class_getitem__(cls, key) -> Array:
        return Array(key)

def foo(name, kind):
    pass

测试示例：

>>> foo(name="x", kind=Array["int"])  # 类型检查通过
>>> reveal_type(Array["int"])  # 显示类型为 `Array`