Introduction détaillée à l'outil d'analyse de ligne de commande Python Argparse

Récemment, j'étudie l'outil d'analyse de ligne de commande de Pathon, argparse, qui est un outil recommandé dans la bibliothèque standard Python pour écrire des programmes en ligne de commande.

J'avais l'habitude de faire des programmes d'interface utilisateur tout le temps. Aujourd'hui, j'ai essayé le programme en ligne de commande. Cela me fait du bien de ne pas passer beaucoup de temps à étudier les problèmes d'interface, surtout en vc, ce qui est le cas. particulièrement encombrant.

Maintenant, Python est utilisé pour implémenter la ligne de commande. Le module informatique de base peut être écrit en C seul en tant que bibliothèque d'extension, et l'effet est plutôt bon.

J'ai appris argparse, trouvé un article toturial dans la documentation officielle et l'ai brièvement traduit.

http://docs.python.org/2/howto/argparse.html#id1

Tutoriel Argparse
Ce tutoriel présente brièvement les commandes recommandées par le paramètre Row de la bibliothèque standard Python module d'analyse - utilisation d'Argparse.

1. Concepts de base

Dans ce tutoriel, nous utilisons une commande ls courante pour démontrer la fonction d'argparse.

$ ls
cpython devguide prog.py pypy rm-unused-function.patch
$ ls pypy
ctypes_configure demo dotviewer include lib_pypy lib-python ...
$ ls -l
total 20
drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython
drwxr-xr-x 4 wena wena 4096 Feb 8 12:04 devguide
-rwxr-xr-x 1 wena wena 535 Feb 19 00:05 prog.py
drwxr-xr-x 14 wena wena 4096 Feb 7 00:59 pypy
-rw-r--r-- 1 wena wena 741 Feb 18 01:01 rm-unused-function.patch
$ ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.

À partir des quatre commandes ci-dessus, nous pouvons comprendre les concepts de base suivants :

1), la commande ls dans Il peut également être exécuté sans paramètres. Par défaut, tout le contenu du répertoire courant sera imprimé.
2) Si nous voulons qu'il affiche plus de contenu, alors nous devons lui donner plus de paramètres. Dans ce cas, nous souhaitons afficher un répertoire différent, pypy. Ce que nous avons fait, c'est spécifier l'argument de position commun, nommé ainsi parce que le programme doit décider quoi faire en fonction de la position de l'argument dans la ligne de commande. Ce concept est plus proche de la commande cp. Son utilisation est cp src dest représente le fichier que vous souhaitez copier, et dest représente l'endroit où vous souhaitez copier le fichier.
3) Maintenant, je souhaite changer le comportement du programme. Dans notre exemple, je souhaite afficher les informations vers l'ouest du fichier au lieu du simple nom du fichier. Le paramètre -l est l'argument facultatif que nous connaissons (argument optionnel)
4), et la dernière phrase sert à afficher l'aide. document Un extrait que vous pouvez utiliser pour apprendre à utiliser une commande que vous n'avez jamais utilisée auparavant.

2. Compréhension de base

On commence avec un programme de base (ça ne fait rien)

import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

Résultats d'exécution :

$ python prog.py
$ python prog.py --help
usage: prog.py [-h]

optional arguments:
 -h, --help show this help message and exit
$ python prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo

Analyse des résultats :

1) Si vous exécutez ce programme sans donner de paramètres, il n'y aura aucun résultat être obtenu.
2) Le deuxième nom montre les avantages de l'utilisation d'argparse. Vous n'avez rien fait mais vous avez reçu un bon message d'aide.
3) Nous pouvons obtenir un bon message d'aide sans définir manuellement le paramètre --help. Mais si d'autres paramètres (comme foo) sont donnés, une erreur sera générée.

3. Paramètres de position

Tout d'abord, donnez un exemple :

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print args.echo

Résultat d'exécution :

$ python prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo
$ python prog.py --help
usage: prog.py [-h] echo

positional arguments:
 echo

optional arguments:
 -h, --help show this help message and exit
$ python prog.py foo
foo

Analyse des résultats :

Cette fois, nous avons ajouté une méthode add_argument() pour définir la ligne de commande acceptable pour le paramètre du programme.
Maintenant, pour exécuter le programme, vous devez définir un paramètre. La méthode
parse_args() renvoie en fait certaines données de nos arguments de ligne de commande, dans l'exemple ci-dessus, il s'agit de echo
Ce processus de type "magique" est automatiquement complété par argparse.
Bien que les informations d'aide générées automatiquement soient magnifiquement affichées, nous ne pouvons toujours pas savoir ce qu'elles font en nous basant uniquement sur le paramètre echo. Nous avons donc ajouté quelques éléments pour le rendre plus utile.

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here")
args = parser.parse_args()
print args.echo

Résultats opérationnels :

$ python prog.py -h
usage: prog.py [-h] echo

positional arguments:
 echo    echo the string you use here

optional arguments:
 -h, --help show this help message and exit

Sur cette base, changez un peu plus : (calculez le carré du carré du paramètre d'entrée)

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number")
args = parser.parse_args()
print args.square**2

Voici le résultat courant :

$ python prog.py 4
Traceback (most recent call last):
 File "prog.py", line 5, in <module>
  print args.square**2
TypeError: unsupported operand type(s) for ** or pow(): &#39;str&#39; and &#39;int&#39;

Ce programme ne fonctionne pas correctement car argparse traite l'entrée comme une chaîne, nous devons donc définir son type : (type=int)

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number",
          type=int)
args = parser.parse_args()
print args.square**2

Voici les résultats :

$ python prog.py 4
16
$ python prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'

Maintenant, ce programme peut fonctionner sans problème et gérer Quelques fautes de frappe.

Ce qui précède est un tutoriel simple sur la façon d'utiliser l'outil d'analyse de ligne de commande Python Argparse. J'espère qu'il sera utile à tout le monde.

Pour une introduction plus détaillée à l'outil d'analyse de ligne de commande Python Argparse et aux articles connexes, veuillez prêter attention au site Web PHP chinois !