Migrieren von optparse-Code zu argparse

Das Modul argparse bietet mehrere High-Level-Funktionen, die das Modul optparse nicht nativ bereitstellt, darunter

• Behandlung von Positionsargumenten.

• Unterstützung von Unterbefehlen.

• Zulassen alternativer Optionspräfixe wie + und /.

• Behandlung von Argumenten im Stil Null-oder-mehr und Eins-oder-mehr.

• Erzeugung informativerer Nutzungsnachrichten.

• Bereitstellung einer wesentlich einfacheren Schnittstelle für benutzerdefinierte type und action.

Ursprünglich versuchte das Modul argparse, die Kompatibilität mit optparse aufrechtzuerhalten. Aufgrund der grundlegenden Designunterschiede zwischen der Unterstützung der deklarativen Verarbeitung von Kommandozeilenoptionen (während die Verarbeitung von Positionsargumenten der Anwendung überlassen wird) und der Unterstützung von sowohl benannten Optionen als auch Positionsargumenten in der deklarativen Schnittstelle ist die API im Laufe der Zeit von der von optparse abgewichen.

Wie in Auswahl einer Argumenten-Parser-Bibliothek beschrieben, können Anwendungen, die derzeit optparse verwenden und mit dessen Funktionsweise zufrieden sind, optparse einfach weiter verwenden.

Anwendungsentwickler, die eine Migration in Erwägung ziehen, sollten auch die Liste der intrinsischen Verhaltensunterschiede in diesem Abschnitt überprüfen, bevor sie entscheiden, ob eine Migration wünschenswert ist.

Für Anwendungen, die sich für die Migration von optparse zu argparse entscheiden, sollten die folgenden Vorschläge hilfreich sein

• Ersetzen Sie alle Aufrufe von optparse.OptionParser.add_option() durch Aufrufe von ArgumentParser.add_argument().

• Ersetzen Sie (options, args) = parser.parse_args() durch args = parser.parse_args() und fügen Sie zusätzliche ArgumentParser.add_argument() Aufrufe für die Positionsargumente hinzu. Beachten Sie, dass das, was bisher als options bezeichnet wurde, nun im Kontext von argparse als args bezeichnet wird.

• Ersetzen Sie optparse.OptionParser.disable_interspersed_args() durch die Verwendung von parse_intermixed_args() anstelle von parse_args().

• Ersetzen Sie Callback-Aktionen und die Schlüsselwortargumente callback_* durch die Argumente type oder action.

• Ersetzen Sie Zeichenkettennamen für Schlüsselwortargumente type durch die entsprechenden Typobjekte (z. B. int, float, complex usw.).

• Ersetzen Sie optparse.Values durch Namespace und optparse.OptionError sowie optparse.OptionValueError durch ArgumentError.

• Ersetzen Sie Zeichenketten mit impliziten Argumenten wie %default oder %prog durch die Standard-Python-Syntax zur Formatierung von Zeichenketten mit Wörterbüchern, d. h. %(default)s und %(prog)s.

• Ersetzen Sie das Argument version des Konstruktors OptionParser durch einen Aufruf von parser.add_argument('--version', action='version', version='<die Version>').