Check inklusive

Trickkiste

In der Praxis helfen einige nützliche Funktionen beim Testen. Doctest formatiert die Testergebnisse so, wie es auch der interaktive Interpreter tun würde. Erwartete Zeichenketten verlangen also einfache Anführungszeichen. Es gelten jedoch einige komplexere Regeln, zum Beispiel, falls eine Zeichenkette selbst ein einfaches Anführungszeichen enthält (siehe Kasten "Tipps und Tricks für Doctests", Zeilen 1 bis 4).

Der Kasten "Tipps und Tricks für Doctests" fasst der Übersichtlichkeit halber mehrere Beispiele zusammen. Jede Leerzeile trennt ein Beispiel vom nächsten ab. Alle Zeilen eines Beispiels gehören – analog zu den Beispielen oben – in den Docstring Ihres Codes, den Sie testen möchten oder in eine getrennte Testdatei.

>>> "ohne Apostroph"
'ohne Apostroph'
>>> """Wie geht's?"""
"Wie geht's?"
>>> class A(object): pass
…
>>> A()
<__main__.A object at 0x8388b0c>
>>> class A(object): pass
…
>>> A()  #doctest: +ELLIPSIS
<__main__.A object at 0x…>
>>> range(1000)  #doctest: +ELLIPSIS
[0, 1, 2, 3, …, 997, 998, 999]
>>> list(1)  #doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
  …
TypeError: 'int' object is not iterable
>>> range(20)  #doctest: +NORMALIZE_WHITESPACE
[ 0,  1,  2,  3,  4,  5,  6,  7,  8,  9,
 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]
>>> print "a\n\nb"
a
<BLANKLINE>
b
>>> vorwahlen
{'Hannover': '0511', 'Berlin': '030'}
>>> d = gib_mir_ein_dictionary()
>>> d == {'Hannover': "0511", 'Berlin': "030"}
True
>>> d = {}
>>> mach_was_mit(d)
>>> d['Berlin']
'030'
>>> 1./13
0.076923076923076927
>>> round(1./13, 6)  # immer noch fehleranfaellig
0.076923000000000005
>>> print round(1./13, 6)  # viel besser
0.076923
>>> daten = erzeuge_daten()
>>> daten  #doctest: +ELLIPSIS
'\x7fELF\x01\x01\x01\x00\x00\x00…\x01\x00\x00\x00\x00\x00\x00\x00'
>>> import md5
>>> md5.new(daten).hexdigest()
'f58860f27dd2673111083770c9445099'

Für einige Situationen bietet das Doctest-Modul Optionen, die Sie an die zu testenden Befehle anhängen [5]. Vor den eigentlichen Optionen steht #doctest: als einleitender String, mehrere Optionsangaben trennen Sie durch Kommas ab. Manchmal tauchen in der Ausgabe eines Tests Bestandteile auf, die sich von einem Testlauf zum nächsten ändern (Zeilen 6 bis 9). Die Adresse in den spitzen Klammern wechselt bei jedem Aufruf. Für einen dennoch konstant funktionierenden Test verwenden Sie den Zusatz ELLIPSIS und kennzeichnen den variablen Teil durch drei Punkte (Zeilen 11 bis 14).

Diese Option hilft Ihnen auch, Schreibarbeit zu sparen (Zeilen 16 und 17). Achten Sie aber darauf, nicht etwa für den Test relevante Teile auszublenden.

Mitunter wechseln von einer Python-Version zur anderen die Fehlermeldungen, die in einer Exception-Ausgabe auftauchen. Zum Beispiel führt die Anweisung list(1) unter Python 2.4 zur Meldung TypeError: iteration over non-sequence, unter Python 2.5 gibt der Interpreter jedoch TypeError: 'int' object is not iterable aus. Solche Unterschiede zwischen Fehlermeldungen dürfen Sie wie in den Zeilen 19 bis 22 mit der Option IGNORE_EXCEPTION_DETAIL vernachlässigen. Der Typ der Ausnahme (hier TypeError) muss nach wie vor stimmen.

Die Option NORMALIZE_WHITESPACE normalisiert Leerraum (Whitespace) in der tatsächlich erzeugten und der erwarteten Ausgabe. Folgen von Leerraum-Zeichen mutieren also zu einzelnen Leerzeichen, was es Ihnen ermöglicht, Ausgaben auf mehrere Zeilen aufzuteilen und zusätzliche Leerzeichen einzufügen (Zeilen 24 bis 26).

Normalerweise sieht Doctest Leerzeilen als Ende eines Tests an. Sind in der Ausgabe echte Leerzeilen zu erwarten, hilft der String <BLANKLINE> in der zu erwartenden Ausgabe. Ohne diese Zeichenkette würde das Doctest-Modul nur die Zeile mit dem a erwarten, was sie mit der Zeichenkette <BLANKLINE> umgehen (Zeilen 28 bis 31). Hier brauchen Sie keine Doctest-Option anzugeben.

Denken Sie daran, dass die Schlüssel/Wert-Paare in Dictionarys keine feste Reihenfolge haben. Ein Test wie in den Zeilen 33 und 34 birgt also die Gefahr eines Fehlers, weil unter Umständen die Reihenfolge in der Ausgabe von Fall zu Fall variiert. Als Test bietet sich in diesem Fall an, das Ergebnis-Dictionary mit dem erwarteten zu vergleichen, siehe Zeilen 36 bis 38. Interessieren Sie dagegen nur bestimmte Einträge, prüfen Sie diese direkt (Zeilen 40 bis 43).

Fließkommazahlen erscheinen je nach Betriebssystem und Bibliotheksversionen unterschiedlich formatiert. Wenn auf Ihrem System der Test in den Zeilen 45 und 46 funktioniert, kann er dennoch auf einem anderen System schiefgehen. Verwenden Sie in diesem Fall die Funktion round in Verbindung mit einer print-Anweisung, um die Ausgaben auf verschiedenen Rechnern zu vereinheitlichen (Zeilen 48 bis 51).

Binärdaten vergleichen Sie bequem auch ohne einen langen Bytestring zu schreiben. Eine Möglichkeit besteht im Gebrauch der Option ELLIPSIS, eine andere im Erzeugen einer Prüfsumme. Die Zeilen 53 bis 58 zeigen beide Varianten.

Ab Python-Version 2.5 empfiehlt es sich, statt des Moduls md5 das Modul hashlib zu verwenden.

Fazit

Mit dem Doctest-Modul bringen Sie Tests auf elegante Art in den Docstrings von Modulen, Funktionen, Klassen und Methoden unter. Ausführlichere Tests lagern Sie besser bis auf grundlegende Anwendungsbeispiele in Textdateien aus. Doctest erweist sich als sehr vielseitig: Mit einigen Tricks nutzen Sie es auch in Fällen, in denen Sie es auf den ersten Blick nicht erwarten würden.

Und zum Schluss noch ein Rat: Schreiben Sie am besten die Tests vor den Funktionen, die Sie prüfen möchten – Stichwort "Testgetriebene Softwareentwicklung". Viel Spass beim Testen!