PATH-Problem mit pytest 'ImportError: Kein Modul namens YadaYadaYada'

Ich habe easy_install verwendet, um pytest auf einem Mac zu installieren, und habe angefangen, Tests für ein Projekt mit einer Dateistruktur wie folgt zu schreiben:

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

Wenn Sie py.testim Repo-Verzeichnis ausgeführt werden, verhält sich alles wie erwartet

Aber wenn ich dasselbe unter Linux oder Windows versuche (beide haben Pytest 2.2.3), bellt es immer dann, wenn es zum ersten Mal etwas aus meinem Anwendungspfad importiert. Sagen Sie zum Beispielfrom app import some_def_in_app

Muss ich meinen PFAD bearbeiten, um py.test auf diesen Systemen auszuführen? Hat das jemand erlebt?

Ja, der Quellordner befindet sich nicht im Python-Pfad, wenn Sie cdzum Testverzeichnis wechseln .

Sie haben 2 Möglichkeiten:

1. Fügen Sie den Pfad manuell zu den Testdateien hinzu.

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

2. Führen Sie die Tests mit der env var aus PYTHONPATH=../.

Ich bin nicht sicher, warum py.test das aktuelle Verzeichnis nicht in PYTHONPATH selbst hinzufügt, aber hier ist eine Problemumgehung (die vom Stammverzeichnis Ihres Repositorys ausgeführt werden muss):

python -m pytest tests/

Es funktioniert, weil Python das aktuelle Verzeichnis im PYTHONPATH für Sie hinzufügt.

conftest Lösung

Die am wenigsten invasive Lösung ist das Hinzufügen einer leeren Datei mit dem Namen conftest.pyim repo/Verzeichnis:

$ touch repo/conftest.py

Das ist es. Sie müssen keinen benutzerdefinierten Code schreiben, um das zu entstellen, sys.pathoder Sie müssen daran denken, mitzuschleppen PYTHONPATHoder zu platzieren__init__.py mitzunehmen in Verzeichnisse zu in die er nicht gehört.

Das Projektverzeichnis danach:

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

Erläuterung

pytestsucht nach den conftestModulen in der Testsammlung, um benutzerdefinierte Hooks und Fixtures zu erfassen, und pytestfügtconftest.pysys.path zum Importieren der benutzerdefinierten Objekte das übergeordnete Verzeichnis von the zu (in diesem Fall dasrepo Verzeichnis) hinzu.

Andere Projektstrukturen

Wenn Sie eine andere Projektstruktur haben, platzieren Sie das conftest.pyim Paketstammverzeichnis (dasjenige, das Pakete enthält, aber selbst kein Paket ist, also kein enthält __init__.py), zum Beispiel:

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

src Layout

Obwohl dieser Ansatz mit dem srcLayout verwendet werden kann ( conftest.pyim srcVerzeichnis platzieren):

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

Vorsicht , dass das Hinzufügen srczu PYTHONPATHden Sinn und Nutzen des mildert srcLayout! Am Ende testen Sie den Code aus dem Repository und nicht das installierte Paket. Wenn Sie es tun müssen, brauchen Sie vielleicht das srcVerzeichnis überhaupt nicht.

Wohin von hier aus?

Natürlich sind conftestModule nicht nur einige Dateien, die bei der Erkennung des Quellcodes hilfreich sind. Hier finden alle projektspezifischen Verbesserungen des pytestFrameworks und die Anpassung Ihrer Testsuite statt. pytesthat viele Informationen zu conftestModulen, die in ihren Dokumenten verteilt sind ; Beginnen Sie mit conftest.py: lokalen Plugins pro Verzeichnis

Außerdem hat SO eine ausgezeichnete Frage zu conftestModulen: Wozu werden in py.test conftest.py-Dateien verwendet?

Ich hatte das gleiche Problem. Ich habe es behoben, indem ich __init__.pymeinem testsVerzeichnis eine leere Datei hinzugefügt habe .

Führen Sie pytestsich als Modul aus mit: python -m pytest tests

Sie können mit PYTHONPATH im Projektstamm ausführen

PYTHONPATH=. py.test

Oder verwenden Sie pip install als bearbeitbaren Import

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

Ich habe dies als Antwort auf Ihre Frage und meine eigene Verwirrung erstellt. Ich hoffe, es hilft. Achten Sie sowohl in der py.test-Befehlszeile als auch in der tox.ini auf PYTHONPATH.

https://github.com/jeffmacdonald/pytest_test

Insbesondere: Sie müssen py.test und tox mitteilen, wo sich die Module befinden, die Sie einschließen.

Mit py.test können Sie dies tun:

PYTHONPATH=. py.test

Und mit tox fügen Sie dies Ihrer tox.ini hinzu:

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

Ich hatte das gleiche Problem in Flask.

Als ich hinzufügte:

__init__.py

zum Testordner, Problem verschwunden :)

Wahrscheinlich konnte die Anwendung Ordnertests nicht als Modul erkennen

