Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
pep8 [2018/11/09 10:41] root angelegt |
pep8 [2018/11/09 18:32] (aktuell) root [Docstrings] |
||
|---|---|---|---|
| Zeile 114: | Zeile 114: | ||
| * Beginnen mit """ | * Beginnen mit """ | ||
| * Die Ausführenden """ | * Die Ausführenden """ | ||
| + | |||
| + | |||
| + | ======= Unterstriche ====== | ||
| + | |||
| + | * Ein führender Unterstrich | ||
| + | * " | ||
| + | * Ein Unterstrich am Ende | ||
| + | * zur Vermeidung von Namenskollisionen mit Python-Buildins | ||
| + | * Zwei führende Unterstriche | ||
| + | * Name-Mangling - beim Vererben wird der Klassenname aus dem die Methode/das Attribut stammt vorangestellt -> vermeidet kollisionen/ | ||
| + | * Zwei führende Unterstriche und zwei nachfolgende | ||
| + | * Magic-Method | ||
| + | |||
| + | ====== Namen ====== | ||
| + | |||
| + | ===== Zu vermeidende Namen ===== | ||
| + | |||
| + | * Kleines el (da Verwechslung mit mit groß I und 1), O (da verwechselbar mit 0) und I (groß ieh, da verwechselbar mit 1 und kleinem l) | ||
| + | * jeweils wenn sie als Einzelvariablennamen genutzt werden sollen | ||
| + | |||
| + | |||
| + | ===== Packages und Module ===== | ||
| + | |||
| + | * Module | ||
| + | * kleingeschrieben, | ||
| + | * Packages | ||
| + | * kleingeschrieben, | ||
| + | |||
| + | |||
| + | ===== Klassennamen ===== | ||
| + | |||
| + | * alle Wörter im Namen beginnen mit Großbuchstaben | ||
| + | * bsp. BrownCat | ||
| + | |||
| + | |||
| + | ===== Exceptions ===== | ||
| + | |||
| + | * entsprechend Klassen | ||
| + | * aber Name sollte mit Error starten wenn es sich um einen Error handelt | ||
| + | |||
| + | |||
| + | ===== Methoden, Funktionen und Variablen ===== | ||
| + | |||
| + | * alles kleingeschrieben | ||
| + | * soweit nötig sollten Wörter per Underscore getrennt sein | ||
| + | |||
| + | |||
| + | ===== Konstanten ===== | ||
| + | |||
| + | * Alles Großgeschrieben (also komplett) | ||
| + | * Unterstriche wenn nötig | ||
| + | |||
| + | |||
| + | |||