In diesem Artikel erfahren Sie, wie die Namenskonvention von Python lautet. Die Einführung in die Python-Namenskonventionen hat einen gewissen Referenzwert. Freunde in Not können sich darauf beziehen.
Dateiname
Alle Kleinbuchstaben und Unterstriche können verwendet werden.
Paket
sollte ein kurzer Name in Kleinbuchstaben sein. Unterstreichungen können hinzugefügt werden, wenn sie die Lesbarkeit verbessern. Wie zum Beispiel mein Paket.
Modul
hat die gleiche Spezifikation wie das Paket. Wie zum Beispiel mymodule. Die
-Klasse
schreibt den ersten Buchstaben von Wortzeichenfolgen immer groß. Wie MyClass. Innere Klassen können zusätzliche führende Unterstriche verwenden.
Funktionen und Methoden
Funktionsnamen sollten in Kleinbuchstaben geschrieben werden. Um die Lesbarkeit zu verbessern, können unterstrichene Wörter verwendet werden. Zum Beispiel: myfunction, my_example_function.
*Hinweis*: Eine gemischte Groß-/Kleinschreibung ist nur zulässig, wenn dieser Stil bereits vorherrschend ist, um die Abwärtskompatibilität aufrechtzuerhalten.
Parameter von Funktionen und Methoden
Verwenden Sie immer „self“ als ersten Parameter von Instanzmethoden. Verwenden Sie immer „cls“ als ersten Parameter einer Klassenmethode.
Wenn ein Funktionsparametername mit einem reservierten Schlüsselwort in Konflikt steht, ist es normalerweise besser, einen Suffix-Unterstrich zu verwenden, als eine Abkürzung oder eine seltsame Schreibweise zu verwenden.
Globale Variablen
Wenn Sie für die from M import * import-Anweisung verhindern möchten, dass globale Variablen in das Modul importiert werden, können Sie die alte Spezifikation verwenden und einen führenden Unterstrich hinzufügen globale Variable.
*Hinweis*: Vermeiden Sie die Verwendung globaler Variablen
Variablen
Variablennamen werden alle in Kleinbuchstaben geschrieben, wobei die einzelnen Wörter durch Unterstriche verbunden werden. Beispiel: color = WHITE, this_is_a_variable = 1
*Hinweis*:
1. Verwenden Sie nicht das Präfix m oder g, unabhängig davon, ob es sich um eine Klassenmitgliedsvariable oder eine globale Variable handelt.
2. Private Klassenmitglieder werden mit einem einzelnen Unterstrich-Präfix identifiziert. Definieren Sie mehr öffentliche Mitglieder und weniger private Mitglieder.
3. Variablennamen sollten keine Typinformationen enthalten, da Python eine dynamisch typisierte Sprache ist. Wie iValue, Names_list, dict_obj usw. sind allesamt schlechte Namen.
Konstante
Alle Buchstaben in Konstantennamen sind in Großbuchstaben geschrieben und jedes Wort ist durch einen Unterstrich verbunden, z. B. MAX_OVERFLOW, TOTAL.
Ausnahmen
werden mit dem Suffix „Fehler“ versehen.
Abkürzungen
Sie sollten versuchen, bei der Benennung vollständig buchstabierte Wörter zu verwenden. Es gibt zwei Arten von Abkürzungen:
1. Häufig verwendete Abkürzungen wie XML, ID usw Auch bei der Benennung kann nur der erste Buchstabe groß geschrieben werden, z. B. XmlParser.
2. Wenn der Name lange Wörter enthält, kürzen Sie ein bestimmtes Wort ab. In diesem Fall sollte die übliche Abkürzung verwendet werden.
Zum Beispiel:
Funktion wird als fn abgekürzt
Text, abgekürzt als txt
Objekt, abgekürzt als obj
Anzahl, abgekürzt als cnt
Zahl, abgekürzt als num, usw.
Führender und Suffix-Unterstrich
Ein führender Unterstrich: zeigt nicht öffentlich an.
Ein Suffix-Unterstrich: Vermeiden Sie Schlüsselwortkonflikte.
Zwei führende Unterstriche: Wird verwendet, wenn die Benennung eines Klassenattributs zu einem Namenskonflikt führt.
Zwei führende und angehängte Unterstriche: „magische“ (spezielle) Objekte oder Attribute, wie __init__ oder __file__. Erstellen Sie niemals solche Namen, sondern verwenden Sie sie einfach.
*HINWEIS*: Es gibt einige Kontroversen bezüglich der Verwendung von Unterstrichen.
Spezifische Benennungsmethode
Bezieht sich hauptsächlich auf die vom System reservierte Wortbenennungsmethode in der Form __xxx__. Diese Art der Benennung kann auch in Projekten verwendet werden. Ihre Bedeutung besteht darin, dass Variablen in dieser Form schreibgeschützt sind und Klassenmitgliedsfunktionen in dieser Form nicht so stark wie möglich überlastet werden sollten. Zum Beispiel
class Base(object): def __init__(self, id, parent = None): self.__id__ = id self.__parent__ = parent def __message__(self, msgid): # …略
wobei __id__, __parent__ und __message__ alle die vom System reservierte Wortnomenklatur verwenden.
Anhang: Google Python-Namenskonvention
Modulname, Paketname, Klassenname, Methodenname, Ausnahmename, Funktionsname, GLOBAL_VAR_NAME, Instanzvariablenname, Funktionsparametername, lokaler_Variablenname.
Das obige ist der detaillierte Inhalt vonWas ist die Namenskonvention von Python? Einführung in Python-Namenskonventionen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!
