Problem PATH z pytest „ImportError: Brak modułu o nazwie YadaYadaYada”

Użyłem easy_install, aby zainstalować pytest na komputerze Mac i zacząłem pisać testy dla projektu o strukturze plików podobnej do następującej:

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

uruchom py.testw katalogu repo, wszystko zachowuje się tak, jak można się spodziewać

ale kiedy próbuję tego samego na Linuksie lub Windowsie (oba mają na sobie pytest 2.2.3), szczeka za każdym razem, gdy natrafi na pierwszy import czegoś z mojej ścieżki aplikacji. Powiedz na przykładfrom app import some_def_in_app

Czy muszę edytować moją PATH, aby uruchomić py.test na tych systemach? Czy ktoś tego doświadczył?

Tak, folder źródłowy nie znajduje się w ścieżce Pythona, jeśli przejdziesz cddo katalogu testów.

Masz 2 możliwości:

1. Dodaj ścieżkę ręcznie do plików testowych, mniej więcej tak:

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

2. Uruchom testy z env var PYTHONPATH=../.

Nie jestem pewien, dlaczego py.test nie dodaje bieżącego katalogu do samej PYTHONPATH, ale oto obejście (do wykonania z katalogu głównego repozytorium):

python -m pytest tests/

Działa, ponieważ Python dodaje dla ciebie bieżący katalog w PYTHONPATH.

conftest rozwiązanie

Najmniej inwazyjne rozwiązanie polega na dodaniu pustego pliku o nazwie conftest.pyw repo/katalogu:

$ touch repo/conftest.py

Otóż ​​to. Nie ma potrzeby pisania niestandardowego kodu w celu manipulacji sys.pathlub pamiętaj, aby przeciągać PYTHONPATHlub umieszczać __init__.pyw katalogach, w których nie należy.

Katalog projektu następnie:

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

Wyjaśnienie

pytestszuka conftestmodułów w kolekcji testowej, aby zebrać niestandardowe zaczepy i urządzenia, a aby zaimportować z nich niestandardowe obiekty, pytestdodaje katalog nadrzędny conftest.pydosys.path (w tym przypadku repokatalogu).

Inne struktury projektu

Jeśli masz inną strukturę projektu, umieść conftest.pykatalog w katalogu głównym pakietu (ten, który zawiera pakiety, ale sam nie jest pakietem, więc nie zawiera an __init__.py), na przykład:

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

src układ

Chociaż tego podejścia można użyć z srcukładem (umieść conftest.pyw katalogu src):

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

uwaga, że ​​dodanie w srccelu PYTHONPATHzłagodzenia znaczenia i zalet srcukładu! Skończysz na testowaniu kodu z repozytorium, a nie zainstalowanego pakietu. Jeśli musisz to zrobić, może wcale nie potrzebujesz srcreż.

Dokąd się udać?

Oczywiście conftestmoduły to nie tylko niektóre pliki, które pomagają w odkrywaniu kodu źródłowego; w tym miejscu mają miejsce wszystkie udoskonalenia pytestframeworku specyficzne dla projektu i dostosowanie pakietu testowego. pytestma wiele informacji o conftestmodułach rozrzuconych po ich dokumentach ; zacznij od conftest.py: lokalnych wtyczek dla poszczególnych katalogów

Ponadto SO ma doskonałe pytanie dotyczące conftestmodułów: W py.test, do czego służą pliki conftest.py?

Miałem ten sam problem. Naprawiłem to, dodając pusty __init__.pyplik do mojego testskatalogu.

Uruchom pytestsię jako moduł z: python -m pytest tests

Możesz uruchomić PYTHONPATH w katalogu głównym projektu

PYTHONPATH=. py.test

Lub użyj instalacji pip jako importu do edycji

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

Stworzyłem to jako odpowiedź na twoje pytanie i moje własne zamieszanie. Mam nadzieję, że to pomoże. Zwróć uwagę na PYTHONPATH zarówno w wierszu poleceń py.test, jak i na stronie tox.ini.

https://github.com/jeffmacdonald/pytest_test

W szczególności: musisz powiedzieć py.test i toks, gdzie znaleźć moduły, które dołączasz.

Z py.test możesz to zrobić:

PYTHONPATH=. py.test

I z toks, dodaj to do swojego tox.ini:

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

Miałem ten sam problem w Flask.

Kiedy dodałem:

__init__.py

do folderu testów problem zniknął :)

Prawdopodobnie aplikacja nie mogła rozpoznać testów folderów jako modułu

