Wie lautet die Namenskonvention in Python für Variablen- und Funktionsnamen?

Ausgehend von einem C # -Hintergrund lautet die Namenskonvention für Variablen und Methodennamen normalerweise entweder camelCase oder PascalCase:

// C# example
string thisIsMyVariable = "a"
public void ThisIsMyMethod()

In Python habe ich das Obige gesehen, aber ich habe auch gesehen, dass Unterstriche verwendet werden:

# python example
this_is_my_variable = 'a'
def this_is_my_function():

Gibt es einen bevorzugteren, definitiven Codierungsstil für Python?

Siehe Python PEP 8: Funktions- und Variablennamen :

Funktionsnamen sollten in Kleinbuchstaben geschrieben sein, wobei die Wörter nach Bedarf durch Unterstriche getrennt sind , um die Lesbarkeit zu verbessern.

Variablennamen folgen der gleichen Konvention wie Funktionsnamen.

MixedCase ist nur in Kontexten zulässig, in denen dies bereits der vorherrschende Stil ist (z threading.py ), um die Abwärtskompatibilität beizubehalten.

Der Google Python Style Guide hat die folgende Konvention:

module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_CONSTANT_NAME, global_var_name, instance_var_name, function_parameter_name, local_var_name.

Ein ähnliches Namensschema sollte auf a angewendet werden CLASS_CONSTANT_NAME

David Goodger (in „Code wie ein Pythonista“ hier ) beschreibt den PEP 8 Empfehlungen wie folgt:

• joined_lower für Funktionen, Methoden, Attribute, Variablen

• joined_loweroder ALL_CAPSfür Konstanten

• StudlyCaps für Klassen

• camelCase nur um bereits bestehenden Konventionen zu entsprechen

Wie der Style Guide für Python Code zugibt,

Die Namenskonventionen in Pythons Bibliothek sind ein bisschen chaotisch, daher werden wir dies nie vollständig konsistent machen

Beachten Sie, dass sich dies nur auf die Standardbibliothek von Python bezieht . Wenn sie nicht so konsistent werden können, gibt es kaum Hoffnung auf eine allgemein eingehaltene Konvention für den gesamten Python-Code, oder?

Daraus und aus der Diskussion hier würde ich schließen, dass es keine schreckliche Sünde ist, wenn man beim Übergang zu Python weiterhin die (klaren und gut etablierten) Namenskonventionen von Java oder C # für Variablen und Funktionen verwendet. Denken Sie natürlich daran, dass es am besten ist, sich an den vorherrschenden Stil für eine Codebasis / ein Projekt / ein Team zu halten. Wie der Python Style Guide hervorhebt, ist die interne Konsistenz am wichtigsten.

^{Fühlen Sie sich frei, mich als Ketzer zu entlassen. :-) Wie das OP bin ich noch kein "Pythonista".}

Es gibt PEP 8 , wie andere Antworten zeigen, aber PEP 8 ist nur der Styleguide für die Standardbibliothek und wird nur als Evangelium darin verstanden. Eine der häufigsten Abweichungen von PEP 8 für andere Codeteile ist die Benennung von Variablen, insbesondere für Methoden. Es gibt keinen einzigen vorherrschenden Stil, obwohl man angesichts des Codevolumens, das MixedCase verwendet, wahrscheinlich eine Version von PEP 8 mit MixedCase erhalten würde, wenn man eine strenge Volkszählung durchführen würde. Es gibt kaum eine andere Abweichung von PEP 8, die genauso häufig ist.

Wie bereits erwähnt, soll PEP 8 lower_case_with_underscoresfür Variablen, Methoden und Funktionen verwendet werden.

Ich bevorzuge die Verwendung lower_case_with_underscoresfür Variablen und mixedCasefür Methoden und Funktionen, um den Code expliziter und lesbarer zu machen. Dem Zen von Python zu folgen "explizit ist besser als implizit" und "Lesbarkeit zählt"