Ich habe es behoben, indem ich die oberste Ebene __init__.pyim übergeordneten Ordner meiner Quellen entfernt habe.

Ich bekam seltsame ConftestImportFailure: ImportError('No module named ...Fehler, als ich versehentlich eine __init__.pyDatei zu meinem src-Verzeichnis hinzugefügt hatte (das kein Python-Paket sein sollte, sondern nur ein Container aller Quellen).

Ich habe diesen Fehler aufgrund von etwas noch Einfacherem erhalten (man könnte sogar Triviales sagen). Ich hatte das pytestModul nicht installiert . Also einfachapt install python-pytest Problem für mich behoben.

'pytest' wäre in setup.py als Testabhängigkeit aufgeführt worden. Stellen Sie sicher, dass Sie auch die Testanforderungen installieren.

Ich hatte ein ähnliches Problem. pytestIch habe kein Modul erkannt, das in der Umgebung installiert ist, in der ich gearbeitet habe.

Ich habe es behoben, indem ich es auch pytestin derselben Umgebung installiert habe .

Für mich wurde das Problem tests.pyvon Django zusammen mit dem testsVerzeichnis generiert . Das Entfernen tests.pylöste das Problem.

Ich habe diesen Fehler erhalten, weil ich relative Importe falsch verwendet habe. Im OP-Beispiel sollte test_app.py Funktionen importieren, indem z

from repo.app import *

Obwohl __init__.py-Dateien großzügig über die Dateistruktur verteilt sind, funktioniert dies nicht und erzeugt die Art von ImportError, die angezeigt wird, es sei denn, die Dateien und Testdateien befinden sich im selben Verzeichnis.

from app import *

Hier ist ein Beispiel dafür, was ich mit einem meiner Projekte zu tun hatte:

Hier ist meine Projektstruktur:

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

Um über test_activity_indicator.py auf activity_indicator.py zugreifen zu können, musste ich:

• Starten Sie test_activity_indicatory.py mit dem richtigen relativen Import:

    from microbit.activity_indicator.activity_indicator import *

• Fügen Sie __init__.py-Dateien in die gesamte Projektstruktur ein:

    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

Sehr oft wurden die Tests unterbrochen, weil das Modul nicht importiert werden konnte. Nach Recherchen stellte ich fest, dass das System die Datei an der falschen Stelle betrachtet und wir das Problem leicht überwinden können, indem wir die Datei mit dem Modul in kopieren der gleiche Ordner wie angegeben, um ordnungsgemäß importiert zu werden. Ein weiterer Lösungsvorschlag wäre, die Deklaration für den Import zu ändern und MutPy den korrekten Pfad der Einheit anzuzeigen. Aufgrund der Tatsache, dass mehrere Einheiten diese Abhängigkeit haben können, was bedeutet, dass wir Änderungen auch in ihren Deklarationen festschreiben müssen, ziehen wir es vor, die Einheit einfach in den Ordner zu verschieben.

Laut einem Beitrag auf Medium von Dirk Avery (und unterstützt durch meine persönliche Erfahrung) können Sie keine systemweite Installation von pytest verwenden, wenn Sie eine virtuelle Umgebung für Ihr Projekt verwenden. Sie müssen es in der virtuellen Umgebung installieren und diese Installation verwenden.

Insbesondere wenn Sie es an beiden Stellen installiert haben, pytestfunktioniert das einfache Ausführen des Befehls nicht, da die Systeminstallation verwendet wird. Wie die anderen Antworten beschrieben haben, eine einfache Lösung laufen python -m pyteststatt pytest; Dies funktioniert, weil die Umgebungsversion von pytest verwendet wird. Alternativ können Sie auch die Systemversion von pytest deinstallieren. Nach der Reaktivierung der virtuellen Umgebung sollte der pytestBefehl funktionieren.

Ich hatte das gleiche Problem, als ich dem Flask-Tutorial folgte, und fand die Antwort in den offiziellen Pytest- Dokumenten. Es ist eine kleine Abweichung von der Art und Weise, wie ich (und ich denke, viele andere) es gewohnt bin, Dinge zu tun.

Sie müssen eine setup.pyDatei im Stammverzeichnis Ihres Projekts mit mindestens den folgenden zwei Zeilen erstellen :

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

Dabei ist PACKAGENAME der Name Ihrer App. Dann müssen Sie es mit pip installieren:

pip install -e .

Das -eFlag weist pip an, das Paket im bearbeitbaren oder "Entwicklungs" -Modus zu installieren. Wenn Sie pytestes das nächste Mal ausführen , sollte Ihre App im Standard enthalten sein PYTHONPATH.

Meine Lösung:

Erstellen Sie die conftest.pyDatei in dem testVerzeichnis, das Folgendes enthält:

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

Dadurch wird der gewünschte Ordner zum Python-Pfad hinzugefügt, ohne dass jede Testdatei geändert , die env-Variable festgelegt oder absolute / relative Pfade verwendet werden müssen.