35    Debugging und Qualitätssicherung 

Das Debugging bezeichnet das Aufspüren und Beseitigen von Fehlern, sogenannten Bugs, in einem Programm. Üblicherweise steht dem Programmierer dabei ein Debugger zur Verfügung. Das ist ein Entwicklerwerkzeug, das es ermöglicht, den Ablauf eines Programms zu überwachen und an bestimmten Stellen anzuhalten. Wenn der Programmablauf in einem Debugger angehalten wurde, kann der momentane Programmstatus analysiert werden. Auf diese Weise können Fehler schneller gefunden werden als durch bloßes gedankliches Durchgehen des Quellcodes oder die Analyse von Programmausgaben.

Ein weiterer Aspekt, der in diesem Kapitel behandelt wird, ist die Qualitätssicherung. Die Qualität einer Software kann nach vielen Maßstäben bewertet werden, beispielsweise nach Fehlerfreiheit oder Laufzeiteffizienz.

Im ersten Abschnitt widmen wir uns dem Debugging allgemein. Danach erläutern wir Module, die nicht direkt etwas mit dem Debugger zu tun haben, sondern allgemein bei der Fehlersuche hilfreich sind. Das betrifft die Module pprint zum formatierten Ausgeben von Instanzen und logging zum Erstellen einer Logdatei. Danach beschäftigen wir uns mit der Qualitätssicherung durch automatisierte Tests und dem Erstellen einer Laufzeitanalyse. Im letzten Abschnitt dieses Kapitels finden Sie eine Reihe von Hinweisen, wie Sie effiziente Programme in Python schreiben können.

35.1    Der Debugger 

Im Lieferumfang von Python ist ein Programm zum Debuggen von Python-Code enthalten, der sogenannte PDB (Python Debugger). Dieser Debugger läuft in einem Konsolenfenster und ist damit weder übersichtlich noch intuitiv. Aus diesem Grund haben wir uns dagegen entschieden, den PDB an dieser Stelle zu besprechen. Sollten Sie dennoch Interesse an diesem Debugger haben, beispielsweise gerade wegen seiner kommandozeilenbasierenden Benutzerschnittstelle, finden Sie nähere Informationen dazu in der Python-Dokumentation.

Viele moderne Entwicklungsumgebungen für Python beinhalten einen umfangreichen integrierten Debugger mit grafischer Benutzeroberfläche, der die Fehlersuche in einem Python-Programm recht komfortabel gestaltet. Auch IDLE bietet einen rudimentären grafischen Debugger:

Abbildung 35.1    Der grafische Debugger von IDLE

Um den Debugger in IDLE zu aktivieren, klicken Sie in der Python-Shell auf den Menüpunkt Debug • Debugger und führen dann das Programm, das Sie auf Fehler untersuchen möchten, ganz normal per Run • Run Module aus. Es erscheint zusätzlich zum Editorfenster ein Fenster, in dem die aktuell ausgeführte Code-Zeile steht. Durch einen Doppelklick auf diese Zeile wird sie im Programm-Code hervorgehoben, sodass Sie stets wissen, wo genau Sie sich im Programmablauf befinden.

Das grundsätzliche Prinzip eines Debuggers ist es, dem Programmierer das schrittweise Ausführen eines Programms zu ermöglichen, um sich auf diese Weise von Zeile zu Zeile ein genaues Bild davon zu machen, welche Änderungen sich ergeben haben und wie sich diese im Laufe des Programms auswirken. Eine Debugging-Session beginnt zumeist damit, dass der Programmierer sogenannte Breakpoints im Programm verteilt. Beim Starten des Debuggers wird das Programm normal ausgeführt, bis der Programmfluss auf den ersten Breakpoint stößt. An dieser Stelle hält der Debugger den Programmlauf an und erlaubt das Eingreifen des Programmierers. Viele Debugger halten auch direkt nach dem Starten an der ersten Programmzeile und warten auf weitere Instruktionen des Programmierers.

