如何在 Python 中创建自己的“参数化”类型（如 `Optional[T]`）？

Question

我想在 Python 中创建自己的参数化类型以用于类型提示：

class MaybeWrapped:
    # magic goes here

T = TypeVar('T')

assert MaybeWrapped[T] == Union[T, Tuple[T]]

别介意这个人为的例子；我怎样才能实现这个？我查看了 Union 和Optional 的源代码，但它看起来像是一些我想避免的相当低级的黑客行为。

文档中的唯一建议来自于继承自 Generic 的

Mapping[KT,VT]

的 示例重新实现。但这个例子更多的是关于

__getitem__

方法而不是类本身。

Answer 1

如果您只是想创建泛型类或函数，请尝试查看 mypy-lang.org 上有关泛型类型的文档——它相当全面，并且比标准库类型文档更详细。

如果您正在尝试实现您的特定示例，值得指出的是 类型别名与类型变量一起使用——您可以简单地执行以下操作：

from typing import Union, TypeVar, Tuple

T = TypeVar('T')

MaybeWrapped = Union[T, Tuple[T]]

def foo(x: int) -> MaybeWrapped[str]:
    if x % 2 == 0:
        return "hi"
    else:
        return ("bye",)

# When running mypy, the output of this line is:
# test.py:13: error: Revealed type is 'Union[builtins.str, Tuple[builtins.str]]'
reveal_type(foo(3))

但是，如果您尝试构建具有真正新语义的泛型类型，您很可能会运气不好。您剩下的选择是：

1. 构建某种符合 PEP 484 的类型检查器可以理解和使用的自定义类/元类。
2. 以某种方式修改您正在使用的类型检查器（例如，mypy 有一个实验性的“插件”系统）
3. 请求修改 PEP 484 以包含您的新自定义类型（您可以通过在 打字模块存储库中打开问题来完成此操作）。

Answer 2

这正是

__getitem__

方法的神奇之处。

这是当你用

[

和

]

括号订阅一个名字时调用的方法。

因此，您的类的类中需要一个

__getitem__

方法 - 即它的元类，它将获取括号内的任何内容作为参数。该方法负责动态创建（或检索缓存的副本）您想要生成的任何内容，然后返回它。

我无法想象您如何希望使用此类型提示，因为类型库似乎涵盖了所有合理的情况（我想不出他们尚未涵盖的示例）。但是，假设您希望一个类返回其自身的副本，但将参数注释为其

type_

属性：

class MyMeta(type):
    def __getitem__(cls, key):
        new_cls = types.new_class(f"{cls.__name__}_{key.__name__}", (cls,), {}, lambda ns: ns.__setitem__("type", key))
        return new_cls

class Base(metaclass=MyMeta): pass

在交互模式下尝试此操作时，可以这样做：

In [27]: Base[int]
Out[27]: types.Base_int

更新：从Python 3.7开始，还有一个专门为此目的而创建的特殊方法

__class_getitem__

：它充当类方法，避免了仅针对这种情况的需要或元类。无论在

metaclass.__getitem__

中写入什么，都可以直接放入

cls.__class_getitem__

方法中。定义于PEP 560

Answer 3

我想根据@jsbueno 的回答提出改进的解决方案。现在我们的“泛型”可以用于比较和身份检查，并且它们在键入时表现得像“真正的”泛型。我们还可以禁止非类型化类本身的实例化。而且！我们免费检查

isinstance

！

还满足

BaseMetaMixin

类进行完美的静态类型检查！

import types
from typing import Type, Optional, TypeVar, Union

T = TypeVar('T')


class BaseMetaMixin:
    type: Type


class BaseMeta(type):
    cache = {}

    def __getitem__(cls: T, key: Type) -> Union[T, Type[BaseMetaMixin]]:
        if key not in BaseMeta.cache:
            BaseMeta.cache[key] = types.new_class(
                f"{cls.__name__}_{key.__name__}",
                (cls,),
                {},
                lambda ns: ns.__setitem__("type", key)
            )

        return BaseMeta.cache[key]

    def __call__(cls, *args, **kwargs):
        assert getattr(cls, 'type', None) is not None, "Can not instantiate Base[] generic"
        return super().__call__(*args, **kwargs)


class Base(metaclass=BaseMeta):
    def __init__(self, some: int):
        self.some = some


# identity checking
assert Base[int] is Base[int]
assert Base[int] == Base[int]
assert Base[int].type is int
assert Optional[int] is Optional[int]

# instantiation
# noinspection PyCallByClass
b = Base[int](some=1)
assert b.type is int
assert b.some == 1

try:
    b = Base(1)
except AssertionError as e:
    assert str(e) == 'Can not instantiate Base[] generic'

# isinstance checking
assert isinstance(b, Base)
assert isinstance(b, Base[int])
assert not isinstance(b, Base[float])

exit(0)
# type hinting in IDE
assert b.type2 is not None # Cannot find reference 'type2' in 'Base | BaseMetaMixin'
b2 = Base[2]()  # Expected type 'type', got 'int' instead