Lektion 3: Stil und Struktur beim Schreiben von Python-Code

Einführung in Code-Stil und Struktur

Ein klar strukturierter und gut formatierter Quellcode ist für die Lesbarkeit und Wartbarkeit von Programmen unerlässlich. Besonders in Python, einer Sprache, die stark auf Lesbarkeit ausgelegt ist, kommt der Einhaltung eines einheitlichen Stils besondere Bedeutung zu.

Guter Code-Stil erleichtert nicht nur die Zusammenarbeit im Team, sondern hilft auch dabei, Fehler zu vermeiden und den Code langfristig zu pflegen.

Bedeutung der Einrückung (Indentation)

In Python wird die Blockstruktur des Codes nicht durch geschweifte Klammern ({}) definiert, sondern ausschließlich durch Einrückungen (meist 4 Leerzeichen). Eine korrekte Einrückung ist nicht nur stilistisch wichtig, sondern zwingend erforderlich, da sie die logische Struktur des Programms bestimmt.

• Fehlerquellen vermeiden: Inkonsistente Einrückungen führen zu Syntaxfehlern.
• Lesbarkeit erhöhen: Ein sauber eingerückter Code zeigt klar, welche Anweisungen zu welchem Block gehören.
• Empfehlung: Verwenden Sie konsequent 4 Leerzeichen für jede Einrückungsebene und keine Tabulatoren.

Gut zu wissen: Viele Code-Editoren und IDEs (z.B. Visual Studio Code, PyCharm) unterstützen automatische Einrückung und erleichtern die Einhaltung dieses Standards.

Aussagekräftige Bezeichner (Variablen- und Funktionsnamen)

Die Wahl von klaren und aussagekräftigen Namen für Variablen, Funktionen und Klassen ist entscheidend für das Verständnis des Codes.

• Vermeiden Sie Abkürzungen: Statt cnt lieber count.
• Benutzen Sie englische Begriffe: Diese sind international verständlich und etablierter Standard.
• Folgen Sie Namenskonventionen: Variablen und Funktionen in snake_case, Klassen in PascalCase.
• Beispiel: calculate_average_score() ist klarer als calcAvg().

Sinnvolle Kommentare schreiben

Kommentare sollen den Code erklären, aber keine offensichtlichen Dinge wiederholen. Sie dienen dazu, komplexe Logik, Annahmen oder den Zweck von Abschnitten verständlich zu machen.

• Kurz und prägnant: Vermeiden Sie lange Erklärungen, die den Code überladen.
• Dokumentationskommentare: Nutzen Sie Docstrings für Funktionen und Klassen, um Parameter und Rückgabewerte zu beschreiben.
• Beispiel für Docstring:

def add_numbers(a, b):
    """
    Addiert zwei Zahlen und gibt das Ergebnis zurück.

    Parameter:
    a (int): Erste Zahl
    b (int): Zweite Zahl

    Rückgabe:
    int: Summe von a und b
    """
    return a + b

Funktionen und Klassen strukturieren

Eine gute Strukturierung in Funktionen und Klassen fördert die Wiederverwendbarkeit und Lesbarkeit.

• Funktionen: Jede Funktion sollte eine klar umrissene Aufgabe haben und nicht zu lang sein (idealerweise unter 20 Zeilen).
• Klassen: Objektorientierte Programmierung ermöglicht die Gruppierung von verwandten Daten und Funktionen.
• Kapselung: Vermeiden Sie globale Variablen und schützen Sie Daten durch geeignete Sichtbarkeitskonzepte.

Code-Länge und Modularität

Modularer Code, der in kleine, überschaubare Teile zerlegt ist, erleichtert das Verständnis, das Testen und die Wartung.

• Single Responsibility Principle: Jede Funktion oder Klasse sollte nur eine Aufgabe haben.
• Vermeiden Sie lange Funktionen: Lange Codeblöcke erschweren das Nachvollziehen.
• Modulaufteilung: Organisieren Sie Funktionen und Klassen in separate Dateien (Module) nach Themen oder Funktionalitäten.

Praxisbeispiele

Hier ein Vergleich eines schlecht strukturierten und eines gut strukturierten Codes:

Schlecht:

def c(a,b):
  x=a+b
  print(x)
c(5,7)

Gut:

def addiere_zahlen(zahl1, zahl2):
    """
    Addiert zwei Zahlen und gibt die Summe zurück.
    """
    summe = zahl1 + zahl2
    print(f"Das Ergebnis ist: {summe}")

addiere_zahlen(5, 7)

Der gut strukturierte Code ist nicht nur verständlicher, sondern auch leichter erweiterbar und wartbar.