Spezifikationen für Python-Code

1: Hintergrund

wird verwendet, um die OCP-Python-Entwicklung zu standardisieren und einen einheitlichen Stil für mit Python entwickelte Programme zu verwenden, um dies zu erleichtern Codierung Wartung von

2: Python Stilspezifikation

• Punkte Symbol: Fügen Sie am Ende der Zeile kein Semikolon hinzu und verwenden Sie kein Semikolon, um zwei Befehle in derselben Zeile zu platzieren

• Klammern: Verwenden Sie Klammern sparsam und nicht übermäßig. Sofern sie nicht zur Implementierung der Zeilenverkettung verwendet werden, verwenden Sie keine Klammern in Rückgabeanweisungen oder bedingten Anweisungen. Klammern um Tupel sind jedoch zulässig.

• Einrückung: Verwenden Sie 4 Leerzeichen, anstatt den Code einzurücken. Verwenden Sie niemals Tabulatoren oder mischen Sie Tabulatoren und Leerzeichen. Für die Zeilenverkettung sollten Sie umschlossene Elemente entweder vertikal ausrichten oder einen hängenden Einzug mit 4 Leerzeichen verwenden (in diesem Fall sollte die erste Zeile keine Parameter haben).

• leere Zeile: Zwei leere Zeilen zwischen -Definitionen der obersten Ebene, wie z. B. Funktionen oder Klassendefinitionen. Zwischen Methodendefinitionen, Klassendefinitionen und der ersten Methode sollte eine Leerzeile stehen. Wenn Sie es in Funktionen oder Methoden an manchen Stellen für angemessen halten, lassen Sie eine Leerzeile

• Leerzeichen: Verwenden Sie Leerzeichen auf beiden Seiten der Interpunktion gemäß den Standardformatierungskonventionen. Innerhalb der Klammern sollten keine Leerzeichen stehen; vor Kommas, Semikolons und Doppelpunkten sollten keine Leerzeichen eingefügt werden, aber sie sollten danach eingefügt werden (außer am Ende der Zeile). Indizes oder öffnende Klammern von Slices; Fügen Sie auf beiden Seiten des binären -Operators ein Leerzeichen hinzu, z. B. Zuweisung (=), Vergleich (==, <, >, !=, < ;>, <=, > =, in, nicht in, ist, ist nicht), Boolescher Wert (und, oder, nicht). Wie Sie die Leerzeichen auf beiden Seiten der arithmetischen Operatoren verwenden, müssen Sie selbst beurteilen. Allerdings müssen beide Seiten konsistent sein; wenn „=“ verwendet wird, um Schlüsselwortparameter oder Standardparameterwerte anzugeben, verwenden Sie keine Leerzeichen auf beiden Seiten, da dies zu einem wird Wartungsproblem Belastung (gilt für:, #, = usw.)

• Klasse: Wenn eine Klasse nicht

  von anderen Klassen erbt , es wird angezeigt von Objektklasse erbt

• Zeichenfolge : Auch wenn die Parameter alle Zeichenfolgen sind, verwenden Sie den %-Operator oder das Format Methode zum Formatieren von Zeichen String , verwenden Sie nicht die +-Methode

• Importmethode: Jeder Import hat seine eigene Zeile. Importe sollten immer oben in der Datei platziert werden, nach Modul--Kommentaren und Dokumentzeichenfolgen und vor Modul-Global--Variablen und -Konstanten . Die Importe sollten in der Reihenfolge von der häufigsten zur am wenigsten verbreiteten Gruppe erfolgen: Import von Standardbibliotheken; Programmspezifische Importe; jede Gruppe sollte auf der Vollständigkeit von basieren Jedes Modul. Paketpfade werden lexikografisch sortiert, wobei Groß- und Kleinschreibung

• -Anweisungen ignoriert werden: Normalerweise sollte jede Anweisung in einer eigenen Zeile stehen. Wenn die Testergebnisse und Testanweisungen in eine Zeile passen, können Sie sie in dieselbe Zeile einfügen. Im Falle einer

  if-Anweisung ist dies nur möglich, wenn es kein else gibt. Tun Sie dies insbesondere niemals mit try/exclusive, da try undexclusive nicht in derselben Zeile stehen können.

• Name: ob_

  Modul_Name ob_Paketname ObKlasseName TestObClassName Methodenname Testmethodenname AusnahmeName Funktionsname GLOBAL_VAR_NAME Instanz_Var_Name Funktionsparametername Local_Var_Name

• Weitere Punkte werden später hinzugefügt

Drei: Anforderungen:

• Nachdem der Code geändert wurde, müssen Sie zuerst Pylint ausführen und dann eine Überprüfung einleiten. Der Pylint-Score muss über 90 liegen. Einige offensichtliche Unregelmäßigkeiten müssen korrigiert werden

• pylint Verwendung: Führen Sie tools/pylint.sh im obztools-Verzeichnis

  Datei

aus. Viertens: Referenz:

• PEP 8 – Style Guide für Python-Code: http://legacy.python.org/dev/peps/pep-0008/

• Python Coding Style Guide Chinesische Übersetzung (Google SOC): http://www.elias.cn/Python/PythonStyleGuide?from= Develop .PythonStyleGuide

Das obige ist der detaillierte Inhalt vonSpezifikationen für Python-Code. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!