当值是cls的实例时，是否可以注释返回类型？

Question

给定一个具有用于初始化的帮助器方法的类：

class TrivialClass:
    def __init__(self, str_arg: str):
        self.string_attribute = str_arg

    @classmethod
    def from_int(cls, int_arg: int) -> ?:
        str_arg = str(int_arg)
        return cls(str_arg)

是否可以从\u int方法注释的返回类型？

我尝试了cls和littleClass，但PyCharm将它们标记为未解析的引用，这在当时听起来是合理的。




Answer 1

注释返回类型的一种简单方法是使用字符串作为类方法返回值的注释：

# test.py
class TrivialClass:
  def __init__(self, str_arg: str) -> None:
    self.string_attribute = str_arg

  @classmethod
  def from_int(cls, int_arg: int) -> 'TrivialClass':
    str_arg = str(int_arg)
    return cls(str_arg)

这将通过mypy 0.560，并且python没有错误：

$ mypy test.py --disallow-untyped-defs --disallow-untyped-calls
$ python test.py

Answer 2

在Python3.7中，您可以使用\uuuu future\uuu。注释：

from __future__ import annotations


class TrivialClass:
    # ...

    @classmethod
    def from_int(cls, int_arg: int) -> TrivialClass:
        # ...
        return cls(...)

编辑：你不能子类TrivialClass而不覆盖类方法，但是如果你不需要这个，那么我认为它比前向引用更简洁。

Answer 3

匿名用户

使用泛型类型指示将返回cls的实例：

from typing import Type, TypeVar

T = TypeVar('T', bound='TrivialClass')

class TrivialClass:
    # ...

    @classmethod
    def from_int(cls: Type[T], int_arg: int) -> T:
        # ...
        return cls(...)

任何重写class方法但随后返回父类实例（LittleClass或仍然是祖先的子类）的子类都将被检测为错误，因为factory方法被定义为返回类型为cls的实例。

bound参数指定T必须是类的（子类）；因为在定义泛型时类还不存在，所以需要使用前向引用（一个名为的字符串）。

请参阅PEP 484的注释实例和类方法部分。

注意：这个答案的第一次修订提倡使用前向引用将类本身命名为返回值，但是第1212期使得使用泛型成为可能，这是一个更好的解决方案。

从Python 3.7开始，当您从导入注释开始使用__future__模块时，您可以避免在注释中使用前向引用，但是在模块级别创建TypeVar（）对象不是注释。即使在Python 3.10中也是如此，它在注释中推迟了所有类型提示解析。