Ein Forscher eines Pharmaunternehmens fasste die Python-Codierungsstandards zusammen

Einführung

In diesem Abschnitt werden die Python-Codierungskonventionen beschrieben.

In PEP8 definierte Codierungskonventionen

Python hat einen Codierungsstandard namens PEP8. Die in PEP8 angegebene Gliederung ist unten dargestellt.

Importanweisung

Verwenden Sie in der import-Anweisung nicht "import os, sys" usw., sondern teilen Sie sie wie unten gezeigt in mehrere Zeilen auf. Fügen Sie außerdem eine Leerzeile ein, um zwischen Standardbibliotheken, Bibliotheken von Drittanbietern, lokalen Modulen usw. zu unterscheiden.

import os
import sys

from django.utils import timezone

from my_app.models import User

Leerraum im Satz

a = 1
b = a + 2
list_nums = [a, b]
dict_nums = {'a': a, 'b': b}

Fügen Sie vor und nach = ein Leerzeichen mit halber Breite ein und nach , ein Leerzeichen mit halber Breite in Listen und Wörterbücher ein. Fügen Sie außerdem ein Leerzeichen mit halber Breite nach dem : in das Wörterbuch ein.

Einzug

Wenn Sie eine if-Anweisung, eine for-Anweisung oder eine Funktion oder Klasse definieren, schreiben Sie die Zeile nach dem : mit einem Einzug von vier Leerzeichen halber Breite (und einem Vielfachen davon).

if True:
    print("It's true.")

Leerzeile

Lassen Sie zwei Zeilen vor den Funktions- oder Klassendefinitionen der obersten Ebene. Lassen Sie eine Zeile für Methoden in der Klasse.

def my_func():
    return 'my_func'


class MyClass():
    name = my_class

    def print_name(self):
        return self.name

Anzahl der Zeichen pro Zeile

Die Anzahl der Zeichen in einer Zeile beträgt grundsätzlich 79 Zeichen oder weniger. Verwenden Sie für die Dokumentzeichenfolge maximal 72 Zeichen.

Überprüfen Sie mit Flake8

Es gibt "flake8" als Werkzeug, um zu überprüfen, ob der Quellcode mit PEP8 übereinstimmt. Es kann mit dem folgenden Befehl ausgeführt werden.

$flake8 Dateiname.py

Beim Ausführen wird angezeigt, welche Teile des Quellcodes welche Codierungskonventionen nicht erfüllen.

Zusammenfassung

Hier habe ich den Codierungsstandard von Python erklärt. Python ist eine lesbare Sprache, daher ist es wichtig, Code zu schreiben, der für andere leicht zu lesen ist.