小编典典

如何键入提示具有封闭类类型的方法?

all

我在 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__方法中)。我应该如何指定我期望返回类型是 type
Position

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

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


阅读 119

收藏
2022-03-01

共1个答案

小编典典

TL;DR :从今天(2019 年)开始,在 Python 3.7+ 中,您必须使用“未来”语句打开此功能,from __future__ import annotations.

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

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


我猜你有这个例外:

NameError: name 'Position' is not defined

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

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后typing,您将看到性能提升多达 7
倍。

Python <3.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’)
应该是一个有效的代码对象),并且一旦模块完全加载,它应该不会出错。评估它的本地和全局命名空间应该是相同的命名空间,其中将评估同一函数的默认参数。

和 PEP 563:

执行

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

[在 Python 3.7

中启用未来行为](https://www.python.org/dev/peps/pep-0563/#enabling-the-future-
behavior-in-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. Monkey-patch 为了添加注释:

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

大概是太麻烦了。

2022-03-01