close

Verwendung argparse in Python: Befehlszeilenargumente

Das argparse Modul in Python ist ein leistungsstarkes Tool zum Verarbeiten und Parsen von Befehlszeilenargumenten beim Ausführen eines Programms. Es ermöglicht Ihnen, die erforderlichen Parameter und Optionen für Ihr Programm einfach zu definieren und bietet flexible Mechanismen zum Lesen und Verwenden dieser Parameter.

Hier sind die Schritte zur Verwendung des argparse Moduls:

  1. Modul importieren argparse: Starten Sie Ihr Programm, indem Sie das argparse Modul importieren.

  2. Definieren Sie das ArgumentParser Objekt: Erstellen Sie ein ArgumentParser Objekt, um die erforderlichen Parameter und Optionen für Ihr Programm zu definieren.

  3. Argumente hinzufügen: Verwenden Sie die .add_argument() Methode des ArgumentParser Objekts, um die erforderlichen Parameter und Optionen für Ihr Programm hinzuzufügen. Jedes Argument kann einen Namen, einen Datentyp, eine Beschreibung und verschiedene andere Attribute haben.

  4. Argumente analysieren: Verwenden Sie die .parse_args() Methode des ArgumentParser Objekts, um die Argumente von der Befehlszeile aus zu analysieren und sie in einem Objekt zu speichern.

  5. Verwenden Sie die Argumente: Verwenden Sie die im analysierten Objekt aus dem vorherigen Schritt gespeicherten Werte, um Aktionen auszuführen, die den bereitgestellten Optionen in der Befehlszeile entsprechen.

Beispiel: Hier ist ein einfaches Beispiel für argparse die Berechnung der Summe zweier Zahlen über die Befehlszeile:

import argparse  
  
# Define the ArgumentParser object  
parser = argparse.ArgumentParser(description='Calculate the sum of two numbers.')  
  
# Add arguments to the ArgumentParser  
parser.add_argument('num1', type=int, help='First number')  
parser.add_argument('num2', type=int, help='Second number')  
  
# Parse arguments from the command-line  
args = parser.parse_args()  
  
# Use the arguments to calculate the sum  
sum_result = args.num1 + args.num2  
print(f'The sum is: {sum_result}')

Wenn Sie das Programm mit Argumenten ausführen, zum Beispiel: python my_program.py 10 20, lautet die Ausgabe: The sum is: 30 und es wird die Summe der beiden über die Befehlszeile bereitgestellten Zahlen angezeigt.