L'utilisation de 'argparse.ArgumentError' en Python

Je voudrais utiliser le ArgumentError exception dans le argparse module en Python, mais je ne peux pas comprendre comment l'utiliser. La signature est dit qu'il devrait être appelé comme ArgumentError(argument, message), mais je ne peux pas comprendre ce que argument devrait être. Je pense qu'il devrait y avoir une certaine partie de l'analyseur de l'objet, mais je ne pouvais pas trouver toute la documentation pour elle.

  • Connexes: Est-il mauvais pour élever ArgumentError à la main?
  • Vous pouvez l'utiliser au sein d'un Action classe, tout comme les classes existantes ne. Mais je ne peux pas imaginer une raison pour le faire en dehors de la parser. Il n'est pas quelque chose de spécial - ajoute simplement les Action nom pour le message d'erreur. L'étude de son utilisation dans le code.
InformationsquelleAutor asmeurer | 2011-11-12
  1. 62

    De la documentation de la source:

    ArgumentError: L'exception soulevée par ArgumentParser objets quand il y a des erreurs avec l'analyseur de ses actions. Les erreurs soulevées lors de l'analyse de la ligne de commande sont pris en ArgumentParser et émis sous forme de ligne de commande les messages.

    La argument paramètre du constructeur est le Action objet à partir de laquelle l'exception est soulevée. Habituellement, il n'est pas nécessaire pour l'élever à l'extérieur d'un Action sous-classe, et quand il sous-classement, il n'est pas nécessaire pour l'élever de façon explicite; vous pose généralement ValueError (ou tout ce qui est approprié) à la place.

    Flottent des valeurs entre 0 et 1

    En ce qui concerne votre commentaire, que vous ne voulez accepter les valeurs à virgule flottante compris entre 0 et 1. Pour cela, vous devez utiliser la capacité de définir des types personnalisés. Vous pouvez le faire, par exemple comme ceci:

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

    Noter que c'est également protégé contre les non-flotte comme float(string) de soulever un ValueError pour les non-flotte qui déclenche également un type non valide erreur par le argparse module. ArgumentTypeError est juste un moyen de spécifier un message d'erreur personnalisé.

    Mutuellement exclusifs paramètres

    Pour mutuellement exclusifs paramètres, vous devez utiliser argparse.add_mutually_exclusive_group.

    Paramètre de dépendance

    Paramètre de dépendance n'est pas vraiment quelque chose qui devrait être fait par l'argument analyseur. Pour les détails sémantiques, en revanche, vous pouvez tout simplement le faire vous-même:

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

    Vous pouvez utiliser ArgumentParser.erreur pour élever le message d'erreur personnalisé qui va interrompre le programme et d'impression à la console.

    Mais bien sûr, dans une telle situation de base, il ferait beaucoup plus de sens, juste pour implicitement deviner -p si possible.

    • Ce n'est pas le bon. Si je viens d'envoyer la valeur, je reçois AttributeError: 'float' object has no attribute 'option_strings'.
    • Et par la manière, je veux l'utiliser parce que je veux faire de ce type de vérification que le module ne gère pas directement. Par exemple, je veux une valeur en virgule flottante qui est entre 0 et 1. argparse vous permet de spécifier qu'il devrait être un float, mais je dois vérifier manuellement la gamme. Cela semble être le bon d'erreur à émettre lorsque la valeur est erronée.
    • Édité ma réponse pour vous donner un exemple sur la façon de le faire.
    • Le downvote est parce que la réponse est fausse. ArgumentError(1.1, "Valeur hors de la plage") soulève AttributeError, comme je l'ai mentionné ci-dessus. Ce doit être une sorte de interne argparse objet, mais je ne peux pas comprendre ce que. Et en passant, un autre exemple de lorsque vous voulez faire, c'est quand vous voulez définir un non-trivial de la dépendance sur les arguments, qui, autant que je peux dire, le module argparse ne prend pas directement en charge. Quelque chose comme la -w option nécessite la -p option, ou -n et -N sont mutuellement exclusifs.
    InformationsquelleAutor poke
  2. 15

    Tout parser.error() est ce que la plupart des gens probablement le souhaitez, il est également possible d'utiliser argparse.ArgumentError() (comme la question se pose.) Vous avez besoin d'une référence à l'argument, comme le bar_arg dans l'exemple ci-dessous:

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

    Cela entraînera une sortie comme celle ci-dessous:

    $ 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'
    • C'est un bon exemple de la façon dont l'aide ArgumentError à l'extérieur de la parser est possible, mais probablement inférieure à l'aide de parser.error.
    • oui, mais ArgumentError a un avantage: il vous permet de savoir quel interrupteur était celle incriminée.
    • Eh bien, si vous écrivez votre message d'erreur bien, alors vous seriez sûr de mention que l'interrupteur a été celle incriminée. Création d'une variable distincte pour chaque argument supplémentaire peut être très lourd...
    • C'est une question de préférence, je suppose. Moi je préfère la variable à la rédaction de "'--foo' ne peut pas être "xyzzy"", car je puis n'oubliez pas que le nom correct de l'interrupteur (ce n'est pas nécessairement le même que l'attribut de args). Mais honnêtement, je pense que parser.error() doit inclure le nom de la délinquance commutateur par défaut.
    InformationsquelleAutor ukrutt