Problem

PEP8 hat eine Regel zum Einfügen von Importen an den Anfang einer Datei:

Importe werden immer am Anfang der Datei platziert, direkt nach Modulkommentaren und Dokumentzeichenfolgen sowie vor Modulglobalen und -konstanten.

In bestimmten Fällen möchte ich jedoch möglicherweise Folgendes tun:

import sys
sys.path.insert("..", 0)

import my_module

In diesem Fall kennzeichnet das pep8Befehlszeilenprogramm meinen Code:

Import auf E402-Modulebene nicht oben in der Datei

Was ist der beste Weg, um die PEP8-Konformität mit sys.pathÄnderungen zu erreichen ?

Warum

Ich habe diesen Code, weil ich der Projektstruktur folge, die im Per Anhalter durch Python angegeben ist .

In diesem Handbuch wird vorgeschlagen, dass ich einen my_moduleOrdner habe, der von einem testsOrdner getrennt ist und sich beide im selben Verzeichnis befinden. Wenn ich zugreifen möchten my_moduleaus tests, ich glaube , ich muss hinzufügen , ..um diesys.path

Oft habe ich mehrere Dateien mit Tests in einem Unterverzeichnis foo/testsmeines Projekts, während sich die Module, in denen ich teste, befinden foo/src. Um die Tests foo/testsohne Importfehler auszuführen, erstelle ich eine Datei foo/tests/pathmagic.py, die so aussieht.

"""Path hack to make tests work."""

import os
import sys

bp = os.path.dirname(os.path.realpath('.')).split(os.sep)
modpath = os.sep.join(bp + ['src'])
sys.path.insert(0, modpath)

In jeder Testdatei verwende ich dann

import pathmagic  # noqa

als erster Import. Die „noqa“ Kommentar verhindert pycodestyle/ pep8von etwa einem nicht verwendeten Import beschweren.

Wenn es nur wenige Importe gibt, können Sie PEP8 in diesen importZeilen einfach ignorieren :

import sys
sys.path.insert("..", 0)
import my_module  # noqa: E402

Es gibt noch eine andere Problemumgehung.

import sys
... all your other imports...

sys.path.insert("..", 0)
try:
    import my_module
except:
    raise

Ich habe gerade mit einer ähnlichen Frage gekämpft und ich denke, ich habe eine etwas schönere Lösung gefunden als die akzeptierte Antwort.

Erstellen Sie ein pathmagicModul, das die eigentliche Manipulation von sys.path ausführt, die Änderung jedoch in einem Kontextmanager vornimmt :

"""Path hack to make tests work."""

import os
import sys

class context:
    def __enter__(self):
        bp = os.path.dirname(os.path.realpath('.')).split(os.sep)
        modpath = os.sep.join(bp + ['src'])
        sys.path.insert(0, modpath)

    def __exit__(self, *args):
        pass

Dann tun Sie in Ihren Testdateien (oder wo immer Sie dies benötigen):

import pathmagic

with pathmagic.context():
    import my_module
    # ...

Auf diese Weise erhalten Sie keine Beschwerden von flake8 / pycodestyle, Sie benötigen keine speziellen Kommentare und die Struktur scheint sinnvoll zu sein.

Erwägen Sie für zusätzliche Sauberkeit, den Pfad im __exit__Block tatsächlich zurückzusetzen. Dies kann jedoch zu Problemen bei verzögerten Importen führen (wenn Sie den Modulcode außerhalb des Kontexts platzieren), sodass sich die Mühe möglicherweise nicht lohnt.

BEARBEITEN : Ich habe gerade einen viel einfacheren Trick bei der Beantwortung einer anderen Frage gesehen : Fügen Sie assert pathmagicunter Ihren Importen hinzu, um den noqaKommentar zu vermeiden .

Haben Sie bereits Folgendes versucht:

import sys
from importlib import import_module

sys.path.insert("..", 0)

# import module
my_mod = import_module('my_module')

# get method or function from my_mod
my_method = getattr(my_mod , 'my_method')

Um pep8 zu erfüllen, sollten Sie Ihren Projektpfad in den Python-Pfad aufnehmen, um relative / absolute Importe durchzuführen.

Zu diesem Zweck können Sie sich diese Antwort ansehen: Fügen Sie PYTHONPATH dauerhaft ein Verzeichnis hinzu