24    Kontextobjekte 

Es gibt Operationen, die in einem bestimmten Kontext ausgeführt werden müssen und bei denen sichergestellt werden muss, dass der Kontext jederzeit korrekt deinitialisiert wird, beispielsweise auch, wenn eine Exception auftritt. Ein Beispiel für einen solchen Kontext ist ein geöffnetes Dateiobjekt: Es muss sichergestellt sein, dass die close-Methode des Dateiobjekts gerufen wird, selbst wenn zwischen dem Aufruf von open und dem der close-Methode des Dateiobjekts eine Exception geworfen wurde.

Für diese Zwecke definiert Python sogenannte Kontextobjekte. Das sind Objekte, die über die Magic Members __enter__ und __exit__ verfügen, um den Kontext zu betreten bzw. zu verlassen. Speziell für die Verwendung von Kontextobjekten existiert die with-Anweisung, die Sie im folgenden Abschnitt kennenlernen.

 

24.1    Die with-Anweisung 

Zum Realisieren eines Dateikontextes ist mit den herkömmlichen Sprachelementen von Python die folgende try/finally-Anweisung nötig:

f = open("datei.txt", "r")
try: 
    print(f.read())
finally: 
    f.close()

Zunächst wird eine Datei namens datei.txt zum Lesen geöffnet. Die darauffolgende try/finally-Anweisung stellt sicher, dass f.close in jedem Fall aufgerufen wird. Der Nachteil dieser Schreibweise ist, dass sich der Programmierer darum kümmern muss, dass das Dateiobjekt korrekt deinitialisiert wird. Die with-Anweisung überträgt diese Verantwortung an das Objekt selbst und erlaubt eine kurze und elegante Alternative zu dem oben dargestellten Code:

with open("programm.py", "r") as f:
    print(f.read())

Die with-Anweisung besteht aus dem Schlüsselwort with, gefolgt von einer Instanz. Optional können auf die Instanz das Schlüsselwort as und ein Bezeichner folgen. Dieser Bezeichner wird Target genannt, und seine Bedeutung hängt von der verwendeten Instanz ab. Im Beispiel oben referenziert f das geöffnete Dateiobjekt.

Anstatt mehrere with-Anweisungen zu verschachteln, können die jeweiligen Instanzen und Bezeichner auch, durch Kommata getrennt, in eine with-Anweisung geschrieben werden. So ist der Code

with open("file1.txt", "r") as f1, open("file2.txt", "r") as f2:
    print(f1.read())
    print(f2.read()) 

äquivalent zu:

with open("file1.txt") as f1:
    with open("file2.txt", "r") as f2:
        print(f1.read())
        print(f2.read()) 

Um zu verstehen, was bei einer with-Anweisung genau passiert, definieren wir im nächsten Beispiel eine eigene Klasse, die sich mit der with-Anweisung verwenden lässt. Eine solche Klasse wird Kontext-Manager genannt.

Die Klasse MeinLogfile ist dazu gedacht, eine rudimentäre Logdatei zu führen. Dazu implementiert sie die Funktion eintrag, die eine neue Zeile in die Logdatei schreibt. Die Klassendefinition sieht folgendermaßen aus:

class MeinLogfile:
    def __init__(self, logfile):
        self.logfile = logfile
        self.f = None
    def eintrag(self, text): 
        self.f.write("==>{}\n".format(text))
    def __enter__(self):
        self.f = open(self.logfile, "w")
        return self
    def __exit__(self, exc_type, exc_value, traceback): 
        self.f.close()

Zu den beiden ersten Methoden der Klasse gibt es nicht viel zu sagen. Dem Konstruktor __init__ wird der Dateiname der Logdatei übergeben, der intern im Attribut self.logfile gespeichert wird. Zusätzlich wird das Attribut self.f angelegt, das später das geöffnete Dateiobjekt referenzieren soll.

Die Methode eintrag hat die Aufgabe, den übergebenen Text in die Logdatei zu schreiben. Dazu ruft sie die Methode write des Dateiobjekts auf. Beachten Sie, dass die Methode eintrag nur innerhalb einer with-Anweisung aufgerufen werden kann, da das Dateiobjekt erst in den folgenden Magic Methods geöffnet und geschlossen wird.

Die angesprochenen Magic Methods __enter__ und __exit__ sind das Herzstück der Klasse und müssen implementiert werden, wenn die Klasse im Zusammenhang mit with verwendet werden soll. Die Methode __enter__ wird aufgerufen, wenn der Kontext aufgebaut, also bevor der Körper der with-Anweisung ausgeführt wird. Die Methode bekommt keine Parameter, gibt aber einen Wert zurück. Der Rückgabewert von __enter__ wird später vom Target-Bezeichner referenziert, sofern einer angegeben wurde. Im Falle unserer Beispielklasse wird die Datei self.logfile zum Schreiben geöffnet und mit return self eine Referenz auf die eigene Instanz zurückgegeben.

Die zweite Magic Method __exit__ wird aufgerufen, wenn der Kontext verlassen wird, also nachdem der Körper der with-Anweisung entweder vollständig durchlaufen oder durch eine Exception vorzeitig abgebrochen wurde. Im Falle der Beispielklasse wird das geöffnete Dateiobjekt self.f geschlossen. Näheres zu den drei Parametern der Methode __exit__ folgt weiter unten.

Die soeben erstellte Klasse MeinLogfile lässt sich folgendermaßen mit with verwenden:

with MeinLogfile("logfile.txt") as log:
    log.eintrag("Hallo Welt")
    log.eintrag("Na, wie gehts?")

Zunächst wird eine Instanz der Klasse MeinLogfile erstellt und dabei der Dateiname logfile.txt übergeben. Die with-Anweisung bewirkt als Erstes, dass die Methode __enter__ der Instanz ausgeführt und ihr Rückgabewert durch log referenziert wird. Dann wird der Körper der with-Anweisung ausgeführt, in dem insgesamt zweimal die Methode eintrag aufgerufen und damit Text in die Logdatei geschrieben wird. Nachdem der Anweisungskörper ausgeführt worden ist, wird einmalig die Methode __exit__ der Instanz inst aufgerufen.

Im Folgenden werden die Magic Methods __enter__ und __exit__ vollständig erläutert.

__enter__(self)

Diese Magic Method wird einmalig zum Öffnen des Kontextes aufgerufen, bevor der Körper der with-Anweisung ausgeführt wird. Der Rückgabewert dieser Methode wird im Körper der with-Anweisung vom Target-Bezeichner referenziert.

__exit__(self, exc_type, exc_value, traceback)

Die Magic Method __exit__ wird einmalig zum Schließen des Kontextes aufgerufen, nachdem der Körper der with-Anweisung ausgeführt worden ist. Die drei Parameter exc_type, exc_value und traceback spezifizieren Typ, Wert und Traceback-Objekt einer eventuell innerhalb des with-Anweisungskörpers geworfenen Exception. Wenn keine Exception geworfen wurde, referenzieren alle drei Parameter None. Wie mit einer geworfenen Exception weiter verfahren wird, steuern Sie mit dem Rückgabewert: Gibt die Methode True zurück, wird die Exception unterdrückt. Bei einem Rückgabewert von False wird die Exception erneut geworfen.