Naprawiłem to, usuwając najwyższy poziom __init__.pyw folderze nadrzędnym moich źródeł.

Zacząłem dostawać dziwne ConftestImportFailure: ImportError('No module named ...błędy, gdy przypadkowo dodałem __init__.pyplik do mojego katalogu src (który nie miał być pakietem Pythona, tylko kontenerem całego źródła).

Otrzymałem ten błąd z powodu czegoś jeszcze prostszego (można nawet powiedzieć, że jest trywialny). Nie zainstalowałem pytestmodułu. Więc prosty apt install python-pytestto dla mnie naprawił.

„pytest” zostałoby wymienione w pliku setup.py jako zależność testowa. Upewnij się, że zainstalowałeś również wymagania testowe.

Miałem podobny problem. pytestnie rozpoznałem modułu zainstalowanego w środowisku, w którym pracowałem.

Rozwiązałem go, instalując się pytestw tym samym środowisku.

Dla mnie problem został tests.pywygenerowany przez Django wraz z testskatalogiem. Usunięcie tests.pyrozwiązało problem.

Wystąpił ten błąd, ponieważ nieprawidłowo użyłem importu względnego. W przykładzie OP test_app.py powinien importować funkcje przy użyciu np

from repo.app import *

Jakkolwiek pliki __init__.py są swobodnie rozproszone wokół struktury plików, to nie działa i tworzy rodzaj ImportError, chyba że pliki i pliki testowe znajdują się w tym samym katalogu.

from app import *

Oto przykład tego, co miałem do czynienia z jednym z moich projektów:

Oto struktura mojego projektu:

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

Aby uzyskać dostęp do activity_indicator.py z test_activity_indicator.py musiałem:

• uruchom test_activity_indicatory.py z poprawnym importem względnym:

    from microbit.activity_indicator.activity_indicator import *

• umieść pliki __init__.py w całej strukturze projektu:

    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

Bardzo często testy były przerywane z powodu niemożności zaimportowania modułu. Po badaniach dowiedziałem się, że system patrzy na plik w niewłaściwym miejscu i możemy łatwo rozwiązać problem, kopiując plik zawierający moduł w ten sam folder, jak podano, w celu prawidłowego zaimportowania. Inną propozycją rozwiązania byłaby zmiana deklaracji importu i pokazanie MutPy poprawnej ścieżki urządzenia. Jednak ze względu na fakt, że wiele jednostek może mieć tę zależność, co oznacza, że ​​musimy zatwierdzić zmiany również w ich deklaracjach, wolimy po prostu przenieść jednostkę do folderu.

Zgodnie z postem Dirka Avery'ego na Medium (i obsługiwanym przez moje osobiste doświadczenia), jeśli używasz środowiska wirtualnego do swojego projektu, nie możesz użyć ogólnosystemowej instalacji pytest; musisz zainstalować go w środowisku wirtualnym i użyć tej instalacji.

W szczególności, jeśli masz zainstalowany w obu miejscach, to po prostu uruchomienie pytestpolecenia nie będzie działać, ponieważ będzie korzystało z instalacji systemu. Jak opisano w innych odpowiedziach, jednym z prostych rozwiązań jest uruchomienie python -m pytestzamiast pytest; działa to, ponieważ używa środowiska pytest w środowisku. Alternatywnie możesz po prostu odinstalować systemową wersję pytest; po reaktywacji środowiska wirtualnego pytestpolecenie powinno działać.

Miałem ten sam problem, postępując zgodnie z samouczkiem Flask i znalazłem odpowiedź na oficjalnych dokumentach Pytest. To trochę zmienia sposób, w jaki ja (i myślę, że wielu innych) jestem przyzwyczajony do robienia rzeczy.

Musisz utworzyć setup.pyplik w katalogu głównym projektu z co najmniej dwoma następującymi wierszami:

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

gdzie PACKAGENAME to nazwa Twojej aplikacji. Następnie musisz zainstalować go za pomocą pip:

pip install -e .

-eFlaga mówi pip aby nienaruszony pakiet w edytowalny lub „rozwijać” tryb. Więc przy następnym uruchomieniu pytestpowinna znaleźć twoją aplikację w standardzie PYTHONPATH.

Moje rozwiązanie:

utwórz conftest.pyplik w testkatalogu zawierającym:

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

Spowoduje to dodanie folderu będącego przedmiotem zainteresowania do ścieżki Pythona bez modyfikowania każdego pliku testowego , ustawiania zmiennej env lub bałagania za pomocą ścieżek bezwzględnych / względnych.