python parsal_Tutoriel argparse — Documentation Python 3.6.13

Combinaison d’arguments positionnels et optionnels¶

Notre programme continue de croître en complexité :

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("square", type=int,

help="display a square of a given number")

parser.add_argument("-v", "--verbose", action="store_true",

help="increase output verbosity")

args = parser.parse_args()

answer = args.square**2

if args.verbose:

print("the square of{}equals{}".format(args.square, answer))

else:

print(answer)

Et voilà le résultat :

$ python3 prog.py

usage: prog.py [-h] [-v] square

prog.py: error: the following arguments are required: square

$ python3 prog.py 4

16

$ python3 prog.py 4 --verbose

the square of 4 equals 16

$ python3 prog.py --verbose 4

the square of 4 equals 16

Nous avons ajouté un argument nommé, d’où le message d’erreur.

Notez que l’ordre importe peu.

Qu’en est-il si nous donnons à ce programme la possibilité d’avoir plusieurs niveaux de verbosité, et que celui-ci les prend en compte :

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("square", type=int,

help="display a square of a given number")

parser.add_argument("-v", "--verbosity", type=int,

help="increase output verbosity")

args = parser.parse_args()

answer = args.square**2

if args.verbosity == 2:

print("the square of{}equals{}".format(args.square, answer))

elif args.verbosity == 1:

print("{}^2 =={}".format(args.square, answer))

else:

print(answer)

Et le résultat :

$ python3 prog.py 4

16

$ python3 prog.py 4 -v

usage: prog.py [-h] [-v VERBOSITY] square

prog.py: error: argument -v/--verbosity: expected one argument

$ python3 prog.py 4 -v 1

4^2 == 16

$ python3 prog.py 4 -v 2

the square of 4 equals 16

$ python3 prog.py 4 -v 3

16

Tout semble bon sauf le dernier, qui montre que notre programme contient un bogue. Corrigeons cela en restreignant les valeurs que --verbosity accepte :

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("square", type=int,

help="display a square of a given number")

parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],

help="increase output verbosity")

args = parser.parse_args()

answer = args.square**2

if args.verbosity == 2:

print("the square of{}equals{}".format(args.square, answer))

elif args.verbosity == 1:

print("{}^2 =={}".format(args.square, answer))

else:

print(answer)

Et le résultat :

$ python3 prog.py 4 -v 3

usage: prog.py [-h] [-v {0,1,2}] square

prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)

$ python3 prog.py 4 -h

usage: prog.py [-h] [-v {0,1,2}] square

positional arguments:

square display a square of a given number

optional arguments:

-h, --help show this help message and exit

-v {0,1,2}, --verbosity {0,1,2}

increase output verbosity

Notez que ce changement est pris en compte à la fois dans le message d’erreur et dans le texte d’aide.

Essayons maintenant une approche différente pour jouer sur la verbosité, ce qui arrive fréquemment. Cela correspond également à comment le programme CPython gère ses propres paramètres de verbosité (jetez un œil sur la sortie de la commande python --help) :

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("square", type=int,

help="display the square of a given number")

parser.add_argument("-v", "--verbosity", action="count",

help="increase output verbosity")

args = parser.parse_args()

answer = args.square**2

if args.verbosity == 2:

print("the square of{}equals{}".format(args.square, answer))

elif args.verbosity == 1:

print("{}^2 =={}".format(args.square, answer))

else:

print(answer)

Nous avons introduit une autre action, "count", pour compter le nombre d’occurrences d’une argument optionnel en particulier :

$ python3 prog.py 4

16

$ python3 prog.py 4 -v

4^2 == 16

$ python3 prog.py 4 -vv

the square of 4 equals 16

$ python3 prog.py 4 --verbosity --verbosity

the square of 4 equals 16

$ python3 prog.py 4 -v 1

usage: prog.py [-h] [-v] square

prog.py: error: unrecognized arguments: 1

$ python3 prog.py 4 -h

usage: prog.py [-h] [-v] square

positional arguments:

square display a square of a given number

optional arguments:

-h, --help show this help message and exit

-v, --verbosity increase output verbosity

$ python3 prog.py 4 -vvv

16

Oui, c’est maintenant d’avantage une option (similaire à action="store_true") de la version précédente de notre script. Cela devrait expliquer le message d’erreur.

Cela se comporte de la même manière que l’action "store_true".

Maintenant voici une démonstration de ce que l’action "count" fait. Vous avez sûrement vu ce genre d’utilisation auparavant.

Et si vous ne spécifiez pas l’option -v, cette option prendra la valeur None.

Comme on s’y attend, en spécifiant l’option dans sa forme longue, on devrait obtenir la même sortie.

Malheureusement, notre sortie d’aide n’est pas très informative à propos des nouvelles possibilités de notre programme, mais cela peut toujours être corrigé en améliorant sa documentation (en utilisant l’argument help).

La dernière sortie du programme montre que celui-ci contient un bogue.

Corrigeons :

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("square", type=int,

help="display a square of a given number")

parser.add_argument("-v", "--verbosity", action="count",

help="increase output verbosity")

args = parser.parse_args()

answer = args.square**2

# bugfix: replace == with >=

if args.verbosity >= 2:

print("the square of{}equals{}".format(args.square, answer))

elif args.verbosity >= 1:

print("{}^2 =={}".format(args.square, answer))

else:

print(answer)

Et c’est ce que ça donne :

$ python3 prog.py 4 -vvv

the square of 4 equals 16

$ python3 prog.py 4 -vvvv

the square of 4 equals 16

$ python3 prog.py 4

Traceback (most recent call last):

File "prog.py", line 11, in

if args.verbosity >= 2:

TypeError: '>=' not supported between instances of 'NoneType' and 'int'

Les premières exécutions du programme sont correctes, et le bogue que nous avons eu est corrigé. Cela dit, nous voulons que n’importe quelle valeur >= 2 rende le programme aussi verbeux que possible.

La troisième sortie de programme n’est pas si bien que ça.

Corrigeons ce bogue :

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("square", type=int,

help="display a square of a given number")

parser.add_argument("-v", "--verbosity", action="count", default=0,

help="increase output verbosity")

args = parser.parse_args()

answer = args.square**2

if args.verbosity >= 2:

print("the square of{}equals{}".format(args.square, answer))

elif args.verbosity >= 1:

print("{}^2 =={}".format(args.square, answer))

else:

print(answer)

Nous venons juste d’introduire un nouveau mot clef, default. Nous l’avons définit à 0 pour le rendre comparable aux autres valeurs. Rappelez-vous que par défaut, si un argument optionnel n’est pas spécifié, il sera définit à None, et ne pourra pas être comparé à une valeur de type entier (une erreur TypeError serait alors levée).

Et :

$ python3 prog.py 4

16

Vous pouvez aller assez loin seulement avec ce que nous avons appris jusqu’à maintenant, et nous n’avons qu’aperçu la surface. Le module argparse est très puissant, et nous allons l’explorer un peu plus avant la fin de ce tutoriel.