相対インポートの最上位パッケージエラーを超えて

python 3での相対インポートについてはすでにかなりの質問があるようですが、それらの多くを試しても、問題の答えがまだ見つかりませんでした。ここに質問があります。

以下に示すパッケージがあります

package/
   __init__.py
   A/
      __init__.py
      foo.py
   test_A/
      __init__.py
      test.py

そして私はtest.pyに1行あります：

from ..A import foo

今、私はのフォルダにいてpackage、実行します

python -m test_A.test

メッセージをもらいました

"ValueError: attempted relative import beyond top-level package"

しかし、私がの親フォルダにいるpackage場合、たとえば次のように実行します。

cd ..
python -m package.test_A.test

すべて順調。

私の質問は 、私がのフォルダーにいるときにpackage、test_Aサブパッケージ内のモジュールをとして実行するtest_A.testと、私の理解に基づいて、..Aまだpackageフォルダー内にある1レベルだけ上がるため、メッセージにと表示されますbeyond top-level package。このエラーメッセージの原因は何ですか？

編集：他の質問には、この質問に対するより良い/より一貫した答えがあります：

• 兄弟パッケージのインポート
• 10億回目の相対的な輸入

なぜ機能しないのですか？これは、Pythonがパッケージのロード元を記録しないためです。したがって、実行するとpython -m test_A.test、基本的にtest_A.testは実際に格納されているpackage（つまりpackage、パッケージとは見なされない）ナレッジが破棄されるだけです。しようとは、from ..A import fooこれ以上（ロードされた場所のつまり兄弟ディレクトリ）を持っていないアクセス情報にしようとしています。概念的にfrom ..os import pathは、のファイルでの許可と似ていますmath。パッケージを個別にしたいので、これは悪いことです。彼らが別のパッケージの何かを使用する必要がある場合、彼らはそれらをグローバルに参照しfrom os import path、Pythonがそれがどこにあるかを理解させる必要が$PATHあり$PYTHONPATHます。

を使用するとpython -m package.test_A.test、from ..A import foo何が入っているかを追跡しpackage、ロードされた場所の子ディレクトリにアクセスしているだけなので、を使用すると問題なく解決されます。

Pythonが現在の作業ディレクトリをパッケージと見なさないのはなぜですか？ NO CLUEは、しかし、おやっそれは有用であろう。

import sys
sys.path.append("..") # Adds higher directory to python modules path.

これを試して。私のために働いた。

仮定：
あなたがしている場合はpackage、ディレクトリ、Aおよびtest_A独立したパッケージです。

結論：
..Aインポートはパッケージ内でのみ許可されます。

詳細注記：
相対インポートをパッケージ内でのみ利用できるようにすると、パッケージをにある任意のパスに配置できるようにする場合に役立ちますsys.path。

編集：

これってめちゃくちゃだと思ってるのは私だけ！？なぜ現在の作業ディレクトリはパッケージと見なされないのですか？– マルチハンター

現在の作業ディレクトリは通常、sys.pathにあります。したがって、そこにあるすべてのファイルがインポート可能です。これは、パッケージがまだ存在しないPython 2以降の動作です。実行中のディレクトリをパッケージにすると、「インポート.A」および「インポートA」としてモジュールをインポートできるようになり、2つの異なるモジュールになります。多分これは検討すべき矛盾です。

これらの解決策はどれも3.6では機能せず、次のようなフォルダー構造でした。

package1/
    subpackage1/
        module1.py
package2/
    subpackage2/
        module2.py

私の目標は、module1からmodule2にインポートすることでした。ついに私にとってうまくいったのは、奇妙なことに、

import sys
sys.path.append(".")

これまでに説明した2ドットのソリューションとは対照的に、1つのドットに注意してください。

編集：以下は私にとってこれを明確にするのに役立ちました：

import os
print (os.getcwd())

私の場合、作業ディレクトリは（予期せず）プロジェクトのルートでした。

from package.A import foo

より明確だと思います

import sys
sys.path.append("..")

