argparse leicht gemacht – Dein Praxis‑Guide für Python‑CLI‑Tools

Du willst ein Skript schreiben, das über die Kommandozeile gesteuert wird? Dann ist argparse dein neuer bester Freund. Das Modul gehört zur Python‑Standardbibliothek, du musst also nichts extra installieren. Mit nur wenigen Zeilen Code kannst du benutzerfreundliche Optionen, Flags und Positions‑Argumente bereitstellen – und das automatisch mit hübscher Hilfe‑Ausgabe.

Grundlagen und erstes Beispiel

Ein typisches Setup sieht so aus:

import argparse

parser = argparse.ArgumentParser(description='Einfaches Beispiel')
parser.add_argument('datei', help='Pfad zur Eingabedatei')
parser.add_argument('-v', '--verbose', action='store_true', help='Mehr Ausgaben')
args = parser.parse_args()

print(f'Datei: {args.datei}')
if args.verbose:
    print('Verbose‑Modus aktiv')

Wenn du das Skript mit python script.py data.txt -v startest, bekommst du sofort die Datei‑Info und den Hinweis, dass der Verbose‑Modus läuft. Ohne das -v-Flag bleibt die Ausgabe schlicht – genau das erwartest du von einer gut geschriebenen CLI.

Wichtig: ArgumentParser übernimmt das Parsen von -h/--help automatisch. Tipp: Schreibe eine klare description, damit Nutzer sofort verstehen, worum es geht.

Erweiterte Features & Tricks

Manchmal reichen einfache Flags nicht aus. argparse unterstützt:

• Typumwandlung: parser.add_argument('--zahl', type=int, default=0) sorgt dafür, dass das Argument als ganze Zahl ankommt.
• Mehrere Werte: parser.add_argument('--liste', nargs='+') sammelt beliebig viele Werte in einer Liste.
• Choices: Begrenze Eingaben auf vordefinierte Optionen, z. B. parser.add_argument('--modus', choices=['test','prod']).
• Sub‑Parser: Für komplexe Tools mit mehreren Unterbefehlen (wie git commit vs. git push) kannst du subparsers = parser.add_subparsers(dest='cmd') nutzen und für jeden Befehl eigene Argumente definieren.

Ein häufiger Fehler ist das Setzen von required=False bei Positions‑Argumenten – das macht das Argument optional, obwohl es eigentlich nötig ist. Stattdessen lieber ein Flag einführen oder nargs='?' mit einem sinnvollen default kombinieren.

Willst du deine Hilfe‑Ausgabe noch übersichtlicher? Nutze formatter_class=argparse.ArgumentDefaultsHelpFormatter, um automatisch Standardwerte in der Hilfe anzuzeigen. Das spart Zeit beim Schreiben von Dokumentation.

Ein letzter Trick für schnelle Prototypen: Wenn du das Parsen komplett überspringen willst (z. B. beim Testen), kannst du parser.parse_args([]) aufrufen – das liefert ein Objekt mit allen Default‑Werten.

Damit hast du die wichtigsten Werkzeuge, um robuste, benutzerfreundliche CLI‑Skripte zu bauen. Probier es aus, passe die Parameter an dein Projekt an und du wirst merken, wie viel leichter das Arbeiten mit der Kommandozeile wird.