Zusammenfassung des Python-Codierungsstandards PEP8 (1) Fortsetzung

Kommentar

Kommentar blockieren

Blockkommentare (#) gelten im Allgemeinen für folgenden Code und rücken auf derselben Ebene wie dieser Code ein.

Inline-Kommentar

Lassen Sie zwischen der Anweisung und dem Inline-Kommentar mindestens zwei Leerzeichen. Es sind keine selbsterklärenden Inline-Kommentare erforderlich.

schlechtes Beispiel:
x = x + 1          #Erhöhen Sie x um 1

Dokumentationszeichenfolgen (auch als "Dokumentzeichenfolgen" bezeichnet)

Sie sollten für jedes Modul, jede Funktion, jede Klasse oder Methode eine Dokumentzeichenfolge schreiben.

Namenskonvention

Das wichtigste Prinzip

Verwenden Sie einen Namen, der eher die Verwendung als die Implementierung widerspiegelt

Praktische Benennungsmethode

b (1 unterer Buchstabe)
B (1 Großbuchstabe)
lowercase
lower_case_with_underscores
UPPERCASE
UPPER_CASE_WITH_UNDERSCORES
CapitalizedWords

Namenskonventionen folgen

Verwenden Sie nicht die einzelnen Zeichen "l" (untere Ell), "O" (oberes O) und "I" (oberes Auge) als Variablen. -Der Name des Moduls sollte in allen unteren Buchstaben kurz sein.
Verwenden Sie die CapWords-Methode für Klassennamen (verbinden Sie Wörter, indem Sie sie groß schreiben) -Intra-modulbeschränkte globale Variablen werden mit einem Unterstrich (_) versehen, um deutlich zu machen, dass sie nicht nach außen offengelegt werden. -Funktionsnamen sollten nur in Kleinbuchstaben angegeben werden
Verwenden Sie immer self als Namen des ersten Arguments der Instanzmethode
Verwenden Sie immer cls für den Namen des ersten Arguments der Klassenmethode
Verwenden Sie nur Methodennamen und Instanzvariablen in Kleinbuchstaben und trennen Sie gegebenenfalls Wörter mit Unterstrichen. ・ Schreiben Sie Konstanten in Großbuchstaben und trennen Sie Wörter mit Unterstrichen.

Vererbungsdesign

Fügen Sie am Anfang der öffentlichen Attribute keinen Unterstrich hinzu -Wenn der Name des veröffentlichten Attributs mit dem reservierten Wort in Konflikt steht, fügen Sie unmittelbar nach dem Namen des Attributs einen Unterstrich hinzu. · Verwenden Sie Eigenschaften, um die Implementierung von Funktionsaufrufen mit einer einfachen Datenzugriffssyntax auszublenden ・ Wenn es ein Attribut gibt, das Sie nicht in der Unterklasse verwenden möchten, fügen Sie zwei Unterstriche am Anfang des Namens anstelle des Endes hinzu.

Öffentliche und interne Schnittstellen

· Eine dokumentierte Schnittstelle wird als öffentliche Schnittstelle betrachtet, es sei denn, das Dokument deklariert sie ausdrücklich als interne Schnittstelle. · Internen Schnittstellen (Pakete, Module, Klassen, Funktionen, Attribute und andere Namen) wird ein Unterstrich vorangestellt.

Programmierempfehlungen

· Schreiben Sie Code, der andere Python-Implementierungen (PyPy, Jython, IronPython, Cython, Psyco usw.) nicht benachteiligt.)

Verwenden Sie immer oder nicht, wenn Sie mit None vergleichen -Alle Operationen bei der Implementierung der Sortierung mit erweitertem Vergleich (__eq__, __ne__, __lt__, __le__, __gt__, __ge__) Implementieren · Verwenden Sie immer die def-Anweisung, anstatt eine Zuweisungsanweisung zu schreiben, die den Lambda-Ausdruck direkt mit dem Bezeichner verbindet

