Holen Sie sich den ausgewählten Unterbefehl mit argparse

129

Wenn ich Unterbefehle mit Python Argparse verwende, kann ich die ausgewählten Argumente abrufen.

parser = argparse.ArgumentParser()
parser.add_argument('-g', '--global')
subparsers = parser.add_subparsers()   
foo_parser = subparsers.add_parser('foo')
foo_parser.add_argument('-c', '--count')
bar_parser = subparsers.add_parser('bar')
args = parser.parse_args(['-g, 'xyz', 'foo', '--count', '42'])
# args => Namespace(global='xyz', count='42')

Also argsnicht enthalten 'foo'. Einfach zu schreiben sys.argv[1]funktioniert aufgrund der möglichen globalen Argumente nicht. Wie kann ich den Unterbefehl selbst erhalten?

Adam Schmideg
quelle

Antworten:

184

Ganz unten in den Python-Dokumenten zu argparse-Unterbefehlen wird erläutert, wie dies funktioniert:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('-g', '--global')
>>> subparsers = parser.add_subparsers(dest="subparser_name") # this line changed
>>> foo_parser = subparsers.add_parser('foo')
>>> foo_parser.add_argument('-c', '--count')
>>> bar_parser = subparsers.add_parser('bar')
>>> args = parser.parse_args(['-g', 'xyz', 'foo', '--count', '42'])
>>> args
Namespace(count='42', global='xyz', subparser_name='foo')

Sie können auch die set_defaults()Methode verwenden, auf die direkt über dem Beispiel verwiesen wird, das ich gefunden habe.

Robert
quelle
5
Ich möchte auch hinzufügen required=True, um Benutzer zu zwingen, einen Unterbefehl zu verwenden.
Ben
14

ArgumentParser.add_subparsershat destformale Argumentation beschrieben als:

dest- Name des Attributs, unter dem der Unterbefehlsname gespeichert wird; Standardmäßig wird Nonekein Wert gespeichert

Im folgenden Beispiel eines einfachen Taskfunktionslayouts mit Unterparsern befindet sich der ausgewählte Unterparser in parser.parse_args().subparser.

import argparse


def task_a(alpha):
    print('task a', alpha)


def task_b(beta, gamma):
    print('task b', beta, gamma)


if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    subparsers = parser.add_subparsers(dest='subparser')

    parser_a = subparsers.add_parser('task_a')
    parser_a.add_argument(
        '-a', '--alpha', dest='alpha', help='Alpha description')

    parser_b = subparsers.add_parser('task_b')
    parser_b.add_argument(
        '-b', '--beta', dest='beta', help='Beta description')
    parser_b.add_argument(
        '-g', '--gamma', dest='gamma', default=42, help='Gamma description')

    kwargs = vars(parser.parse_args())
    globals()[kwargs.pop('subparser')](**kwargs)
saaj
quelle