Die Bedeutung von unterstrichenen Variablen und Funktionen in Python

Variable:

1. Die Variable mit _ davor: gibt an, dass es sich um eine private Variable handelt, die nur verwendet wird, um anzuzeigen, dass die externe Klasse weiterhin auf diese Variable zugreifen kann

2. Variablen mit zwei _ vor und zwei _ am Ende: Geben Sie an, dass es sich um integrierte Variablen handelt.

3. Großgeschriebene und unterstrichene Variablen: Geben Sie globale Variablen an, die sich nicht ändern

Funktion:

1. Variablen mit _ vor: geben an, dass es sich um eine private Funktion handelt, die nur zur Angabe verwendet wird,

2. Funktionen mit zwei _ vor und zwei _ am Ende: Sonderfunktionen angeben

Der Codierungsstil von Python wird in PEP 8 beschrieben. Dieses Dokument beschreibt alle Aspekte des Python-Programmierstils. Unter der Bedingung, dass dieses Dokument eingehalten wird, kann Python-Code, der von verschiedenen Programmierern geschrieben wurde, weitgehend ähnliche Stile beibehalten. Dies erleichtert das Lesen und die Kommunikation zwischen Programmierern.

1 Variable

Konstanten: Großbuchstaben und Unterstrich

USER_CONSTANT

Verwenden Sie für globale Variablen, die sich nicht ändern, Großbuchstaben und Unterstriche.
Private Variablen: Kleinbuchstaben und ein führender Unterstrich

_private_value 

In Python gibt es keine privaten Variablen. Wenn Sie auf eine Variable stoßen, die geschützt werden muss, verwenden Sie Kleinbuchstaben und einen führenden Unterstrich. Dies ist jedoch nur eine Vereinbarung zwischen Programmierern, um zu warnen, dass dies eine private Variable ist und externe Klassen nicht darauf zugreifen sollten. Tatsächlich kann die externe Klasse jedoch weiterhin auf diese Variable zugreifen.
Integrierte Variablen: Kleinbuchstaben, zwei führende Unterstriche und zwei nachfolgende Unterstriche

__class__ 

Zwei führende Unterstriche bewirken, dass die Variable während der Interpretation umbenannt wird. Dies dient dazu, Konflikte zwischen integrierten Variablen und anderen Variablen zu vermeiden. Benutzerdefinierte Variablen sollten diesen Stil unbedingt vermeiden. Um keine Verwirrung zu stiften.

2 Funktionen und Methoden

Im Allgemeinen sollten Kleinbuchstaben und Unterstriche verwendet werden. Einige ältere Bibliotheken verwenden jedoch gemischte Groß- und Kleinschreibung, dh das erste Wort ist in Kleinbuchstaben, der erste Buchstabe jedes Wortes danach in Großbuchstaben und der Rest in Kleinbuchstaben. Aber jetzt sind Kleinbuchstaben und Unterstriche zur Norm geworden.
Private Methode: Kleinbuchstaben und ein führender Unterstrich

def _secrete(self):
    print "don't test me."

Dies entspricht privaten Variablen, nicht wirklich privaten Zugriffsrechten. Gleichzeitig ist zu beachten, dass in allgemeinen Funktionen keine zwei führenden Unterstriche verwendet werden (bei zwei führenden Unterstrichen spielt  die Namensanpassungsfunktion von Python eine Rolle). Spezielle Funktionen werden später erwähnt.
Spezielle Methode: Kleinbuchstaben und zwei führende Unterstriche, zwei nachfolgende Unterstriche

def __add__(self, other):
    return int.__add__(other)

 

Dieser Stil gilt nur für spezielle Funktionen wie das Überladen von Bedienern.

Funktionsparameter: Kleinbuchstaben und Unterstrich, der Standardwert hat auf beiden Seiten des Gleichheitszeichens keine Leerzeichen

def connect(self, user=None):
    self._user = user

Klasse 3

Klassen werden immer im Kamelbuchstabenformat benannt, dh alle Wörter werden groß geschrieben und die restlichen Buchstaben werden in Kleinbuchstaben geschrieben. Der Klassenname sollte präzise, ​​präzise und ausreichend sein, um die von der Klasse geleistete Arbeit zu verstehen. Eine übliche Methode ist die Verwendung eines Suffixes, das den Typ oder die Eigenschaften angibt, z. B.:
SQLEngine
MimeTypes

Für die Basisklasse können Sie ein
Base- oder Abstract-Präfix BaseCookie
AbstractGroup verwenden

class UserProfile(object):
    def __init__(self, profile):
        return self._profile = profile

    def profile(self):
        return self._profile

4 Module und Pakete

Mit Ausnahme des Spezialmoduls __init__ verwenden alle Modulnamen Kleinbuchstaben ohne Unterstriche.
Wenn sie ein Protokoll implementieren, verwenden sie normalerweise lib als Suffix, zum Beispiel:

import smtplib

import os
import sys

5 Informationen zu Parametern

5.1 Verwenden Sie keine Zusicherungen, um die statische Typprüfung zu implementieren

Assertions können zur Überprüfung von Parametern verwendet werden, jedoch nicht nur zur Überprüfung des statischen Typs. Python ist eine dynamisch typisierte Sprache, und die statische Typprüfung verstößt gegen die Designphilosophie. Assertions sollten verwendet werden, um zu verhindern, dass Funktionen bedeutungslos aufgerufen werden.

5.2 Missbrauche * args und ** kwargs nicht

Die Parameter * args und ** kwargs können die Robustheit der Funktion zerstören. Sie verdecken die Signatur, und der Code beginnt häufig, kleine Parameter-Parser zu erstellen, wo dies nicht der Fall sein sollte.

6 andere

6.1 Verwendung hat oder ist ein Präfix, um boolesche Elemente zu benennen

is_connect = True
has_member = False

6.2 Benennen von Sequenzen mit mehreren Formen

members = ['user_1', 'user_2']

6.3 Wörterbücher mit expliziten Namen benennen

person_address = {'user_1':'10 road WD', 'user_2' : '20 street huafu'}

6.4 Vermeiden Sie generische Namen

Namen wie Liste, Diktat, Sequenz oder Element sollten vermieden werden.

6.5 Vermeiden Sie vorhandene Namen

Bereits vorhandene Systemnamen wie os, sys sollten vermieden werden.