python 指定返回类型_如何指定方法的返回类型与python中的类本身相同？

Paulo Scardi..

408

TL; DR:如果您使用的是Python 4.0,它就可以了.截至今天(2019年)的3.7+,您必须使用future语句(from __future__ import annotations)来启用此功能- 对于Python 3.6或更低版本,使用字符串.

我猜你有这个例外:

NameError: name 'Position' is not defined

这是因为Position必须先定义才能在注释中使用它,除非您使用的是Python 4.

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 4.0中的默认设置.由于Python仍然是动态类型语言,因此在运行时不进行类型检查,因此键入注释应该不会对性能产生影响,对吧？错误!在python 3.7之前,输入模块曾经是核心中最慢的python模块之一,所以如果你升级到3.7时你import 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表达式(即,编译(点亮,'','eval')应该是一个有效的代码对象)并且一旦模块完全加载就应该评估没有错误.在其中计算它的本地和全局命名空间应该是相同的命名空间,在该命名空间中将评估同一函数的默认参数.

和PEP 563:

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

...

可以使用以下特殊导入从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

可能太麻烦了.

结论

如果您使用的是3.6或更低版本,请使用包含类名的字符串文字,在3.7中使用from __future__ import annotations它就可以了.

>如果您使用的是Python 4.0，那么顺便说一句，您见过Sarah Connor吗？:) (6认同)