最も人気のある答えが示唆するように、基本的にあなたのためPYTHONPATHかはsys.path含んで.あなたのパッケージへのパスではなく。また、相対インポートは、インポートが発生するファイルではなく、現在の作業ディレクトリを基準にしています。奇妙に。

これを修正するには、まず相対インポートを絶対に変更してから、次のいずれかで開始します。

PYTHONPATH=/path/to/package python -m test_A.test

または、次の理由により、このように呼び出されたときにpythonパスを強制します。

python -m test_A.testあなたが実行しているtest_A/test.pyと__name__ == '__main__'し、__file__ == '/absolute/path/to/test_A/test.py'

つまり、メインのケース条件でtest.py絶対的なimportセミプロテクトを使用し、Pythonパスの操作を一度だけ行うことができます。

from os import path
…
def main():
…
if __name__ == '__main__':
    import sys
    sys.path.append(path.join(path.dirname(__file__), '..'))
    from A import foo

    exit(main())

編集：2020-05-08：引用したWebサイトは、アドバイスを書いた人によって制御されなくなったようです。そのため、サイトへのリンクを削除します。baxxについてお知らせいただきありがとうございます。

すでにすばらしい回答が提供されているにもかかわらず誰かがまだ少し苦労している場合、私はWebサイトで利用できなくなったアドバイスを見つけました。

私が言及したサイトからの本質的な引用：

「同じ方法でプログラムで指定できます。

インポートシステム

sys.path.append（ '..'）

もちろん、上記のコードは他のインポート 文の前に書く必要があります。

それがこのようにならなければならないことは明らかであり、事後に考えます。テストでsys.path.append（ '..'）を使用しようとしましたが、OPによって投稿された問題に遭遇しました。他のインポートの前にインポートとsys.path定義を追加することで、問題を解決することができました。

あなたが持っている場合は__init__.py、上のフォルダに、あなたはとしてインポートを初期化することができ import file/path as alias、そのinitファイルインチ 次に、それを下位スクリプトで次のように使用できます。

import alias

私の控えめな意見では、私はこの質問をこのように理解しています：

[ケース1]次のような絶対インポートを開始すると

python -m test_A.test

または

import test_A.test

または

from test_A import test

実際にインポートアンカーをに設定しています。つまりtest_A、最上位パッケージはtest_Aです。したがって、test.py do from ..A import xxxを実行すると、アンカーから脱出していることになります。Python ではこれを許可していません。

[ケース2]行うとき

python -m package.test_A.test

または

from package.test_A import test

あなたのアンカーはなりpackageそう、package/test_A/test.pyやってfrom ..A import xxx（まだ内部にアンカーをエスケープしていないpackageフォルダ）、およびPythonは喜んでこれを受け入れます。

要するに：

• Absolute-importは現在のアンカーを変更します（=トップレベルのパッケージを再定義します）。
• 相対インポートはアンカーを変更しませんが、それに限定します。

さらに、完全修飾モジュール名（FQMN）を使用して、この問題を検査できます。

いずれの場合もFQMNを確認します。

• [ケース2] test.__name__=package.test_A.test
• [ケース1] test.__name__=test_A.test

したがって、CASE2の場合、from .. import xxxaはFQMN =の新しいモジュールになりますがpackage.xxx、これは許容範囲です。

CASE1の場合、..from from .. import xxxはの開始ノード（アンカー）からジャンプしますがtest_A、これはPythonでは許可されていません。

Python 2.xではわかりませんが、Python 3.6では、スイート全体を実行しようとしていると仮定すると、使用する必要があります -t

-t、--top-level-directory directoryプロジェクトの最上位ディレクトリ（デフォルトは開始ディレクトリ）

したがって、次のような構造で

project_root
  |
  |----- my_module
  |          \
  |           \_____ my_class.py
  |
  \ tests
      \___ test_my_func.py

たとえば、次のように使用できます。

python3 unittest discover -s /full_path/project_root/tests -t /full_path/project_root/

そして、まだmy_module.my_class主要なドラマなしでインポートします。