pytestのPATH問題「ImportError：YadaYadaYadaという名前のモジュールはありません」

easy_installを使用してMacにpytestをインストールし、次のようなファイル構造を持つプロジェクトのテストの作成を開始しました。

repo/
repo/app.py
repo/settings.py
repo/models.py
repo/tests/
repo/tests/test_app.py

py.testrepoディレクトリで実行すると、すべてが期待どおりに動作します

しかし、LinuxまたはWindows（どちらもpytest 2.2.3がインストールされています）で同じことを試みると、アプリケーションパスから何かの最初のインポートにヒットするたびに吠えます。たとえば言うfrom app import some_def_in_app

これらのシステムでpy.testを実行するには、PATHを編集する必要がありますか？誰かがこれを経験しましたか？

はい、cdtestsディレクトリに移動した場合、ソースフォルダーはPythonのパスにありません。

2つの選択肢があります。

1. 次のようなパスをテストファイルに手動で追加します。

   import sys, os
   myPath = os.path.dirname(os.path.abspath(__file__))
   sys.path.insert(0, myPath + '/../')

2. env varを使用してテストを実行しますPYTHONPATH=../。

py.testがPYTHONPATH自体に現在のディレクトリを追加しない理由はわかりませんが、回避策があります（リポジトリのルートから実行します）。

python -m pytest tests/

PythonがPYTHONPATHに現在のディレクトリを追加するため、これは機能します。

conftest 解決

最も侵襲性の低いソリューションはconftest.py、repo/ディレクトリに名前が付けられた空のファイルを追加することです。

$ touch repo/conftest.py

それでおしまい。をマングルするためのカスタムコードを記述しsys.pathたり、ドラッグPYTHONPATHしたり配置したりすることを覚える必要はありません。__init__.py、それが属していないディレクトリにし。

その後のプロジェクトディレクトリ：

repo
├── conftest.py
├── app.py
├── settings.py
├── models.py
└── tests
     └── test_app.py

説明

pytestconftestテストコレクションでモジュールを探してカスタムフックとフィクスチャを収集し、それらからカスタムオブジェクトをインポートします。pytestの親ディレクトリを追加conftest.pyするsys.path（この場合、repoディレクトリ）。

その他のプロジェクト構造

他のプロジェクト構造がある場合conftest.pyは、パッケージルートディレクトリ（パッケージを含むがパッケージ自体ではないため、__init__.py、を）に配置します。次に例を示します。

repo
├── conftest.py
├── spam
│   ├── __init__.py
│   ├── bacon.py
│   └── egg.py
├── eggs
│   ├── __init__.py
│   └── sausage.py
└── tests
     ├── test_bacon.py
     └── test_egg.py

src レイアウト

このアプローチはsrcレイアウトで使用できますconftest.pyが、src DIR）：

repo
├── src
│   ├── conftest.py
│   ├── spam
│   │   ├── __init__.py
│   │   ├── bacon.py
│   │   └── egg.py
│   └── eggs 
│       ├── __init__.py
│       └── sausage.py
└── tests
     ├── test_bacon.py
     └── test_egg.py

を追加srcするPYTHONPATHことの意味と利点を軽減することに注意してくださいsrcレイアウトの。インストールされたパッケージではなく、リポジトリからコードをテストすることになります。あなたがそれをする必要があるなら、多分あなたはまったくsrcディレクトリを必要としません。

ここから先

もちろん、conftestモジュールはソースコードの発見に役立つ単なるファイルではありません。ここで、pytestフレームワークのプロジェクト固有のすべての拡張とテストスイートのカスタマイズが行われます。ドキュメント全体に散在するモジュールpytestに関する多くの情報がありconftestます。で始まる：ローカルのディレクトリごとのプラグインconftest.py

また、SOはconftestモジュールに関して優れた質問をしています。py.testでは、conftest.pyファイルの使用法は何ですか？

私も同じ問題を抱えていました。空の__init__.pyファイルをtestsディレクトリに追加して修正しました。

pytest自分自身をモジュールとして実行します： python -m pytest tests

プロジェクトのルートでPYTHONPATHを使用して実行できます

PYTHONPATH=. py.test

または、pip installを編集可能なインポートとして使用します

pip install -e .   # install package using setup.py in editable mode

私はこれをあなたの質問と私自身の混乱への答えとして作成しました。お役に立てば幸いです。py.testコマンドラインとtox.iniの両方でPYTHONPATHに注意してください。

https://github.com/jeffmacdonald/pytest_test

具体的には、py.testとtoxに、含めるモジュールの場所を伝える必要があります。

py.testでこれを行うことができます：

PYTHONPATH=. py.test

そしてtoxを使用して、これをtox.iniに追加します。

