Python Style–Guide

Zum Abschluss noch ein paar Hinweise/Empfehlungen zum Programmierstil in Python.

Programmierstil sind zum einen verschiedene Konventionen bzgl. der Namen von Variablen, Funktionen, Klassen, die Einrücktiefe für Code-Blöcke, Aussehen der Kommentare, etc.

Eine ausführliche Beschreibung dazu ist im PEP 8 - Style Guide for Python .

Hier nur ein paar kurze Beispiele:

Generell sollte Name Information über Inhalt enthalten, und zusätzlich gilt es Konventionen bzgl. Gross/Klein-Schreibung und Verbindung von Wörtern zu beachten.

Variablen-Namen:

# proper variable name
student_names = [ "Karl", "Lena", "Daniel" ]

# improper variable name
sn847 = [ "Karl", "Lena", "Daniel" ]

# improper variable name
Student_Names = [ "Karl", "Lena", "Daniel" ]

# improper variable name
STUDENT_NAMES = [ "Karl", "Lena", "Daniel" ]

Funktions-Namen:

# proper function name
def count_names():
    pass

# improper function name
def Count_Names():
    pass

# improper function name
def CountNames():
    pass

Klassen-Namen:

# proper class name
class Birds ():
    pass

# proper class name
class BigBirds ():
    pass

# improper class name
class big_birds ():
    pass

Kommentare

Verwendung von Kommentaren ist wichtig um den Code zu dokumentieren – erleichtert die Verwendung des Codes durch andere und auch für sich selbst wenn man den Code nach einiger Zeit wieder ausgräbt.

Ein paar Empfehlungen:

• Wichtigste Regel ist dass die Kommentare korrekt und aktuell sein müssen, besser kein Kommentar als falscher, veralteter oder irreführender!
• Doc-Strings Verwenden bei Deklaration von Funktionen und Klassen
• Keine trivialen Kommentare:
  print("Hallo Welt") # gib "Hallo Welt" aus
  x = math.sin(0.5) # Berechne sinus(0.5)
• Besser selbsterklärender Code als Kommentare

# not good ...
c = a * b**2 * 3.1415 # calculate volume of cylinder with height a and radius b
#
# better 
vol_cyl = height_cyl * radius_cyl**2 * math.pi