Wenn das Programm angehalten wurde und der Programmfluss somit an einer bestimmten Zeile im Quellcode steht, hat der Programmierer mehrere Möglichkeiten, den weiteren Programmlauf zu steuern. Diese Möglichkeiten, im Folgenden Befehle genannt, finden Sie in einem grafischen Debugger üblicherweise an prominenter Stelle in einer Toolbar am oberen Rand des Fensters, da es sich dabei um die essenziellen Fähigkeiten eines Debuggers handelt.

• Mit dem Befehl Step over veranlassen Sie den Debugger dazu, zur nächsten Quellcodezeile zu springen und dort erneut zu halten.
• Der Befehl Step into verhält sich ähnlich wie Step over, mit dem Unterschied, dass bei Step into auch in Funktions- oder Methodenaufrufe hineingesprungen wird, während diese bei Step over übergangen werden.
• Der Befehl Step out springt aus der momentanen Unterfunktion heraus wieder dorthin, wo die Funktion aufgerufen wurde. Step out kann damit gewissermaßen als Umkehrfunktion zu Step into gesehen werden.
• Der Befehl Run führt das Programm weiter aus, bis der Programmfluss auf den nächsten Breakpoint stößt oder das Programmende eintritt. Einige Debugger erlauben es mit einem ähnlichen Befehl, zu einer bestimmten Quellcodezeile zu springen oder den Programm-Code bis zur Cursor-Position auszuführen.

Neben diesen Befehlen, mit denen sich der Programmlauf steuern lässt, stellt ein Debugger einige Hilfsmittel bereit, mit deren Hilfe der Programmierer den Zustand des angehaltenen Programms vollständig erfassen kann. Welche dieser Werkzeuge vorhanden sind und wie sie bezeichnet werden, ist von Debugger zu Debugger verschieden, dennoch möchten wir Ihnen an dieser Stelle eine Übersicht über die gebräuchlichsten Hilfsmittel geben:

• Das grundlegendste Hilfsmittel ist eine Liste aller lokalen und globalen Referenzen mitsamt referenzierter Instanz, die im momentanen Programmkontext existieren. Auf diese Weise lassen sich Wertänderungen verfolgen und Fehler, die dabei entstehen, leichter aufspüren.
• Zusätzlich zu den lokalen und globalen Referenzen ist der Stack von Interesse. In diesem wird die momentane Aufrufhierarchie aufgelistet, sodass sich genau verfolgen lässt, welche Funktion welche Unterfunktion aufgerufen hat.
• Gerade in Bezug auf die Programmiersprache Python bieten einige Debugger eine interaktive Shell, die sich im Kontext des angehaltenen Programms befindet und es dem Programmierer erlaubt, komfortabel Referenzen zu verändern, um somit in den Programmfluss einzugreifen.
• Ein sogenannter Post-Mortem-Debugger kann in Anlehnung an den vorherigen Punkt betrachtet werden. In einem solchen Modus hält der Debugger das Programm erst an, wenn eine nicht abgefangene Exception aufgetreten ist. Im angehaltenen Zustand verfügt der Programmierer wieder über eine Shell sowie über die genannten Hilfsmittel, um dem Fehler auf die Spur zu kommen. Diese Form des Debuggens wird »post mortem« genannt, da sie erst nach dem Auftreten des tatsächlichen Fehlers, also nach dem »Tod« des Programms, aktiviert wird.

Mithilfe dieser Einführung in die Techniken des Debuggens und mit ein wenig Experimentierfreude dürfte es für Sie kein Problem darstellen, den Debugger Ihrer favorisierten IDE in den Griff zu bekommen.

Abgesehen von dem eigentlichen Debugger umfasst die Standardbibliothek von Python noch einige Module, die speziell im Kontext des Debuggens von Bedeutung sind – sei es innerhalb der interaktiven Python-Shell eines Debuggers oder völlig losgelöst vom Debugger. Diese Module werden in den folgenden Abschnitten besprochen.