Python #29 – das defaultdict

In diesem Beitrag möchte ich dir aus dem Python3 Modul Collections das defaultdict vorstellen. Das Dictionary habe ich dir bereits im Beitrag Python #12: Arbeiten mit Dictionaries vorgestellt und möchte hier nun an diesen Beitrag anknüpfen.

ein kleiner Rückblick

Wir wissen bereits das wir ein Dictionary mit einer geschweiften Klammern erzeugen können und in diesem Werte als Schlüssel/Werte Paare (Key/Value) ablegen können.

def main():
    d = {"firstname": "Stefan", "lastname": "Draeger", "age": "40"}
    print(d)
    pass

main()

Wenn wir die Funktion “main” nun ausführen erhalten wir die Ausgabe:

Soweit kennen wir das ja bereits. Und wenn wir auf einen Wert in diesem Dictionary zugreifen wollen müssen wir den Schlüssel in einer eckigen Klammer übergeben (1) und wir erhalten  den Wert (2) (in diesem Beispiel wird der Wert auf der Konsole ausgegeben).

ABER was ist wenn dieser Schlüssel nicht existiert? Genau, dann erhalten wir eine Exception. 

Wir müssten also um unseren Code robuster zu gestalten eine Prüfung auf den Schlüssel implementieren.

def main():
    d = {"firstname": "Stefan", "lastname": "Draeger", "age": "40"}
    if "address" in d:
        print(d["address"])
    else:
        print("Der Key 'address' existiert nicht!")

main()

Bei einem Key ist die Prüfung und vor allem der Code noch recht lesbar aber wenn mehr Code existiert dann wird der Code schon sehr aufgebläht. Hier muss also eine “vernünftige” alternative her und diese lautet “defaultdict”.

das defaultdict aus Python3

Schauen wir uns nun das defaultdict aus dem Modul Collections an. Das defaultdict ist eine Subklasse des dict und erweitert dieses um einige nützliche Funktionen.

Wie der Name es erahnen lässt können wir “irgendwas” default quasi Standardmäßig machen.
Und das ist zbsp. einen Schlüssel anlegen wenn dieser nicht existiert wir aber darauf zugreifen.

# importieren der Klasse defaultdict aus dem Modul collections
from collections import defaultdict

# Funktion welche ausgeführt werden soll
# wenn das defaultdict mit einem unbekannten
# Key aufgerufen wird.
def lieferwas():
    pass

def main():
    d1 = {"firstname": "Stefan", "lastname": "Draeger", "age": "40"}
    # liefert einen KeyError
    # print(d1["nix"])

    # erzeugen eines defaultdict
    # übergeben der Funktion (ohne runde Klammern!)
    d2 = defaultdict(lieferwas)
    # liefert ein "None"
    print(d2["nix"])

main()

Wichtig: Die Funktion welche das defaultdict aufrufen soll wenn ein Key nicht existiert darf keine runden Klammern haben. Denn sonst wird diese bei der Initialisierung aufgerufen.

In der Funktion “lieferwas” können wir nun einen Wert zurück geben mit welchem wir ohne weiteres weiterarbeiten können.

# importieren der Klasse defaultdict aus dem Modul collections
from collections import defaultdict

# Funktion welche ausgeführt werden soll
# wenn das defaultdict mit einem unbekannten
# Key aufgerufen wird.
def lieferwas():
    print("Funktion lieferwas wird aufgerufen")
    return "-undefined-"

def main():
    # erzeugen eines defaultdict
    # übergeben der Funktion (ohne runde Klammern!)
    d2 = defaultdict(lieferwas)
    # erster Aufruf mit einem nicht bekannten Key
    print(d2["nix"])  
    # Ausgabe des dict
    print(d2)
    # zweiter Aufruf mit einem nicht bekannten Key 
    print(d2["nix"])

main()

Wenn wir den Code nun ausführen sehen wir dass, beim ersten Aufruf des Dictionarys mit einem unbekannten Key die Funktion “lieferwas” aufgerufen wird. Danach wird diese Funktion nicht mehr ausgegeben denn es wurde ein Schlüssel/Werte Paar angelegt mit “nix” & “-undefined-“.

C:\Users\stefa\PycharmProjects\pythonProject\venv\Scripts\python.exe C:/Users/stefa/PycharmProjects/pythonProject/main.py
Funktion lieferwas wird aufgerufen
-undefined-
defaultdict(<function lieferwas at 0x0000020D94256430>, {'nix': '-undefined-'})
-undefined-

Process finished with exit code 0

ein kleines Beispiel mit dem defaultdict

Hier nun ein kleines Beispiel mit einem defaultdict. Nehmen wir einen simplen Text von https://www.loremipsum.de/ und zählen dort einmal die verschiedenen Wörter.

# importieren der Klasse defaultdict aus dem Modul collections
from collections import defaultdict

# erzeugen eines Textes
text = "" \
       "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, " \
       "sed diam nonumy eirmod tempor invidunt ut labore et dolore magna " \
       "aliquyam erat, sed diam voluptua. At vero eos et accusam et justo" \
       "duo dolores et ea rebum. Stet clita kasd gubergren, no " \
       "sea takimata sanctus est Lorem ipsum dolor sit amet."

# Eine Funktion welche aufgerufen werden soll wenn
# das defaultdict mit einem unbekannten Key aufgerufen
# wird.
def initDefaultKey():
    return 0

def main():
    # initialisieren des defaultdict mit der Funktion "initDefaultKey"
    textCounter = defaultdict(initDefaultKey)
    # für jedes Wort im Text mache...
    for t in text.split(" "):
        # lesen des Wertes und erhöhen des Wertes um 1
        textCounter[t] = textCounter[t] + 1

    # ausgeben des Inhalts der Variable "textCounter"
    print(textCounter)
    
main()

Ausgabe auf der Konsole:

C:\Users\stefa\PycharmProjects\pythonProject\venv\Scripts\python.exe C:/Users/stefa/PycharmProjects/pythonProject/main.py
defaultdict(<function initDefaultKey at 0x0000018C5D096430>, {
          'Lorem': 2, 'ipsum': 2, 'dolor': 2, 
          'sit': 2, 'amet,': 1, 'consetetur': 1, 
          'sadipscing': 1, 'elitr,': 1, 'sed': 2,
          'diam': 2, 'nonumy': 1, 'eirmod': 1, 
          'tempor': 1, 'invidunt': 1, 'ut': 1, 
          'labore': 1, 'et': 4, 'dolore': 1, 
          'magna': 1, 'aliquyam': 1, 'erat,': 1, 
          'voluptua.': 1, 'At': 1, 'vero': 1, 
          'eos': 1, 'accusam': 1, 'justoduo': 1, 
          'dolores': 1, 'ea': 1, 'rebum.': 1, 
          'Stet': 1, 'clita': 1, 'kasd': 1, 
          'gubergren,': 1, 'no': 1, 'sea': 1, 
          'takimata': 1, 'sanctus': 1, 
          'est': 1, 'amet.': 1
})

Process finished with exit code 0