So beheben Sie "Versuchter relativer Import in Nicht-Paket" auch mit __init__.py

Ich versuche, PEP 328 mit der folgenden Verzeichnisstruktur zu folgen :

pkg/
  __init__.py
  components/
    core.py
    __init__.py
  tests/
    core_test.py
    __init__.py

In habe core_test.pyich die folgende Importanweisung

from ..components.core import GameLoopEvents

Beim Ausführen wird jedoch der folgende Fehler angezeigt:

tests$ python core_test.py 
Traceback (most recent call last):
  File "core_test.py", line 3, in <module>
    from ..components.core import GameLoopEvents
ValueError: Attempted relative import in non-package

Beim Durchsuchen fand ich " relativer Pfad funktioniert nicht einmal mit __init__.py " und " Importiere ein Modul von einem relativen Pfad ", aber sie halfen nicht.

Fehlt mir hier etwas?

Ja. Sie verwenden es nicht als Paket.

python -m pkg.tests.core_test

Um die Antwort von Ignacio Vazquez-Abrams näher zu erläutern :

Der Python-Importmechanismus funktioniert relativ zur __name__aktuellen Datei. Wenn Sie eine Datei direkt ausführen, hat sie nicht den üblichen Namen, sondern "__main__"den Namen. Relative Importe funktionieren also nicht.

Sie können es, wie von Igancio vorgeschlagen, mit der -mOption ausführen . Wenn Sie einen Teil Ihres Pakets haben, der als Skript ausgeführt werden soll, können Sie das __package__Attribut auch verwenden , um dieser Datei mitzuteilen, welchen Namen sie in der Pakethierarchie haben soll.

Weitere Informationen finden Sie unter http://www.python.org/dev/peps/pep-0366/ .

Sie können import components.coredirekt verwenden, wenn Sie das aktuelle Verzeichnis an Folgendes anhängen sys.path:

if __name__ == '__main__' and __package__ is None:
    from os import sys, path
    sys.path.append(path.dirname(path.dirname(path.abspath(__file__))))

Dies hängt davon ab, wie Sie Ihr Skript starten möchten.

Wenn Sie Ihren UnitTest auf klassische Weise über die Befehlszeile starten möchten, gilt Folgendes :

python tests/core_test.py

Da in diesem Fall 'Komponenten' und 'Tests' Geschwisterordner sind, können Sie das relative Modul entweder mit der Einfügemethode oder der Append- Methode des Moduls sys.path importieren . Etwas wie:

import sys
from os import path
sys.path.append( path.dirname( path.dirname( path.abspath(__file__) ) ) )
from components.core import GameLoopEvents

Andernfalls können Sie Ihr Skript mit dem Argument '-m' starten (beachten Sie, dass es sich in diesem Fall um ein Paket handelt und Sie daher nicht die Erweiterung '.py' angeben dürfen ).

python -m pkg.tests.core_test

In einem solchen Fall können Sie einfach den relativen Import verwenden, wie Sie es getan haben:

from ..components.core import GameLoopEvents

Sie können schließlich die beiden Ansätze mischen, sodass Ihr Skript unabhängig vom Namen funktioniert. Zum Beispiel:

if __name__ == '__main__':
    if __package__ is None:
        import sys
        from os import path
        sys.path.append( path.dirname( path.dirname( path.abspath(__file__) ) ) )
        from components.core import GameLoopEvents
    else:
        from ..components.core import GameLoopEvents

Gehen Sie in core_test.py wie folgt vor:

import sys
sys.path.append('../components')
from core import GameLoopEvents

Wenn Ihr Anwendungsfall für das Ausführen von Tests vorgesehen ist und dies der Fall ist, können Sie Folgendes tun. Anstatt Ihr Testskript so auszuführen, python core_test.pyverwenden Sie ein Testframework wie z pytest. Dann können Sie in der Befehlszeile eingeben

$$ py.test

Dadurch werden die Tests in Ihrem Verzeichnis ausgeführt. Dies umgeht das Problem des __name__Seins __main__, auf das @BrenBarn hingewiesen hat. Fügen Sie als Nächstes eine leere __init__.pyDatei in Ihr Testverzeichnis ein. Dadurch wird das Testverzeichnis Teil Ihres Pakets. Dann können Sie tun

from ..components.core import GameLoopEvents

Wenn Sie Ihr Testskript jedoch als Hauptprogramm ausführen, schlagen die Dinge erneut fehl. Verwenden Sie also einfach den Testläufer. Vielleicht funktioniert das auch mit anderen Testläufern wie, nosetestsaber ich habe es nicht überprüft. Hoffe das hilft.

Meine schnelle Lösung besteht darin, das Verzeichnis dem Pfad hinzuzufügen:

