没有循环导入的Python类型提示

Question

我试图把我庞大的班级一分为二；好的，基本上分为“main”类和带有附加函数的mixin，如下所示：

main。py文件：

import mymixin.py

class Main(object, MyMixin):
    def func1(self, xxx):
        ...

mymixin。py文件：

class MyMixin(object):
    def func2(self: Main, xxx):  # <--- note the type hint
        ...

现在，虽然这很好，但是MyMixin中的类型提示。func2当然不能工作。我无法导入main。py，因为我会得到一个循环导入，并且没有提示，我的编辑器（PyCharm）无法分辨什么是self。

我使用的是Python3.4，但如果有解决方案，我愿意使用3.5。

有没有什么方法可以把我的类分成两个文件，并保留所有的“连接”，这样我的IDE仍然可以为我提供自动完成和所有其他知道类型的好东西？




Answer 1

更大的问题是你的类型一开始就不健全MyMixin硬编码假设它将混合到Main中，而它可以混合到任何数量的其他类中，在这种情况下，它可能会中断。如果您的mixin被硬编码为混合到一个特定的类中，那么您也可以将方法直接写入该类中，而不是将它们分离出来。

为了正确地使用正常的类型来完成这一操作，应该针对接口或Python术语中的抽象类进行编码：

import abc


class MixinDependencyInterface(abc.ABC):
    @abc.abstractmethod
    def foo(self):
        pass


class MyMixin:
    def func2(self: MixinDependencyInterface, xxx):
        self.foo()  # ← mixin only depends on the interface


class Main(MixinDependencyInterface, MyMixin):
    def foo(self):
        print('bar')

Answer 2

对于仅为类型检查而导入类时遇到循环导入困难的用户：您可能希望使用正向引用（PEP 484-类型提示）：

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

因此，不是：

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

Answer 3

恐怕没有一个非常优雅的方法来处理一般的导入周期。您可以选择重新设计代码以删除循环依赖关系，或者如果不可行，则执行以下操作：

# some_file.py

from typing import TYPE_CHECKING
if TYPE_CHECKING:
    from main import Main

class MyObject(object):
    def func2(self, some_param: 'Main'):
        ...

TYPE_CHECKING常量在运行时总是False，因此导入不会被计算，但是mypy（和其他类型检查工具）将计算该块的内容。

我们还需要将Main类型注释变成一个字符串，有效地向前声明它，因为Main符号在运行时不可用。

如果您使用的是Python 3.7，我们至少可以通过利用PEP 563来跳过必须提供显式字符串注释的问题：

# some_file.py

from __future__ import annotations
from typing import TYPE_CHECKING
if TYPE_CHECKING:
    from main import Main

class MyObject(object):
    # Hooray, cleaner annotations!
    def func2(self, some_param: Main):
        ...

来自未来导入注释的导入将使所有类型提示成为字符串，并跳过对它们的求值。这有助于使我们的代码稍微更符合人体工程学。

尽管如此，与mypy一起使用混合可能需要比您目前拥有的更多的结构。Mypy推荐了一种基本上就是deceze所描述的方法创建一个ABC，您的Main和MyMixin类都继承了这个ABC。如果你最终需要做类似的事情来让皮魅力的支票员开心，我不会感到惊讶。