Obtenir la sous-commande sélectionnée avec argparse


129

Lorsque j'utilise des sous-commandes avec python argparse, je peux obtenir les arguments sélectionnés.

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')

Donc argsne contient pas 'foo'. Ecrire simplement sys.argv[1]ne fonctionne pas à cause des arguments globaux possibles. Comment puis-je obtenir la sous-commande elle-même?

Réponses:


185

Le bas de la documentation Python sur les sous-commandes argparse explique comment procéder:

>>> 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')

Vous pouvez également utiliser la set_defaults()méthode référencée juste au-dessus de l'exemple que j'ai trouvé.


5
J'aime aussi ajouter required=Truepour forcer les utilisateurs à utiliser une sous-commande.
Ben

14

ArgumentParser.add_subparsersa destun argument formel décrit comme:

dest- nom de l'attribut sous lequel le nom de la sous-commande sera stocké; par défaut Noneet aucune valeur n'est stockée

Dans l'exemple ci-dessous d'une disposition de fonction de tâche simple utilisant des sous-analyseurs, le sous-analyseur sélectionné se trouve dans 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)
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.