循環インポートなしのPython型ヒント

私は私の巨大なクラスを2つに分割しようとしています。ええと、基本的には「メイン」クラスと、次のような追加機能を備えたミックスインに入れます。

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。

私はPython 3.4を使用していますが、そこでソリューションが利用可能な場合は喜んで3.5に移行します。

クラスを2つのファイルに分割し、すべての「接続」を保持して、IDEが自動補完と、タイプを知っていることから来る他のすべての便利な機能を提供できる方法はありますか？

一般に、インポートサイクルを処理するための非常にエレガントな方法はありません。コードを再設計して循環依存関係を削除するか、それが可能でない場合は、次のようにします。

# 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):
        ...

from __future__ import annotationsインポートは行います、すべてのタイプのヒントは文字列で、それらを評価するスキップ。これにより、コードを少し人間工学的にすることができます。

そうは言っても、mypyでミックスインを使用するには、おそらく現在よりも少し多くの構造が必要になります。Mypy は、基本的にdecezeは記述されているアプローチをお勧めします- MainとMyMixinクラスの両方が継承するABCを作成します。Pycharmのチェッカーを幸せにするために同様のことをする必要があったとしても、私は驚かないでしょう。

タイプチェックのためだけにクラスをインポートするときに循環インポートに苦労している人のために：前方参照を使用することになるでしょう（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

より大きな問題は、あなたの型はそもそも正気ではないということです。MyMixinに混合されるというハードコードされた仮定をしますMain他の任意の数のクラスに混合される可能性があり、その場合はおそらく壊れます。ミックスインが1つの特定のクラスに混合されるようにハードコーディングされている場合は、メソッドを分離するのではなく、そのクラスに直接メソッドを書き込むこともできます。

正しいタイピングでこれを適切に行うにはMyMixin、インターフェース、または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')

私の最初の試みも解決策に非常に近いことがわかりました。これは私が現在使用しているものです：

# main.py
import mymixin.py

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


# mymixin.py
if False:
    from main import Main

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

インポートされるif Falseことのないステートメント内のimport （ただし、IDEはそれについて知っている）とMain、実行時にクラスが不明であるため、クラスを文字列として使用することに注意してください。

完璧な方法は、すべてのクラスと依存関係をファイル（のように__init__.py）にインポートしてからfrom __init__ import *、他のすべてのファイルにインポートすることです。

この場合、あなたは

1. これらのファイルとクラスへの複数の参照を回避し、
2. また、他の各ファイルに1行追加するだけで、
3. 3番目は、使用する可能性のあるすべてのクラスを知っているpycharmです。