如何使用封闭类的类型键入提示方法？

Question

我在Python 3中有以下代码：

class Position:

    def __init__(self, x: int, y: int):
        self.x = x
        self.y = y

    def __add__(self, other: Position) -> Position:
        return Position(self.x + other.x, self.y + other.y)

但是我的编辑器（PyCharm）说引用位置不能解析（在__add__方法中）。我应该如何指定我期望的返回类型是类型位置？

编辑：我认为这实际上是一个问题。它实际上在警告和代码完成中使用了这些信息。

但是如果我错了，请纠正我，并且需要使用其他语法。

Answer 1

在解析类主体本身时，名称“Position”不可用。我不知道您是如何使用类型声明的，但是Python的PEP 484——如果使用这些类型提示，大多数模式都应该使用PEP 484，它表示您可以在此时将名称作为字符串：

def __add__(self, other: 'Position') -> 'Position':
    return Position(self.x + other.x, self.y + other.y)

检查关于转发引用的PEP 484部分——符合该部分的工具将知道从那里打开类名并加以利用。（记住Python语言本身对这些注释不做任何事情总是很重要的。它们通常用于静态代码分析，或者在运行时可以有一个用于类型检查的库/框架，但是你必须显式地设置它。）

更新：另外，从Python 3.7开始，请查看PEP 563。从Python3.8开始，可以从未来导入注释编写，以推迟注释的评估。前向引用类应该直接工作。

Answer 2

将类型指定为字符串是可以的，但总是让我有点恼火，因为我们基本上绕过了解析器。所以你最好不要拼错这些字串中的任何一个：

def __add__(self, other: 'Position') -> 'Position':
    return Position(self.x + other.x, self.y + other.y)

一个微小的变化是使用绑定的typevar，至少在声明typevar时只需编写一次字符串：

from typing import TypeVar

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

class Position:

    def __init__(self, x: int, y: int):
        self.x = x
        self.y = y

    def __add__(self, other: T) -> T:
        return Position(self.x + other.x, self.y + other.y)

Answer 3

TL；DR：从今天（2019年）开始，在Python 3.7中，您必须使用来自__future__导入注释的“未来”语句打开此功能。

（从__future__导入注释中启用的行为可能会成为Python未来版本的默认值，并将在Python 3.10中成为默认值。然而，3.10中的更改在最后一刻被恢复，现在可能根本不会发生。）

在Python3.6或更低版本中，应该使用字符串。

我猜你得到了这个例外：

NameError: name 'Position' is not defined

这是因为在注释中使用位置之前必须定义它，除非您使用启用PEP 563更改的Python。

Python 3.7引入了PEP 563：注释的延迟评估。使用来自_future _导入注释的future语句的模块将自动将注释存储为字符串：

from __future__ import annotations

class Position:
    def __add__(self, other: Position) -> Position:
        ...

这原本计划成为Python3.10中的默认设置，但是现在这个更改被推迟了。因为Python仍然是一种动态类型化语言，所以在运行时不会进行类型检查，所以类型注释应该不会对性能产生影响，对吗？错误的在Python3.7之前，typing模块曾经是核心中速度最慢的Python模块之一，因此对于涉及导入typing模块的代码，当升级到3.7时，您将看到性能提高多达7倍。

根据PEP 484，您应该使用字符串而不是类本身：

class Position:
    ...
    def __add__(self, other: 'Position') -> 'Position':
       ...

如果您使用Django框架，这可能很熟悉，因为Django模型也使用字符串作为正向引用（外键定义，其中外键模型是self或尚未声明）。这应该与Pycharm和其他工具配合使用。

PEP 484和PEP 563的相关部分，为免您出行：

当类型提示包含尚未定义的名称时，该定义可以表示为字符串文本，稍后进行解析。

这种情况通常发生在容器类的定义中，其中正在定义的类出现在一些方法的签名中。例如，以下代码（简单二叉树实现的开始）不起作用：

class Tree:
    def __init__(self, left: Tree, right: Tree):
        self.left = left
        self.right = right

为了解决这个问题，我们写道：

class Tree:
    def __init__(self, left: 'Tree', right: 'Tree'):
        self.left = left
        self.right = right

字符串文本应该包含一个有效的Python表达式（即compile（lit），“eval”）应该是一个有效的代码对象，并且在模块完全加载后，它应该无错误地进行计算。在其中求值的本地和全局名称空间应该是相同的名称空间，相同函数的默认参数将在其中求值。

和政治公众人物563：

在Python3.10中，函数和变量注释将不再在定义时进行计算。相反，字符串形式将保留在相应的

...

可以使用以下特殊导入从Python 3.7开始启用上述功能：

from __future__ import annotations

在类定义之前，放置一个虚拟定义：

class Position(object):
    pass


class Position(object):
    ...

这将消除名称错误，甚至看起来还可以：

>>> Position.__add__.__annotations__
{'other': __main__.Position, 'return': __main__.Position}

但是真的吗？

>>> for k, v in Position.__add__.__annotations__.items():
...     print(k, 'is Position:', v is Position)                                                                                                                                                                                                                  
return is Position: False
other is Position: False

您可能希望尝试一些Python元编程魔术，并编写一个修饰符来修补类定义，以便添加注释：

class Position:
    ...
    def __add__(self, other):
        return self.__class__(self.x + other.x, self.y + other.y)

装潢师应负责以下等效事项：

Position.__add__.__annotations__['return'] = Position
Position.__add__.__annotations__['other'] = Position

至少看起来是对的：

>>> for k, v in Position.__add__.__annotations__.items():
...     print(k, 'is Position:', v is Position)                                                                                                                                                                                                                  
return is Position: True
other is Position: True

可能太麻烦了。