import sys
sys.path.insert(0, '../components/')

Problem ist mit Ihrer Testmethode,

du versuchtest python core_test.py

Dann wird dieser Fehler angezeigt. ValueError: Relativer Importversuch in Nicht-Paket versucht

Grund: Sie testen Ihre Verpackung aus einer nicht verpackten Quelle.

Testen Sie also Ihr Modul aus der Paketquelle.

Wenn dies Ihre Projektstruktur ist,

pkg/
  __init__.py
  components/
    core.py
    __init__.py
  tests/
    core_test.py
    __init__.py

cd pkg

python -m tests.core_test # dont use .py

oder von außerhalb pkg /

python -m pkg.tests.core_test

single, .wenn Sie aus einem Ordner im selben Verzeichnis importieren möchten. Fügen Sie für jeden Schritt zurück einen weiteren hinzu.

hi/
  hello.py
how.py

im how.py

from .hi import hello

falls Sie wie aus hello.py importieren möchten

from .. import how

Alter Faden. Ich fand heraus, dass das Hinzufügen eines __all__= ['submodule', ...]zur __init__.py- Datei und das anschließende Verwenden von from <CURRENT_MODULE> import *im Ziel gut funktioniert.

Sie können from pkg.components.core import GameLoopEventszum Beispiel pycharm verwenden. Das Folgende ist mein Projektstrukturbild. Ich importiere es einfach aus dem Root-Paket, dann funktioniert es:

Wie Paolo sagte, haben wir zwei Aufrufmethoden:

1) python -m tests.core_test
2) python tests/core_test.py

Ein Unterschied zwischen ihnen ist die Zeichenfolge sys.path [0]. Da die Interpretation beim Importieren nach sys.path sucht , können wir Folgendes tun tests/core_test.py:

if __name__ == '__main__':
    import sys
    from pathlib import Path
    sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
    from components import core
    <other stuff>

Und danach können wir core_test.py mit anderen Methoden ausführen:

cd tests
python core_test.py
python -m core_test
...

Beachten Sie, dass nur py36 getestet wurde.

Dieser Ansatz hat bei mir funktioniert und ist weniger überladen als einige Lösungen:

try:
  from ..components.core import GameLoopEvents
except ValueError:
  from components.core import GameLoopEvents

Das übergeordnete Verzeichnis befindet sich in meinem PYTHONPATH, und __init__.pyim übergeordneten Verzeichnis und in diesem Verzeichnis befinden sich Dateien.

Das Obige funktionierte immer in Python 2, aber Python 3 traf manchmal einen ImportError oder ModuleNotFoundError (letzteres ist neu in Python 3.6 und eine Unterklasse von ImportError), sodass die folgende Optimierung für mich sowohl in Python 2 als auch in Python 3 funktioniert:

try:
  from ..components.core import GameLoopEvents
except ( ValueError, ImportError):
  from components.core import GameLoopEvents

Versuche dies

import components
from components import *

Wenn jemand nach einer Problemumgehung sucht, bin ich auf eine gestoßen. Hier ist ein bisschen Kontext. Ich wollte eine der Methoden testen, die ich in einer Datei habe. Wenn ich es von innen laufen lasse

if __name__ == "__main__":

es beklagte sich immer über die relativen Importe. Ich habe versucht, die oben genannten Lösungen anzuwenden, aber es hat nicht funktioniert, da es viele verschachtelte Dateien mit jeweils mehreren Importen gab.

Folgendes habe ich getan. Ich habe gerade einen Launcher erstellt, ein externes Programm, das die erforderlichen Methoden importiert und aufruft. Obwohl keine gute Lösung, funktioniert es.

Hier ist eine Möglichkeit, die alle verärgert, aber ziemlich gut funktioniert. In Testläufen:

ln -s ../components components

Importieren Sie dann einfach die Komponenten wie gewohnt.

Dies ist sehr verwirrend, und wenn Sie IDE wie Pycharm verwenden, ist es etwas verwirrender. Was bei mir funktioniert hat: 1. Nehmen Sie Pycharm-Projekteinstellungen vor (wenn Sie Python von einem VE oder aus einem Python-Verzeichnis ausführen). 2. Die von Ihnen definierte Vorgehensweise ist nicht falsch. Manchmal funktioniert es mit der Importklasse folder1.file1

Wenn dies nicht funktioniert, verwenden Sie import folder1.file1. 3. Ihre Umgebungsvariable sollte im System korrekt erwähnt oder in Ihrem Befehlszeilenargument angegeben werden.

Da Ihr Code enthält if __name__ == "__main__", der nicht als Paket importiert wird, sollten Sie sys.path.append()das Problem besser lösen.