Gutes Beispiel:
def f(x): return 2*x

schlechtes Beispiel:
f = lambda x: 2*x

· Versuchen Sie, Ausnahmen von Ausnahmen anstelle von BaseExceptions abzuleiten · Python3 verwendet "Raise X from Y", um Ausnahmen explizit auszutauschen, ohne den ursprünglichen Traceback zu verlieren

Verwenden Sie erhöhe ValueError ('message'), um eine Ausnahme in Python2 auszulösen
Wenn Sie eine Ausnahme abfangen, geben Sie eine bestimmte Ausnahme anstelle der rohen Ausnahme an, die keine Ausnahme angibt.

So was
try:
    import platform_specific_module
except ImportError:
    platform_specific_module = None

-Wenn Sie die abgefangene Ausnahme an einen bestimmten Namen binden möchten, benennen Sie die Ausnahme explizit

So was
try:
    process_data()
except Exception as exc:
    raise DataProcessingFailedError(str(exc))

· Verwenden Sie explizit die neue betriebssystembezogene Fehlerhierarchie, wenn Sie Betriebssystemfehler abfangen -Für alle Versuche / Ausnahmen beschränken Sie den in try enthaltenen Bereich auf den minimal erforderlichen Code.

Gutes Beispiel:
try:
    value = collection[key]
except KeyError:
    return key_not_found(key)
else:
    return handle_value(value)

schlechtes Beispiel:
try:
    #Der Prozess des Einschlusses in try ist zu groß
    return handle_value(collection[key])
except KeyError:
    # handle_value()Fängt auch den von generierten KeyError ab
    return key_not_found(key)

· Verwenden Sie die with-Anweisung, wenn die Ressource nur in einem bestimmten Teil des Codes verwendet wird ・ Schreiben Sie die return-Anweisung konsistent. -Wenn die Funktion eine return-Anweisung enthält, die einen Ausdruck zurückgibt, wird die return-Anweisung, die keinen Wert zurückgibt, explizit als return None geschrieben.

Verwenden Sie die Zeichenfolgenmethode anstelle des Zeichenfolgenmoduls · Verwenden Sie '' .startswith () und ''. Endswith () anstelle des String-Slicing, um zu überprüfen, ob ein String ein bestimmtes Präfix oder Suffix hat.

Gutes Beispiel: if foo.startswith('bar'):
schlechtes Beispiel: if foo[:3] == 'bar':

· Verwenden Sie immer isinstance (), um Objekttypen zu vergleichen, anstatt Typen direkt zu vergleichen

Gutes Beispiel: if isinstance(obj, int):
schlechtes Beispiel: if type(obj) is type(1):

-Für Sequenzen verwenden Sie die Tatsache, dass die leere Sequenz False ist.

Gutes Beispiel: if not seq:
       if seq:

schlechtes Beispiel: if len(seq):
       if not len(seq):

Schreiben Sie keine Zeichenfolgenliterale, die von Leerzeichen am Zeilenende abhängen · Verwenden Sie == nicht mehr, um Boolesche Werte mit True oder False zu vergleichen

Gutes Beispiel:      if greeting:
schlechtes Beispiel:      if greeting == True:
Schlimmeres Beispiel:  if greeting is True:

Funktionsanmerkung

Code, der Funktionsanmerkungen in einem anderen Stil als PEP484 verwenden möchte (https://www.python.org/dev/peps/pep-0484/#suggested-syntax-for-python-2-7-and-straddling-code) Über,

type: ignore

Wird am Anfang der Datei geschrieben. Dies weist das Typprüfungsprogramm an, alle Anmerkungen zu ignorieren.

abschließend

Wenn Sie nur verstehen, dass es so geschrieben ist, denke ich, dass dieser Inhalt ausreichend ist. Wenn Sie mehr wissen möchten (warum Sie es so schreiben sollten), lesen Sie bitte Dokumentation.

Fassen wir den Python-Codierungsstandard PEP8 (2) zusammen.