Am Anfang

Wenn Sie sich Websites zur Einführung in Programmiersprachen ansehen, werden Sie feststellen, dass Python als gut erzogene Sprache beschrieben wird. Ich habe den Eindruck, dass Python mehr Einschränkungen beim Schreiben hat als andere Sprachen, aber dennoch einen hohen Freiheitsgrad aufweist. Wenn Sie es tatsächlich entwickeln, bleibt eine große Anzahl von Gewohnheiten, die für jeden Programmierer einzigartig sind, in der Quelle.

Dies ist kein sehr wichtiges Thema für persönliche Hobbys, aber es ist ein ernstes Problem für die Arbeit, insbesondere für die Teamentwicklung. Einmal entwickelt, muss es grundsätzlich viele Jahre lang gewartet werden, und die für die Wartung verantwortliche Person ändert sich häufig während dieses Zeitraums. Es ist sehr wichtig, die Programmregeln im Projekt für die spätere Wartung zu definieren.

Wenn Sie die Regeln für jedes Projekt definieren möchten, können Sie es von Grund auf neu erstellen. Da dies jedoch Zeit und Kosten kostet, erstellen wir häufig Codierungsstandards auf der Basis von PEP8. Daher möchte ich diese vorstellen.

Was ist PEP8?

PEP8 ist ein Python-Codierungsstandard, der auf der Idee basiert, dass "Code häufiger gelesen als geschrieben wird". Durch die Entführung dieser Konvention möchten wir den Code leichter lesbar machen und den von jedem Programmierer erstellten Codestil konsistent machen.

Darüber hinaus zeigt PEP8 die Haltung, dass es nicht immer notwendig ist, diese Vereinbarung einzuhalten. Ich denke, es ist besser, flexibel Regeln zu erstellen, die den Merkmalen des Projekts entsprechen.

Beachten Sie jedoch, dass es Zeiten gibt, in denen Sie inkonsistent sein müssen
Das heißt, dieser Styleguide gilt möglicherweise nicht.
Wenn Sie Zweifel haben, priorisieren Sie Ihr Urteil.
Schauen Sie sich andere Beispiele an und entscheiden Sie, welches am besten aussieht.

Wie benutzt man

PEP8 selbst ist eine Konvention, es wird jedoch ein Mechanismus bereitgestellt, mit dem Sie leicht überprüfen können, ob der Code gemäß dieser Konvention geschrieben werden kann.

Umgebungseinstellung Kann mit pip installiert werden

pip install pep8

--Ausführen Geben Sie den Zielquellcode im Argument an und drücken Sie den Befehl pep8

pep8 test.py

--Ergebnis

test.py:16:1: E302 expected 2 blank lines, found 1
test.py:22:80: E501 line too long (95 > 79 characters)
test.py:27:1: E302 expected 2 blank lines, found 1
test.py:39:1: E302 expected 2 blank lines, found 1
test.py:44:11: E225 missing whitespace around operator
test.py:46:12: E225 missing whitespace around operator
test.py:47:13: E225 missing whitespace around operator
test.py:50:27: W291 trailing whitespace
test.py:51:34: W291 trailing whitespace
test.py:60:45: W291 trailing whitespace
test.py:66:16: E231 missing whitespace after ':'
test.py:74:80: E501 line too long (90 > 79 characters)
test.py:90:10: E231 missing whitespace after ','
test.py:92:56: E231 missing whitespace after ','
test.py:101:1: W391 blank line at end of file

Über den Inhalt der Vereinbarung

Hier sind einige der Allgemeinen Geschäftsbedingungen.

Einzug

―― 1 Einzug verwendet 4 Leerzeichen.

Wenn Sie die Linie fortsetzen möchten, richten Sie die umschlossenen Elemente vertikal aus.
Richten Sie die Klammern aus

foo = long_function_name(var_one, var_two,
                         var_three, var_four)

Oder fügen Sie vier Leerzeichen hinzu, um zwischen Argumenten und anderen zu unterscheiden

def long_function_name(
        var_one, var_two, var_three,
        var_four):

Tabulator oder Leerzeichen

Raumfreundliche Einrückungsmethode.

Linienlänge

Alle Zeilenlängen bis zu 79 Zeichen.
Verwenden Sie für Zeilenumbrüche die implizite Fortsetzung von Zeilen in Klammern, Klammern und wellenförmigen Klammern.
Sie können auch einen Schrägstrich verwenden

with open('/path/to/some/file/you/want/to/read') as file_1, \
     open('/path/to/some/file/being/written', 'w') as file_2:
    file_2.write(file_1.read())

Leerzeile

Funktionen und Klassen auf oberster Ebene werden mit zwei Zeilen Abstand definiert.
Definieren Sie die Methode innerhalb der Klasse zeilenweise.

Codierung der Quelldatei

--Verwenden Sie utf8

import

Die Importanweisung sollte normalerweise Zeilen trennen

#good: 
import os
import sys

#bad:  
import sys, os

Geben Sie die Importanweisung mit Ausnahme von Ausnahmen mit einem absoluten Pfad an

#good: 
import mypkg.sibling
from mypkg import sibling
from mypkg.sibling import example

#bad:  
from . import sibling
from .sibling import example

Importe sind unten gruppiert.
Standardbibliothek --Dritte Partybibliothek
Spezifisch für lokale Anwendungen / Bibliotheken

Leerzeichen in Ausdrücken und Sätzen

Setzen Sie grundsätzlich keine Zeichen in Ausdrücke oder Sätze

#good: 
spam(ham[1], {eggs: 2})
#bad: 
spam( ham[ 1 ], { eggs: 2 } )

#good: 
foo = (0,)
#bad: 
bar = (0, )

#good: 
spam(1)
#bad: 
spam (1)

#good: 
dct['key'] = lst[index]
#bad: 
dct ['key'] = lst [index]

#good: 
x = 1
y = 2
long_variable = 3
#bad: 
x             = 1
y             = 2
long_variable = 3

Komma beenden

Es ist normalerweise optional, am Ende ein Komma hinzuzufügen.
Ausnahmsweise erforderlich, wenn ein Taple mit einem Element erstellt wird.

#good
FILES = ('setup.cfg',)

Referenz

https://pep8-ja.readthedocs.io/ja/latest/

[PEP8] Übernehmen Sie den Python-Quellcode und schreiben Sie ihn ordentlich