Obtenga el subcomando seleccionado con argparse


129

Cuando uso subcomandos con python argparse, puedo obtener los argumentos seleccionados.

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

Entonces argsno contiene 'foo'. Simplemente escribir sys.argv[1]no funciona debido a los posibles argumentos globales. ¿Cómo puedo obtener el subcomando en sí?

Respuestas:


185

La parte inferior de los documentos de Python en los subcomandos argparse explica cómo hacer esto:

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

También puede usar el set_defaults()método al que se hace referencia justo encima del ejemplo que encontré.


55
También me gusta agregar required=Truepara obligar a los usuarios a usar un subcomando.
Ben

14

ArgumentParser.add_subparserstiene destun argumento formal descrito como:

dest- nombre del atributo bajo el cual se almacenará el nombre del subcomando; por defecto Noney no se almacena ningún valor

En el siguiente ejemplo de un diseño de función de tarea simple usando subparsers, el subparser seleccionado está en 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)
Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.