Ist Ihr Python-Code lesbar?

Mar 03 2023

Während ich lerne, Python zu programmieren, achte ich auf die Details, wie mein Code geschrieben wird. Nicht nur die Funktionalität, sondern auch die Sicherstellung, dass mein Code den Best Practices entspricht und von anderen leicht interpretiert werden kann. Dies ist eine wichtige Angewohnheit, die man sich aneignen sollte, damit andere Softwareentwickler leicht sehen können, was der Code tut, und die Arbeit überarbeitet werden kann, wenn in Zukunft eine Webanwendung erstellt oder ein Teil einer Codebasis geschrieben wird. Ich habe auf den PEP 8 Style Guide für Python-Code verwiesen, um ein klareres Bild davon zu bekommen, wie Best Practices beim Codieren von Python aussehen.

In Python werden Leerzeichen im Allgemeinen gegenüber Tabulatoren bevorzugt. Wenn Sie sich dafür entscheiden, können Sie Code verwenden – Tabulatoren und Leerzeichen sollten jedoch nicht gemischt werden! Die Bedeutung der Konsistenz wird in diesem Blog ein wiederkehrendes Thema sein. Für Menschen ist es einfacher, Inhalte zu lesen und zu verstehen, wenn sie konsistent sind. Die Identifikation sollte aus vier Leerzeichen bestehen. Im folgenden Beispiel wird print vom Anfang der ersten Zeile um 4 Leerzeichen eingerückt.

In Python sollte eine Zeile auf 75 Zeichen begrenzt sein. Wenn Ihr Code die Grenze von 75 Zeichen überschreitet, können Sie den überlaufenden Code mithilfe eines hängenden Einzugs in die nächste Zeile verschieben und sicherstellen, dass er weiterhin lesbar ist. Bei der Übergabe von Einzügen besteht die Priorität darin, den überlaufenden Code mit seinem Gegenstück in der vorherigen Zeile auszurichten, damit er leichter lesbar ist. Daher müssen hängende Einzüge nicht um vier Stellen eingerückt werden. Unten sehen Sie ein Beispiel für überlaufenden Code, der einen hängenden Einzug verwendet.

Zusätzliche Leerzeichen zwischen Klammern und Satzzeichen sollten ebenfalls vermieden werden. Manchmal muss ich mich daran erinnern, dass ich Code schreibe und keine Hausarbeit. Unten finden Sie ein ungeheuerliches Beispiel für Leerraum. Im Allgemeinen empfiehlt es sich, Ihren Code erneut zu lesen, um sicherzustellen, dass sich nicht versehentlich ein zusätzliches Leerzeichen in Ihren Code eingeschlichen hat.

Schließlich ist es wichtig, dass der Python-Code Kommentare enthält und dass diese Kommentare leicht lesbar sind. Python-Kommentare sollten in vollständigen Sätzen geschrieben werden und mit einem Großbuchstaben beginnen, es sei denn, das erste Wort ist eine Variable in Kleinbuchstaben. Wenn ein Kommentar mehrere Sätze enthält, sollten nach einem Punkt zwei Leerzeichen stehen. (Hier kommt mir endlich meine Hausarbeitspraxis zugute!). Kommentare sind besonders wichtig, wenn der Zweck eines Codeabschnitts unklar ist.

Es gibt Fälle, in denen der PEP 8 Style Guide keine Präferenz hat. In diesen Fällen können Sie wählen, wie Sie Ihren Code gestalten möchten, Sie sollten jedoch stets darauf achten, konsistent zu sein. Denken Sie daran: Konsistenz ist der Schlüssel!