Sauberen Code schreiben in Python – Ein Anfängerleitfaden

Sauberen Code schreiben in Python – Ein Anfängerleitfaden

Grundlagen für klaren, verständlichen und wartbaren Python-Code

Inhaltsverzeichnis

Kapitel 1: Warum sauberer Code wichtig ist

• Der Unterschied zwischen „funktionierendem“ und „gutem“ Code
• Vorteile von lesbarem Code
• Was ist „Clean Code“ in Python?
• Zielgruppe und Aufbau des Buches

Kapitel 2: Gute Namen wählen

• Aussagekräftige Variablennamen
• Konventionen für Variablen, Funktionen und Klassen
• Benennung von Booleans, Schleifen und Konstanten
• Was man vermeiden sollte (z. B. x, tmp, data1)

Kapitel 3: Funktionen klein und fokussiert halten

• Eine Funktion = eine Aufgabe
• Funktionslänge und Lesbarkeit
• Parameter begrenzen
• Rückgabewerte klar definieren

Kapitel 4: Kommentare sinnvoll einsetzen

• Wann Kommentare hilfreich sind
• Kommentare vs. selbsterklärender Code
• Docstrings für Funktionen und Klassen
• Was vermieden werden sollte: veraltete und redundante Kommentare

Kapitel 5: Einrückung und Formatierung

• Python-Syntax und Einrückung
• Leerzeilen und Absätze im Code
• Standardisierte Formatierung (PEP 8)
• Verwendung von Formatierungs-Tools wie black

Kapitel 6: Kontrollstrukturen klar gestalten

• if-Blöcke verständlich formulieren
• Verschachtelungen vermeiden
• frühzeitiges Rückgeben (return early)
• Nutzung von logischen Ausdrücken

Kapitel 7: Wiederholung vermeiden (DRY-Prinzip)

• Wiederverwendbare Funktionen schreiben
• Schleifen und Listen statt Copy-Paste
• Erkennen und Auslagern von gemeinsamem Code

Kapitel 8: Fehlerbehandlung strukturiert einsetzen

• Sinnvolle try-except-Blöcke
• Lesbare Fehlermeldungen
• Keine leeren except-Blöcke
• Logische Fehlerbehandlung vs. technische

Kapitel 9: Klar strukturierte Programme schreiben

• Aufbau von Skripten und Modulen
• Trennung von Logik, Eingabe und Ausgabe
• Hauptfunktion (main()) und Namensraumkontrolle
• Projektstruktur in kleinen Anwendungen

Kapitel 10: Testen und Refaktorisieren

• Warum Tests helfen, sauberen Code zu erhalten
• Einfache Tests mit assert
• Kleine Schritte beim Umstrukturieren
• Refactoring als ständiger Prozess

Anhang A: Wichtige PEP-8-Regeln auf einen Blick

• Einrückung, Leerzeichen, Benennungen, Kommentare
• Übersicht als Tabelle für den Alltag

Anhang B: Tools und Hilfsmittel für sauberen Code

• flake8, black, isort, pylint
• Kurzbeschreibung und Einsatzbeispiele

Anhang C: Übungsaufgaben zur Code-Verbesserung

• Unleserlichen Code optimieren
• Kommentare in sauberen Code überführen
• Funktionen vereinfachen
• Musterlösungen mit Vorher-Nachher-Vergleich