weiter zu dem, was @JohnTESlade geantwortet hat. Der Python-Styleguide von Google enthält einige hübsche Empfehlungen.

Zu vermeidende Namen

• Einzelzeichennamen mit Ausnahme von Zählern oder Iteratoren
• Bindestriche (-) in einem beliebigen Paket- / Modulnamen
• \__double_leading_and_trailing_underscore__ names (reserviert von Python)

Namenskonvention

• "Intern" bedeutet intern innerhalb eines Moduls oder geschützt oder privat innerhalb einer Klasse.
• Das Voranstellen eines einzelnen Unterstrichs (_) unterstützt den Schutz von Modulvariablen und -funktionen (nicht im Import * von enthalten). Das Voranstellen eines doppelten Unterstrichs (__) an eine Instanzvariable oder -methode dient effektiv dazu, die Variable oder Methode für ihre Klasse privat zu machen (unter Verwendung der Namensverknüpfung).
• Platzieren Sie verwandte Klassen und Funktionen der obersten Ebene in einem Modul. Im Gegensatz zu Java müssen Sie sich nicht auf eine Klasse pro Modul beschränken.
• Verwendung CapWordsfür Klassennamen, aber lower_with_under.pyfür Modulnamen. Obwohl viele Module benannt sind CapWords.py, wird davon abgeraten, da es verwirrend ist, wenn das Modul zufällig nach einer Klasse benannt wird. ("Warte - habe ich geschrieben import StringIOoder from StringIO import StringIO?")

Richtlinien, die aus Guidos Empfehlungen abgeleitet wurden

Die meisten Python-Leute bevorzugen Unterstriche, aber selbst ich benutze Python seit mehr als 5 Jahren, ich mag sie immer noch nicht. Sie sehen für mich nur hässlich aus, aber vielleicht ist das alles Java in meinem Kopf.

Ich mag CamelCase einfach besser, da es besser zu der Art und Weise passt, wie Klassen benannt werden. Es fühlt sich logischer an, SomeClass.doSomething()als zu haben SomeClass.do_something(). Wenn Sie sich im globalen Modulindex in Python umschauen, werden Sie beides finden. Dies liegt an der Tatsache, dass es sich um eine Sammlung von Bibliotheken aus verschiedenen Quellen handelt, die im Laufe der Zeit gewachsen sind und nicht von einem Unternehmen wie Sun mit strengen Codierungsregeln entwickelt wurden . Ich würde sagen, das Fazit lautet: Verwenden Sie, was Sie besser mögen, es ist nur eine Frage des persönlichen Geschmacks.

Persönlich versuche ich, CamelCase für Klassen, MixedCase-Methoden und -Funktionen zu verwenden. Variablen werden normalerweise durch Unterstriche getrennt (wenn ich mich erinnern kann). Auf diese Weise kann ich auf einen Blick erkennen, was genau ich anrufe, anstatt dass alles gleich aussieht.

Es gibt ein Papier darüber: http://www.cs.kent.edu/~jmaletic/papers/ICPC2010-CamelCaseUnderScoreClouds.pdf

TL; DR Es heißt, dass snake_case besser lesbar ist als camelCase. Deshalb verwenden (oder sollten) moderne Sprachen die Schlange, wo immer sie können.

Der Codierungsstil ist normalerweise Teil der internen Richtlinien- / Konventionsstandards einer Organisation, aber ich denke, im Allgemeinen ist der all_lower_case_underscore_separator-Stil (auch snake_case genannt) in Python am gebräuchlichsten.

Ich persönlich verwende Javas Namenskonventionen bei der Entwicklung in anderen Programmiersprachen, da diese konsistent und leicht zu befolgen sind. Auf diese Weise kämpfe ich nicht ständig darüber, welche Konventionen ich verwenden soll, was nicht der schwierigste Teil meines Projekts sein sollte!

Normalerweise folgt man den Konventionen, die in der Standardbibliothek der Sprache verwendet werden.