[testenv]
deps= -r{toxinidir}/requirements.txt
commands=py.test
setenv =
    PYTHONPATH = {toxinidir}

Flaskでも同じ問題が発生しました。

追加したとき：

__init__.py

テストフォルダに、問題が消えました:)

おそらくアプリケーションはフォルダテストをモジュールとして認識できませんでした

__init__.pyソースの親フォルダーの最上位を削除して修正しました。

私ConftestImportFailure: ImportError('No module named ...が誤って__init__.pyファイルをsrcディレクトリ（Pythonパッケージではなく、すべてのソースのコンテナーではない）に追加したときに、奇妙なエラーが発生し始めました。

私はこのエラーをもっと単純なもののために受け取りました（あなたは些細なことを言うことさえできます）。pytestモジュールをインストールしていませんでした。簡単な方法でapt install python-pytest修正しました。

「pytest」は、テストの依存関係としてsetup.pyにリストされていました。テスト要件もインストールしてください。

同様の問題がありました。 pytest私が働いていた環境にインストールされたモジュールを認識しませんでした。

pytest同じ環境にもインストールして解決しました。

私にとっての問題はtests.py、testsディレクトリとともにDjangoによって生成されました。削除tests.pyすることで問題は解決しました。

相対インポートを誤って使用したため、このエラーが発生しました。OPの例では、test_app.pyは、たとえば、

from repo.app import *

ただし、自由に__init__.pyファイルがファイル構造の周りに散在している場合、これは機能せず、ファイルとテストファイルが同じディレクトリにない限り、見られるようなImportErrorが作成されます。

from app import *

これは、私のプロジェクトの1つで何をしなければならなかったかの例です。

これが私のプロジェクト構造です：

microbit/
microbit/activity_indicator/activity_indicator.py
microbit/tests/test_activity_indicator.py

test_activity_indicator.pyからactivity_indicator.pyにアクセスできるようにするには、以下を行う必要があります。

• 正しい相対インポートでtest_activity_indicatory.pyを開始します。

    from microbit.activity_indicator.activity_indicator import *

• プロジェクト構造全体に__init__.pyファイルを配置します。

    microbit/
    microbit/__init__.py
    microbit/activity_indicator/__init__.py
    microbit/activity_indicator/activity_indicator.py
    microbit/tests/__init__.py
    microbit/tests/test_activity_indicator.py

モジュールをインポートできないことが原因でテストが中断されることがよくありました。調査の結果、システムが間違った場所でファイルを参照しており、モジュールを含むファイルをコピーすることで問題を簡単に解決できることがわかりました。適切にインポートするために、上記と同じフォルダ。もう1つの解決策は、インポートの宣言を変更し、MutPyにユニットの正しいパスを表示することです。ただし、複数のユニットがこの依存関係を持っている可能性があるという事実のため、宣言でも変更をコミットする必要があるため、ユニットをフォルダに移動するだけです。

Dirk AveryによるMediumの投稿によると（私の個人的な経験でサポートされています）、プロジェクトに仮想環境を使用している場合、システム全体のpytestのインストールは使用できません。仮想環境にインストールして、そのインストールを使用する必要があります。

特に、両方にインストールしている場合はpytest、システムインストールを使用するため、コマンドを実行するだけでは機能しません。他の答えが述べたように、1つの簡単な解決策はのpython -m pytest代わりに実行することですpytest。これは、環境のバージョンのpytestを使用しているため機能します。または、システムのバージョンのpytestをアンインストールすることもできます。仮想環境を再アクティブ化した後、pytestコマンドは機能するはずです。

Flaskチュートリアルに従うと同じ問題が発生し、公式のPytestで答えが見つかりました ドキュメントで これは、私（および他の多くの人）が慣れている方法から少しずれています。

あなたが作成する必要があります setup.pyプロジェクトのルートディレクトリに、少なくとも次の2行ファイル必要があります。

from setuptools import setup, find_packages
setup(name="PACKAGENAME", packages=find_packages())

PACKAGENAMEはアプリの名前です。次に、pipでインストールする必要があります。

pip install -e .

この-eフラグは、パッケージを編集可能モードまたは「開発」モードでインストールするようにpipに指示します。したがって、次に実行pytestしたときに、標準でアプリが見つかりますPYTHONPATH。

私の解決策：

以下を含むディレクトリにconftest.pyファイルを作成しますtest。

import os
import sys
sys.path.insert(0,os.path.dirname(os.path.realpath(__file__)) + "/relative/path/to/code/")

これにより、すべてのテストファイルを変更したり、env変数を設定したり、絶対/相対パスをいじったりすることなく、対象のフォルダーをpythonパスに追加します。