类型提示中的子类

Question

我希望允许使用Python 3进行类型提示以接受某个类的子类。例如。：

class A:
    pass

class B(A):
    pass

class C(A):
    pass

def process_any_subclass_type_of_A(cls: A):
    if cls == B:
        # do something
    elif cls == C:
        # do something else

现在当键入以下代码时:

process_any_subclass_type_of_A(B)

我收到一个 PyCharm IDE 提示“预期的类型 A，而是获得类型 [B]。

如何在这里更改类型提示以接受？

根据PEP 484(“类型为特定参数类型的子类型的表达式也可用于该参数。”)，我知道我的解决方案< code>(cls: A)应该可以工作？

Answer 1

如果您希望您的函数只接受子类，您应该使用NewTypehttps://docs.python.org/3/library/typing.html#newtype，因为Type[A]也接受类本身，这并不总是需要的。

Answer 2

如果我们查看typing模块中的Type描述，那么我们会看到以下文档：

一种特殊的构造，可用于注释类对象。

例如，假设我们有以下类：

 class User: ...  # Abstract base for User classes
 class BasicUser(User): ...
 class ProUser(User): ...
 class TeamUser(User): ...

以及一个函数，它接受User的子类的类参数，并返回相应类的实例:

 U = TypeVar('U', bound=User)
 def new_user(user_class: Type[U]) -> U:
     user = user_class()
     # (Here we could write the user object to a database)
     return user

 joe = new_user(BasicUser)

此时，类型检查器知道joe具有Basicuser类型。

基于此，我可以想象一个合成示例来重现 PyCharm 中类型提示错误的问题。

from typing import Type, Tuple

class BaseClass: ...

class SubClass(BaseClass): ...
class SubSubClass(SubClass): ...

def process(model_instance: BaseClass, model_class: Type[BaseClass]) -> Tuple[BaseClass, BaseClass]:
    """ Accepts all of the above classes """
    return model_instance, model_class()


class ProcessorA:
    @staticmethod
    def proc() -> Tuple[SubClass, SubClass]:
        """ PyCharm will show an error 
        `Expected type 'tuple[SubClass, SubClass]', got 'tuple[BaseClass, BaseClass]' instead` """
        return process(SubClass(), SubClass)


class ProcessorB:
    @staticmethod
    def proc() -> Tuple[SubSubClass, SubSubClass]:
        """ PyCharm will show an error 
        `Expected type 'tuple[SubSubClass, SubSubClass]', got 'tuple[BaseClass, BaseClass]' instead` """
        return process(SubSubClass(), SubSubClass)

但是我们在 Type 的文档中看到，可以通过使用带有绑定参数的 TypeVar 来纠正这种情况。然后在将 BaseClass 声明为类型的地方使用它。

from typing import TypeVar, Type, Tuple

class BaseClass: ...

B = TypeVar('B', bound=BaseClass)

class SubClass(BaseClass): ...
class SubSubClass(SubClass): ...

def process(model_instance: B, model_class: Type[B]) -> Tuple[B, B]:
    """ Accepts all of the above classes """
    return model_instance, model_class()


class ProcessorA:
    @staticmethod
    def proc() -> Tuple[SubClass, SubClass]:
        return process(SubClass(), SubClass)


class ProcessorB:
    @staticmethod
    def proc() -> Tuple[SubSubClass, SubSubClass]:
        return process(SubSubClass(), SubSubClass)

希望这会有所帮助。

Answer 3

当您指定 cls： A 时，您是在说 cls 需要类型 A 的实例。将 cls 指定为类型 A（或其子类型）的类对象的类型提示使用类型。类型。

from typing import Type
def process_any_subclass_type_of_A(cls: Type[A]):
    pass

从类对象的类型来看:

有时您想谈论继承自给定类的类对象。这可以拼写为Type[C]，其中C是一个类。换句话说，当C是一个类的名称时，使用C注释参数声明该参数是C（或C的子类）的实例，但使用Type[C]作为参数注释声明该参数是派生自C（或C本身）的类对象。