Übung

Python

Wir wollen ein einfaches Formularprogramm schreiben, welches mittels Terminalbefehlen eine Formulardatei erzeugt und diese wieder lesen kann.

Quellcode

Versuche möglichst immer, Type Annotations für die Argumente und Rückgabewerte von Funktionen zu nutzen.

Zunächst benötigen wir ein Modul, in welchem wir unser Projekt erstellen.

Erstelle ein Python Modul (aka. eine Python Datei) mit dem Namen assistant.py im Ordner formular.
Erstelle eine Methode run() welche keine Argumente erhält und zunächst einfach Hello, Formular Assistant! auf der Konsole ausgibt.
Erstelle im root-Verzeichnis eine Datei main.py und importiere die run()-Methode aus assistant.py. Führe diese aus und teste den Code.

Nun benötigen wir eine Möglichkeit, den Nutzer ein Formular erstellen zu lassen. Dafür wollen wir dem Nutzer Fragen stellen.

Erstelle eine Funktion ask_for_form(), welche keine Argumente erhält und dem Nutzer die Möglichkeit gibt, Fragen für ein Formular einzugeben.
- Schreibe einen entsprechenden Docstring.
Frage den Nutzer wiederholt Gib eine Frage ein (oder 'fertig' zum Beenden):
- wenn der Nutzer fertig schreibt, brich aus der Schleife ab
- wenn der Nutzer etwas anderes schreibt, speichere die Frage in einer Liste.
gebe am Ende die Liste zurück.
Führe die Funktion in run() aus:
- Speichere die Fragen dort in einer Variablen
- gib diese zunächst auf der Konsole aus.
Teste den Code.

Jetzt möchten wir die Fragen in einer Datei speichern, damit der Nutzer diese ausfüllen kann.

Erstelle eine Funktion create_form(), welche eine Liste questions und einen Dateinamen filename erhält:
- Ist der Dateiname nicht gegeben, soll dieser form.txt betragen.
Öffne die Datei filename im Schreibmodus (w) mittels eines Kontext-Managers (with).
Schreibe nun jede Frage in eine neue Zeile, wobei die Antwort mittels eines : separiert werden soll:
- Frage? : \n
- Bonus: Nutze f-Strings.
Teste die Funktion.

Jetzt möchten wir die Antworten extrahieren und auf der Konsole ausgeben können.

Erstelle eine Funktion read_form(), welche einen Dateinamen filename erhält:
- Ist der Dateiname nicht gegeben, soll dieser form.txt betragen.
Öffne die Datei filename im Lesemodus (r) mittels eines Kontext-Managers.
Erstelle ein Dictionary answers, welches als Key die Fragen und als Value die jeweilige Antwort erhalten soll.

Lies nun die Datei Zeile für Zeile aus:
- Stelle sicher, dass Leerzeichen, Tabs, Newlines, ... entfernt werden (strip())
- Separiere die Zeilen entsprechend deinem Trenner (split())
- Speichere die Werte im Dictionary (Frage als key, Antwort als value).
Gib das Dictionary zurück.
Teste die Funktion und gib die Daten zunächst auf der Konsole aus.
- Kommentiere die Aufrufe von ask_for_form() und create_form() aus, um nur read_form() zu nutzen.
- Beachte: Vor dem Ausführen musst du die Fragen beantworten!

Es ist umständlich, ständig im Code das Erstellen und Lesen Ein- und Auszukommentieren. Dafür können wir aber Terminal-Argumente nutzen!

Importiere das Modul argparse und erstelle in run() einen neuen parser mit der description "Formular Assistant".
Erstelle eine mutually-exclusive Gruppe, mit den Argumenten:
- -c (--create) welches ein Boolean Value speichert, wenn die Flag existiert (action="store_true")
- -r (--read) welches ein Boolean Value speichert, wenn die Flag existiert.
Füge dem Parser nun noch ein Argument (-f (--file)) hinzu:
- der Type muss str sein
- es muss optional mit dem Default-Value form.txt sein.

Lies nun die Argumente aus (parse_args()).
Bei der Flag -c:
- Frage den Nutzer nach Fragen
- Speichere die Fragen ab
- Schreibe "Formular erstellt."
Bei der Flag -r:
- Lies das Formular aus
- Iteriere über die Fragen und Antworten und gib diese wie folgt aus:
  - Format - Frage : Antwort
  - Fragen in Großbuchstaben
Teste dein Programm.

Hat euch diese Stunde sehr gut gefallen? War sie absolut schrecklich? Das ist mir nicht egal! Also lasst Feedback da!