PEP 8 – Style Guide for Python Code

Author:Guido van Rossum <guido at python.org>, Barry Warsaw <barry at python.org>, Nick Coghlan <ncoghlan at gmail.com>Status:ActiveType:ProcessCreated:05-Jul-2001Post-History:05-Jul-2001, 01-Aug-2013

Original: https://peps.python.org/pep-0008/

Anmerkung zur Übersetzung:

Die Texte wurden mit DeepL.com übersetzt. Meistens waren keine Korrekturen erforderlich. Gelegentlich aber doch. Ich habe sie dann nach bestem Wissen vorgenommen.

In den Codebeispielen steht meistens # Correct und # Wrong. Gelegentlich habe ich aber auch die Codebespiele in DeepL eingegeben. Dann steht dort die deutsche Übersetzung # Korrekt, # Falsch oder # Richtig.

Es gibt auch Stellen an denen mir die Übersetzung von DeepL ziemlich schräg vorkommt, mir aber nichts besseres eingefallen ist. Wenn Jemand solche Stellen findet und eine bessere Übersetzung weiss, dann bitte per Email an kpstoeck€web.de schicken. Ich werde es dann in den Text übernehmen.

PEP 8 - Stilrichtlinien für Python-Code

Einführung

Dieses Dokument enthält Kodierungskonventionen für den Python-Code, der die Standardbibliothek in der Python-Distribution umfasst. Bitte beachten Sie den begleitenden informativen PEP, der Stilrichtlinien für den C-Code in der C-Implementierung von Python beschreibt.

Dieses Dokument und PEP 257 (Docstring Conventions) wurden aus Guidos ursprünglichem Python Style Guide Essay übernommen, mit einigen Ergänzungen aus Barrys Style Guide [2].

Dieser Style Guide entwickelt sich im Laufe der Zeit weiter, da zusätzliche Konventionen identifiziert werden und frühere Konventionen durch Änderungen in der Sprache selbst obsolet gemacht werden.

Viele Projekte haben ihre eigenen Stilrichtlinien für die Kodierung. Im Falle von Konflikten haben diese projektspezifischen Richtlinien für das jeweilige Projekt Vorrang.

Eine törichte Konsequenz ist der Kobold der Kleingeister

Eine von Guidos wichtigsten Erkenntnissen ist, dass Code viel öfter gelesen als geschrieben wird. Die hier vorgestellten Richtlinien sollen die Lesbarkeit von Code verbessern und ihn über das breite Spektrum von Python-Code hinweg konsistent machen. Wie PEP 20 sagt: "Lesbarkeit zählt".

Bei einem Style Guide geht es um Konsistenz. Konsistenz mit diesem Styleguide ist wichtig. Konsistenz innerhalb eines Projekts ist noch wichtiger. Konsistenz innerhalb eines Moduls oder einer Funktion ist am wichtigsten.

Sie sollten jedoch wissen, wann Sie inkonsequent sein sollten - manchmal sind die Empfehlungen des Styleguides einfach nicht anwendbar. Im Zweifelsfall sollten Sie sich auf Ihr eigenes Urteil verlassen. Schauen Sie sich andere Beispiele an und entscheiden Sie, was am besten aussieht. Und zögern Sie nicht zu fragen!

Vor allem: Brechen Sie nicht die Abwärtskompatibilität, nur um diesem PEP zu entsprechen!

Einige andere gute Gründe, eine bestimmte Richtlinie zu ignorieren:

  1. Wenn die Anwendung der Richtlinie den Code weniger lesbar machen würde, selbst für jemanden, der es gewohnt ist, Code zu lesen, der diesem PEP folgt.