Obter subcomando selecionado com argparse


129

Quando uso subcomandos com python argparse, posso obter os argumentos selecionados.

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

Então argsnão contém 'foo'. Simplesmente escrever sys.argv[1]não funciona devido aos possíveis argumentos globais. Como posso obter o subcomando em si?

Respostas:


184

A parte inferior dos documentos do Python nos subcomandos argparse explica como fazer isso:

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

Você também pode usar o set_defaults()método mencionado logo acima do exemplo que encontrei.


5
Também gosto de adicionar required=Truepara forçar os usuários a usar um subcomando.
21419 Ben

14

ArgumentParser.add_subparserspossui destargumento formal descrito como:

dest- nome do atributo sob o qual o nome do subcomando será armazenado; por padrão Nonee nenhum valor é armazenado

No exemplo abaixo de um layout função tarefa simples usando subparsers, o subparser seleccionada é em 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)
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.