如何键入带有封闭类类型的方法的 hint?前向引用实现

我在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)说引用无法解析(在方法中)。我应该如何指定我期望返回类型为类型?Position__add__Position

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

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


答案 1

TL;DR:截至今天(2019年),在Python 3.7 +中,您可以使用“future”语句打开此功能。from __future__ import annotations

(启用的行为可能会成为未来版本的Python中的默认值,并且将成为Python 3.10中的默认值。但是,3.10 中的更改在最后一刻被还原,现在可能根本不会发生。from __future__ import annotations

在Python 3.6或更低版本中,您应该使用字符串。


我猜你得到了这个例外:

NameError: name 'Position' is not defined

这是因为必须先定义,然后才能在注释中使用它,除非您使用的是启用了 PEP 563 更改的 Python。Position

Python 3.7+:from __future__ import annotations

Python 3.7 引入了 PEP 563:延迟的注释评估。使用 future 语句的模块会自动将注释存储为字符串:from __future__ import annotations

from __future__ import annotations

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

这原计划成为Python 3.10中的默认设置,但此更改现已推迟。由于Python仍然是一种动态类型语言,因此在运行时不会进行类型检查,因此键入注释应该不会影响性能,对吧?错!在Python 3.7之前,类型化模块曾经是核心中最慢的python模块之一,因此对于涉及导入类型模块的代码,当您升级到3.7时,您会看到性能提高了7倍

Python <3.7:使用字符串

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

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

如果您使用Django框架,这可能很熟悉,因为Django模型也使用字符串作为前向引用(外键定义,其中外键定义外来模型尚未声明)。这应该与Pycharm和其他工具一起使用。self

来源

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')应该是一个有效的代码对象),并且在模块完全加载后,它应该无错误地进行评估。在其中计算它的本地命名空间和全局命名空间应与计算同一函数的默认参数的命名空间相同。

和 PEP 563:

实现

在Python 3.10中,函数和变量注释将不再在定义时计算。相反,字符串形式将保留在相应的字典中。静态类型检查器在行为上看不到任何差异,而在运行时使用注释的工具将不得不执行延迟的评估。__annotations__

...

在 Python 3.7 中启用未来行为

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

from __future__ import annotations

你可能会想做的事情

A. 定义虚拟对象Position

在类定义之前,放置一个虚拟定义:

class Position(object):
    pass


class Position(object):
    ...

这将摆脱,甚至可能看起来还行:NameError

>>> 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

B.猴子补丁为了添加注释:

你可能想尝试一些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

可能太麻烦了。


答案 2

从Python 3.11(将于2022年底发布)开始,您将能够使用Self作为返回类型。

from typing import Self


class Position:

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

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

Self也包含在软件包中(在PyPi上可用),虽然不是标准库的一部分,但它是该模块的“预览”版本。从 https://pypi.org/project/typing-extensions/typing-extensionstyping

typing_extensions模块有两个相关用途:

  • 在较旧的 Python 版本上启用新类型系统功能。例如,键入。TypeGuard是Python 3.10中的新功能,但typing_extensions允许Python 3.6至3.9上的用户使用它。
  • 在接受新类型系统 PEP 并将其添加到键入模块之前,使用它们进行试验。

目前,官方支持Python 3.7及更高版本。typing-extensions