使用导入的类方法进行的Python类型提示

问题描述

this answer建议在class级别使用import命令来加载其定义可以移动到其他模块的方法。作为一个最小的例子，

class_def.py：

class C:
    from _methods import m

_methods.py：

def m(self):
    return "hello"

通常，大多数功能代码完成的IDE都会将某些类中定义的函数识别为绑定方法，self将被自动识别为具有定义该方法的类的类型。遗憾的是，在上述情况下，我没有在类中定义m。仅从_methods.py无法判断self应该具有C类型。

在m的定义中，如果插入以self.开头的行，则我的IDE无法建议m或我可能在C中实现的任何其他方法。

显而易见的解决方案是添加类型提示：

from class_def import C

def m(self: C):
    return "hello"

但现在我们有了循环导入：C导入_methods，但_methods导入C的定义。如何在不引入循环导入的情况下创建类型提示？

我当前使用的是Python3.7，但我也对需要更高版本的解决方案感兴趣。

---

解决方案

1. 通过使用typing.TYPE_CHECKING标志仅在类型检查期间导入C修复循环导入。

2. 这将使C的值在运行时未定义。将其引起来("C")或导入__future__.annotations：

_methods.py变体1：

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from class_def import C

def m(self: "C"):
    return "hello"

_methods.py变体2：

from __future__ import annotations
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from class_def import C

def m(self: C):
    return "hello"