Usando ‘argparse.ArgumentError’ en Python

me gustaria usar el ArgumentError excepción en el argparse módulo en Python, pero no puedo averiguar cómo usarlo. La firma dice que debería llamarse como ArgumentError(argument, message)pero no puedo entender qué argument debiera ser. Creo que debería ser una parte del objeto del analizador, pero no pude encontrar ninguna documentación al respecto.

De la documentación fuente:

ArgumentError: la excepción que generan los objetos ArgumentParser cuando hay errores con las acciones del analizador. ArgumentParser detecta los errores generados al analizar la línea de comandos y los emite como mensajes de la línea de comandos.

El argument El parámetro del constructor es el Action objeto desde el que se genera la excepción. Por lo general, no hay necesidad de elevarlo fuera de un Action subclase, y al subclasificarla, no hay necesidad de generarla explícitamente; sueles subir ValueError (o lo que sea apropiado) en su lugar.

Valores flotantes entre 0 y 1

Con respecto a su comentario, que solo desea aceptar valores de punto flotante entre 0 y 1. Para esto, debe usar la capacidad de definir tipos personalizados. Puedes hacerlo por ejemplo así:

def percentFloat (string):
    value = float(string)
    if value < 0 or value > 1:
        raise argparse.ArgumentTypeError('Value has to be between 0 and 1')
    return value

parser = argparse.ArgumentParser()
parser.add_argument('test', type=percentFloat)
parser.parse_args()

Tenga en cuenta que esto también es seguro contra los no flotantes como float(string) levantará un ValueError para no flotantes que también desencadena un error de tipo no válido por el argparse módulo. ArgumentTypeError es solo una forma de especificar un mensaje de error personalizado.

Parámetros mutuamente excluyentes

Para parámetros mutuamente excluyentes, debe usar argparse.add_mutually_exclusive_group.

Dependencia de parámetros

La dependencia de parámetros no es realmente algo que deba hacer el argumento analizador. Para obtener detalles semánticos, simplemente debe hacerlo usted mismo:

args = parser.parse_args()
if args.w and not args.p:
    parser.error('-p is required when -w is set.')

Puedes usar ArgumentParser.error para generar un mensaje de error personalizado que interrumpirá el programa e imprimirá en la consola.

Pero, por supuesto, en una situación tan básica tendría mucho más sentido simplemente adivinar implícitamente -p si es posible.

Mientras parser.error() es lo que la mayoría de la gente probablemente quiera, también es posible usar argparse.ArgumentError() (como hace la pregunta). Necesita una referencia al argumento, como el bar_arg en el siguiente ejemplo:

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--foo')
bar_arg = parser.add_argument('--bar')

args = parser.parse_args()
if args.bar == 'xyzzy':
    raise argparse.ArgumentError(bar_arg, "Can't be 'xyzzy'")

if args.foo == 'xyzzy':
    parser.error("Can't be 'xyzzy'")

Esto dará como resultado una salida como la siguiente:

$ python argparse_test.py --foo xyzzy
usage: argparse_test.py [-h] [--foo FOO] [--bar BAR]
argparse_test.py: error: Can't be 'xyzzy'

$ python argparse_test.py --bar xyzzy
Traceback (most recent call last):
  File "argparse_test.py", line 10, in <module>
    raise argparse.ArgumentError(bar_arg, "Can't be 'xyzzy'")
argparse.ArgumentError: argument --bar: Can't be 'xyzzy'