cómo dejar que el analizador imprima el mensaje de ayuda en lugar de error y salida

Question

Estoy usando Argparse para manejar CMD Args, quiero que si no hay Args especificados, luego imprima el mensaje de ayuda, pero ahora el análisis generará un error y luego saldrá. Mi código es:

def main():
    print "in abing/start/main"
    parser = argparse.ArgumentParser(prog="abing")#, usage="%(prog)s <command> [args] [--help]")
    parser.add_argument("-v", "--verbose", action="store_true", default=False, help="show verbose output")

    subparsers = parser.add_subparsers(title="commands")

    bkr_subparser = subparsers.add_parser("beaker", help="beaker inspection")
    bkr_subparser.set_defaults(command=beaker_command)
    bkr_subparser.add_argument("-m", "--max", action="store", default=3, type=int, help="max resubmit count")
    bkr_subparser.add_argument("-g", "--grain", action="store", default="J", choices=["J", "RS", "R", "T", "job", "recipeset", "recipe", "task"], type=str, help="resubmit selection granularity")
    bkr_subparser.add_argument("job_ids", nargs=1, action="store", help="list of job id to be monitored")

    et_subparser = subparsers.add_parser("errata", help="errata inspection")
    et_subparser.set_defaults(command=errata_command)
    et_subparser.add_argument("-w", "--workflows", action="store_true", help="generate workflows for the erratum")
    et_subparser.add_argument("-r", "--run", action="store_true", help="generate workflows, and run for the erratum")
    et_subparser.add_argument("-s", "--start-monitor", action="store_true", help="start monitor the errata system")
    et_subparser.add_argument("-d", "--daemon", action="store_true", help="run monitor into daemon mode")
    et_subparser.add_argument("erratum", action="store", nargs=1, metavar="ERRATUM", help="erratum id")

    if len(sys.argv) == 1:
        parser.print_help()
        return

    args = parser.parse_args()
    args.command(args)

    return

¿Cómo puedo hacer eso? Gracias.

Answer 1

Una solución consiste en subclasificar argparse.ArgumentParser y redefiniendo su error() método. De hecho, tras error, ArgumentParser llama a su error() método. El análisis de argumentos personalizados se puede realizar a través de la subclase en lugar de argparse.ArgumentParser. Un modelo error() la función se encuentra en la fuente para argparse:

def error(self, message):
    """error(message: string)

    Prints a usage message incorporating the message to stderr and
    exits.

    If you override this in a subclass, it should not return -- it
    should either exit or raise an exception.
    """
    self.print_usage(sys.stderr)
    self.exit(2, '%s: error: %s\n' % (self.prog, message))

Por ejemplo, es posible plantear una excepción en error(), en lugar de imprimir un mensaje, para que el código llame parse_args() Se encarga de los problemas con los parámetros del usuario.

Respuesta original: Según la aclaración en los comentarios, lo siguiente no funciona. Sin embargo, proporciona un mecanismo para acceder a los mensajes de ayuda desde las funciones del subcomcom:

Casi lo tienes: en cada uno de tus *_command(args) funciones, puede probar el tamaño de args e imprima un mensaje de error si no hay suficientes argumentos.

Si desea utilizar la ayuda generada automáticamente, en sus funciones de comando, puede obtenerla pasando los subparsers a cada comando, así: así:

args.command(subparsers, args)  # Instead of args.command(args)

Cada *_command() La función debe simplemente tomar dos argumentos en lugar de uno. Se puede acceder a la ayuda generada automáticamente a través de:

subparsers.choices['beaker'].print_help()  # or print_usage()

por ejemplo.

Alternativamente, puede elegir pasar directamente el subparrador particular a cada rutina de subcomando *_command():

args.command(subparsers.choices[sys.argv[1]], args)

Y luego, en cada *_command(subparser, args), imprima la ayuda con subparser.print_help().