Python Argparse Beispiele

„Die Interpretation von Befehlszeilenargumenten wurde durch die Verwendung des Python -Moduls Argparse vorgenommen. Durch die Bereitstellung der zu verarbeitenden Benutzereingänge wird ArgParse verwendet, um die Anpassung und Wiederverwendung des Programms anstelle der expliziten Angabe von Variablen innerhalb der Funktion zu verleihen.”

Befehlszeilenschnittstelle

Eine Methode zur Verhandlung mit einem Befehlszeilenskript würde über die Befehlszeilenschnittstelle oder CLI erfolgen. Obwohl Python über mehrere Module verfügt, mit denen wir möglicherweise Befehlszeilenschnittstellen für verschiedene Skripte konstruieren, ist das Python Argparse -Paket jetzt die effiziente Methode dafür.

Das ArgParse -Modul für Python wurde als Bestandteil des Standard -Frameworks verfügbar gemacht. Es ist die bevorzugte Methode zum Erstellen einer Python -Schnittstelle. Die früheren Bibliotheken „Getopt“ und „OptParse“ wurden durch diesen ersetzt, da ihnen mehrere entscheidende Funktionen fehlten.

Verwendung des Argparse -Moduls

Dies sind die Verwendung des Python Argparse -Moduls:

• • Bietet verschiedene Argumente für ein einzelnes Element.
  • Unterstützt die Verwendung von Positionsparametern.
  • Für Unterbefehle das Zwischenprodukt zulassen.
  • Aktivieren Sie die Änderung der Präfixelemente.

Basierend auf bestimmten Parametern kann ein primärer Befehlszeilenparser zusätzliche Befehlszeilenparser verwenden.

Nutzung einer Befehlszeilenschnittstelle

Nachdem wir uns bewusst sind, was eine Befehlszeilenschnittstelle ist, sind wir vielleicht besorgt darüber, wann es angebracht wäre, sie in das Programm aufzunehmen. Die allgemeine Regel ist, dass wir über eine Befehlszeilenschnittstelle nachdenken werden, wenn wir uns entscheiden, eine benutzerfreundliche Methode zum Anpassen des Projekts anzubieten.

Die geeignete Technik besteht darin, das Python Argparse -Modul zu verwenden. Es ist eine großartige Möglichkeit, den Wert zu verarbeiten, indem eine Befehlszeilenschnittstelle mit dem Python ArgParse -Modul erstellt wird, es sei denn. Auf diese Weise kann der Benutzer festlegen, wessen Konfigurationsdatei verwendet werden soll.

So konstruieren Sie eine Befehlszeilenschnittstelle mithilfe von Python Argparse -Paket

Die Verwendung des Python Argparse -Moduls gibt 4 Phasen:

• • Fügen Sie den ArgParse -Framework in Python ein.
  • Konstruieren Sie den Parser.
  • Stellen Sie dem Parser optionale und Positionsparameter an.
  • Ausführen von Parse_args () Funktion.

Ein benutzerdefiniertes Objekt mit einem grundlegenden Attribut für jeden aus der Befehlszeile erhaltenen Eingabeparameter ist das, was wir nach dem Aufrufen der PARSE_ARGS () -Methode erhalten können.

Lassen Sie uns verschiedene Beispiele ausführen, in denen wir das ArgParse -Modul verwenden.

Beispiel Nr. 1

Eine effiziente Schnittstelle für Verarbeitungsbefehlsleitungsparameter wird vom ArgParse -Tool bereitgestellt. Es zeigt den allgemeinen Gebrauch, Anweisungen und Ausnahmen des Programms. Die Verwendung geeigneter Befehlszeilenparameter wird in der folgenden Abbildung demonstriert.

Dieses Beispiel berechnet den Bereich des Kreises mit einem Ein-Parameter-Radius aus der Befehlszeile. Um Parameter hinzuzufügen und zu analysieren, wurde der ArgumentParser -Objekt -Parser konstruiert. Der Benutzer wird ein Radius -Parameter hinzugefügt, obwohl er als optionaler Parameter gelassen wird. Die Methode würde eine Ausnahme nicht zurückgeben und den Wert des Parameters auf keine festlegen, wenn der Benutzer keinen Wert dafür gibt, wie im folgenden Szenario zu sehen ist.

