Erstellen von Python-Programmen für die Befehlszeile

Einführung

Die Python-Befehlszeilenschnittstelle, auch bekannt als Command Line oder Command-Line Interface (CLI), ist eine Möglichkeit, mit einem Computerprogramm zu interagieren, indem Befehle in ein Terminal oder eine Eingabeaufforderung eingegeben werden. Sie ermöglicht es Benutzern, ein Programm auszuführen, Argumente an es zu übergeben und Ausgaben des Programms in Form von Text zu erhalten. Die Befehlszeilenschnittstelle ist besonders nützlich für die Automatisierung von Aufgaben, das Ausführen von Skripten und die Durchführung fortgeschrittener oder komplexer Vorgänge, die über eine grafische Benutzeroberfläche (GUI) schwierig oder unmöglich wären.

In diesem Lab lernen wir, wie man das argparse-Modul verwendet, um Befehlszeilenschnittstellen für unsere Python-Programme zu erstellen. Wir beginnen mit einfachen Beispielen und gehen schrittweise zu komplexeren über. Am Ende dieses Labs sollten Sie ein gutes Verständnis dafür haben, wie Sie das argparse-Modul verwenden, um leistungsstarke Befehlszeilenschnittstellen für Ihre Python-Programme zu erstellen.

Errungenschaften

• argparse-Modul
• Python-Skripte

Importieren des Argparse-Moduls

Der erste Schritt bei der Verwendung des argparse-Moduls besteht darin, es zu importieren.

Sie müssen eine Python-Datei erstellen, die Ihren Code enthält.

touch my_program.py

Wir können dies tun, indem wir die folgende Codezeile an den Anfang unseres Python-Skripts hinzufügen:

import argparse

Erstellen eines Parser-Objekts

Sobald wir das argparse-Modul importiert haben, können wir ein Parser-Objekt erstellen, indem wir die Funktion ArgumentParser() aufrufen. Diese Funktion akzeptiert mehrere optionale Argumente, aber vorerst werden wir nur eine einfache Beschreibung unseres Programms angeben.

parser = argparse.ArgumentParser(description="Eine einfache Befehlszeilenschnittstelle.")

Hinzufügen von Argumenten

Nachdem wir nun ein Parser-Objekt haben, können wir damit beginnen, ihm Argumente hinzuzufügen. Es gibt verschiedene Arten von Argumenten, die wir hinzufügen können, wie z. B. positionale Argumente und optionale Argumente. Zum Beispiel können wir ein positionales Argument wie folgt hinzufügen:

parser.add_argument("name", help="Dein Name")

Und ein optionales Argument wie folgt:

parser.add_argument("-n", "--number", help="Anzahl der Wiederholungen der Nachricht", type=int, default=1)

Parsen von Argumenten

Sobald wir alle unsere Argumente hinzugefügt haben, können wir sie parsen, indem wir die Funktion parse_args() unseres Parser-Objekts aufrufen. Diese Funktion nimmt keine Argumente entgegen und gibt ein Objekt zurück, das die Werte all unserer Argumente enthält.

args = parser.parse_args()

Verwenden der Argumente

Nachdem wir unsere Argumente geparst haben, können wir sie in unserem Programm verwenden. Zum Beispiel können wir das Namensargument wie folgt verwenden:

print("Hallo, " + args.name)

Und das optionale Argument wie folgt:

print("Hallo, " + args.name * args.number)

Vollständiger Code

Hier ist der vollständige Code für das Lab, der alle oben beschriebenen Schritte enthält:

import argparse

## Erstellen eines Parser-Objekts
parser = argparse.ArgumentParser(description="Eine einfache Befehlszeilenschnittstelle.")

## Hinzufügen von Argumenten
parser.add_argument("name", help="Dein Name")
parser.add_argument("-n", "--number", help="Anzahl der Wiederholungen der Nachricht", type=int, default=1)

## Parsen von Argumenten
args = parser.parse_args()

## Verwenden der Argumente
print("Hallo, " + args.name * args.number)

Sie können das Skript ausführen, indem Sie in der Befehlszeile in das Verzeichnis navigieren, in dem sich die Datei befindet, und python my_program.py gefolgt von den Argumenten eingeben, die Sie an das Skript übergeben möchten:

python my_program.py "John" --number 3

Dies gibt "Hello, JohnJohnJohn" in der Konsole aus.

Zusammenfassung

In diesem Lab haben wir gelernt, wie man das argparse-Modul verwendet, um eine Befehlszeilenschnittstelle für ein Python-Programm zu erstellen. Wir haben gesehen, wie man das argparse-Modul importiert, ein Parser-Objekt erstellt, Argumente zum Parser hinzufügt, die Argumente parst und sie in unserem Programm verwendet. Mit diesem Wissen sollten Sie in der Lage sein, leistungsstarke Befehlszeilenschnittstellen für Ihre Python-Programme zu erstellen.