如何在Python中创建自己的“参数化”类型(如`Optional [T]`)?

时间:2017-09-23 17:08:48

标签: python python-3.x generics metaclass type-hinting

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

class MaybeWrapped:
    # magic goes here

T = TypeVar('T')

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

别介意人为的例子;我该如何实现呢?我查看了Union和Optional的源代码,但它看起来像是一些我想要避免的相当低级的hackery。

文档中唯一的建议来自example re-implementation of Mapping[KT,VT] that inherits from Generic。但是这个例子更多地是关于__getitem__方法而不是类本身。

3 个答案:

答案 0 :(得分: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

答案 1 :(得分:2)

我想基于@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

答案 2 :(得分:1)

如果您只是尝试创建通用类或函数,请尝试查看documentation on mypy-lang.org about generic types - 它相当全面,并且比标准库类型文档更详细。< / p>

如果您正在尝试实施您的具体示例,那么值得指出type aliases work with typevars - 您可以这样做:

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有一个实验&#34;插件&#34;系统)
  3. 请求修改PEP 484以包含您的新自定义类型(您可以通过在typing module repo中打开一个问题来执行此操作。)