Argparse importieren
Parser = argParse.ArgumentParser (Beschreibung = 'Finden Sie den Radius eines bestimmten Kreises')
Parser.add_argument ('-r', '-radius', type = int, help = 'berechneter Radius eines bestimmten Kreises')
args = parser.Parse_args ()
Def Main ():
drucken (args.Radius)
hauptsächlich()

Zu Beginn des Programms werden wir die Header -Datei „ArgParse“ importieren, die wir importieren werden. Im nächsten Schritt werden wir einen variablen „Parser“ initialisieren und gleichzeitig die ArgumentPraser () -Methode nennen. Diese Funktion hängt mit dem ArgParse -Modul zusammen. Wir haben die „Beschreibung“ als Parameter der Funktion argumentPraser () gegeben. Dann fügen wir verschiedene Parameter hinzu, sodass wir die Funktion add_argument () verwenden. Diese Funktion enthält drei Parameter, die den Radius des Kreises, den Datentyp des Radius und den Wert des Arguments „Hilfe“ enthalten.

Nach Angabe der Argumente werden wir die Funktion Parse_args () des Parser -Pakets aufrufen. Definieren wir nun den Körper der Main () -Methode. Innerhalb dieser Funktion haben wir die Funktion print () verwendet, um den Radius des angegebenen Kreises anzuzeigen. Am Ende verwenden wir die Main () -Methode.

Beispiel Nr. 2

Das „Erforderliche“ ist ein Argument der Methode add_argument () des ArgumentParser -Objekts. Parameter des Attributs "F" oder "Foo" sind unnötig und werden daher standardmäßig beseitigt. Der Parameter „Erforderliche“ Bedarf kann auf true eingestellt werden, wenn der Benutzer diesen Parameter einfügen möchte. Wie unten gezeigt, wenn wir ein Attribut als „Erforderlich“ festlegen, jedoch keinen Wert dafür angeben, gibt der Compiler eine Ausnahme zurück.

Argparse importieren
Parser = argParse.ArgumentParser (Beschreibung = 'Radius eines beliebigen Kreises bestimmen', Prog = 'Das Programm', uage = '%(prog) s [option]'))
Parser.add_argument ('-r', '-radius', type = int, fordert = true, help = 'Berechter Radius eines bestimmten Kreises')
args = parser.Parse_args ()
Def Main ():
drucken (args.Radius)
hauptsächlich()

Zunächst werden wir das Modul „ArgParse“ integrieren. Der folgende Schritt umfasst die Initialisierung der Variablen „Parser“ und die gleichzeitige Anwendung der ArgumentParser (). Diese Methode ist mit dem ArgParse -Paket verbunden. Die Argumente für die ArgumentParser () -Methode sind Beschreibung und Prog.

Als nächstes fügen wir einige zusätzliche Parameter hinzu, indem wir die Methode add_argument () verwenden. Der Radius des Kreises, der Datentyp des Radius und der Wert des Parameters „Hilfe“ sind die vier Argumente für diese Funktion. Wir setzen den Wert des Parameters "Erforderlich" auf "wahr".

Darüber hinaus nennen wir die Methode Parse_Args () der Parser -Header -Datei, nachdem wir die Argumente angegeben haben. Dann definieren wir den Körper der Main () -Funktion. Die Print () -Methode wurde hier im Körper der Hauptfunktion verwendet, um den Radius des Kreises anzuzeigen. Wir verwenden endlich die main () -Funktion.

Abschluss

Durch die Fertigstellung dieses Artikels verstehen wir nun eine Befehlszeilenschnittstelle und die Methode zur Erstellung eines einzelnen Befehlszeilenarguments mit dem ArgParse -Paket. Wir haben auch diskutiert, was das Python Argparse -Modul ist und warum Benutzer es verwenden, wenn sie die Befehlszeile Python -Code generieren müssen. Wie und wann man eine grundlegende Schnittstelle mit dem ArgParse -Framework effizient erstellt. Wir haben auch die innovative Verwendung des Argparse -Moduls beobachtet. Eine effektive Befehlszeilenschnittstelle kann den Benutzern einen Mechanismus bieten, um sich mit ihrem System zu beschäftigen.