Tool zur Ermittlung von kreisförmigen Importe in Python/Django?

Die Ursache des import-Fehler ist schnell gefunden, in der backtrace des ImportError-Ausnahme.

Beim Blick in den backtrace, wirst du sehen, dass das Modul importiert wurde, vor. Einer der es importiert importiert etwas anderes ausgeführt, Haupt-code und importiert nun das erste Modul. Da das erste Modul wurde nicht vollständig initialisiert (es war immer noch stecken Sie es in die import-code), erhalten Sie jetzt die Fehler der Symbole nicht gefunden. Was Sinn macht, weil die Haupt-code des Moduls nicht erreichen, dass die Stelle doch.

Häufigsten Ursachen in Django sind:

1. Importieren subpackage aus einem ganz anderen Modul,

   z.B. from mymodule.admin.utils import ...

   Dieser lädt admin/__init__.py ersten, die wahrscheinlich importiert, während die Last von anderen Paketen (z.B. Modelle, admin-views). Der admin-view wird initialisiert mit admin.site.register(..) so an den Konstruktor könnte zu importieren, mehr Zeug. Irgendwann treffen könnte, Ihre Modul-Ausgabe der ersten Anweisung.

   Hatte ich eine solche Aussage in meinem middleware, können Sie erraten, wo das geendet hat mich mit. 😉

2. Mischen von form-Feldern, - widgets und-Modelle.

   Da das Modell kann ein "formfield" starten Sie den Import-Formulare. Es hat ein widget. Das widget hat einige Konstanten aus .. äh... das Modell. Und jetzt haben Sie eine Schleife. Besser importieren Sie das Formular-Feld Klasse in den def formfield() Körper statt der globalen Modul-Umfang.

3. Einen managers.py bezieht sich auf Konstanten models.py

   Nachdem alle, das Modell muss der manager zunächst. Der manager kann nicht gestartet werden, importieren models.py denn es war noch initialisiert werden. Siehe unten, denn dies ist die einfachste situation.

4. Mit ugettext() statt ugettext_lazy.

   Wenn Sie ugettext() die übersetzung system muss initialisiert werden. Es läuft ein scan über alle Pakete in INSTALLED_APPS auf der Suche nach einem locale.XY.formats Paket. Wenn Ihre app wurde nur initialisiert sich, es wird nun wieder importiert von der globalen Modul-scan.

   Ähnliche Dinge passieren, mit einem scan für plugins, search_indexes von Heuhaufen, und anderen ähnlichen Mechanismen.

5. Setzen viel zu viel in __init__.py.

   Dies ist eine Kombination der Punkte 1 und 4, es betont die import-system, da ein import von subpackage wird zuerst die Initialisierung aller übergeordneten Pakete. In der Tat eine Menge von code, der ausgeführt wird, um einen einfachen import und erhöht die änderungen importieren zu müssen etwas vom falschen Ort.

Die Lösung ist nicht schwer entweder. Sobald Sie eine Idee haben von, was die Ursache für die Schleife, Sie zu entfernen, dass import-Anweisung aus der weltweiten Importe (am Anfang der Datei) und legen Sie Sie in eine Funktion, die verwendet das symbol. Zum Beispiel:

# models.py:
from django.db import models
from mycms.managers import PageManager

class Page(models.Model)
    PUBLISHED = 1

    objects = PageManager()

    # ....


# managers.py:
from django.db import models

class PageManager(models.Manager):
    def published(self):
        from mycms.models import Page   # Import here to prevent circular imports
        return self.filter(status=Page.PUBLISHED)

In diesem Fall können Sie sehen models.py wirklich braucht, um zu importieren managers.py; ohne Sie kann es nicht tun, die statische Initialisierung von PageManager. Anders herum ist nicht so wichtig. Die Page - Modell könnten leicht importiert werden innerhalb einer Funktion statt Global.

Das gleiche gilt für jede andere situation der import-Fehler. Die Schleife kann ein paar mehr Pakete jedoch.

Was ich normalerweise Tue, wenn ich auf einen import-Fehler ist, meinen Weg zu arbeiten rückwärts. Ich würde einige "nicht importieren xyz von myproject.Blick" - Fehler, obwohl xyz existiert nur in Ordnung. Dann habe ich zwei Dinge tun:

• Ich grep meinem eigenen code für jedes import von myproject.Aussicht und eine (mentale) Liste der Module, die Sie importieren.

• Ich prüfen, ob ich den import einer von denen passende Module in views.py wiederum. Oft gibt Ihnen der Schuldige ist.

Einen gemeinsamen Punkt, wo es schief gehen kann, ist Ihre models.py. Oft zentrale, was du tust. Aber stellen Sie sicher, Sie versuchen, halten Sie Ihre Importe zeigen models.py statt von ihm Weg. So importieren Sie Modelle aus views.py, aber nicht die andere Weise herum.

Und in urls.py ich normalerweise zu importieren, die meine Ansichten (da bekomme ich einen schönen sofortigen import-Fehlermeldung, wenn ich einen Fehler machen, die Art und Weise). Aber um zu verhindern, dass zirkuläre importieren Fehler auftreten, können Sie auch beziehen sich auf Ihre Ansichten mit einer gestrichelten Pfad-string. Aber das hängt davon ab, was Sie tun in Ihrem urls.py.

Einen Kommentar bezüglich Platzierung der Importe: halten Sie Sie an den Anfang der Datei. Wenn Sie ausbreiten, Sie werden nie ein klares Bild von dem Modul importiert, was. Nur indem wir Sie alle an der Spitze (schön sortiert) könnte bereits helfen Ihnen, Probleme zu ermitteln. Import nur innerhalb der Funktion, wenn notwendig, für die Lösung einer bestimmten, kreisförmigen importieren.

Machen und Ihre Importe mit absoluten statt relativen. Ich meine "from myproject.Ansichten import xyz" anstelle von "von Ansichten import xyz". So dass es absolut kombiniert mit der Sortierung der Liste der Importe macht Ihre Importe mehr klar und sauber.