Python-Quelldateiorganisation

Question

Ich beginne ein neues Python-Projekt und möchte den Standardkonventionen so gut wie möglich folgen. Ich habe gelesen, dass Importanweisungen zum Beispiel zuerst kommen sollten. Aber ich habe keine Konventionen für Dinge wie das Setzen aller Funktionsdefinitionen vor oder nach allen Klassendefinitionen gefunden. Gibt es irgendwelche Konventionen für solche Dinge? Oder organisiert jeder typischerweise Dinge wie Funktions- und Klassendefinitionen in beliebiger Reihenfolge?

Answer 1

Nein, es gibt keine Konvention für die Organisation von Funktionen und Klassen. Es gibt jedoch einige grundlegende Richtlinien, die Ihren Quellfluss verbessern und den Lesern mehr Sinn machen:

Dokument. Was auch immer Sie tun, stellen Sie sicher, dass die Verwendung (und in einigen Fällen, die Implementierung) von Klassen und Funktionen in einfachem Englisch beschrieben wird)

Gruppieren Sie Dinge, die gleich sind. Zwei Funktionen, die ähnliche Funktionen ausführen? Setze sie zusammen.

Verwenden Sie gesunden Menschenverstand. Wenn eine Klasse eine andere erweitert, sollte die Basisklasse zuerst kommen. Wenn eine Funktion eine Instanz einer von Ihnen definierten Klasse annimmt, stellen Sie sicher, dass die Klassendefinition an erster Stelle steht.

Für Beispiele, wie dies getan wird, suchen Sie nicht weiter als die Python-Standardbibliothek. Die Quelldateien einiger Module sollten Ihnen eine Vorstellung davon geben, wie die Quelle in Python organisiert ist.

Answer 2

PEP8 ist der Python Style Guide: http://www.python.org/dev/peps/pep-0008/

Importe kommen am Anfang der Datei, obwohl Methode Ebene Einfuhren zulässig ist.

Es gibt keine spezielle Reihenfolge für Klassen und Funktionen. Verwenden Sie, was sinnvoll ist.