Comment analyser les arguments sur la ligne de commande en Python

How Parse Arguments Command Line Python



Les arguments de ligne de commande sont utilisés pour transmettre des données dans le programme au moment de l'exécution du programme. Cette fonctionnalité est disponible sur la plupart des langages de programmation populaires. Mais le traitement des arguments de ligne de commande est différent pour différentes langues. Les valeurs des arguments sont données avec le nom du programme au moment de l'exécution du programme. Le langage Python prend en charge cette fonctionnalité. La façon dont les arguments de ligne de commande sont analysés dans le script Python est illustrée dans cet article.

Analyser l'argument de la ligne de commande à l'aide système module

Les arguments de la ligne de commande sont stockés dans une liste en utilisant système module. sys.argv est utilisé pour lire les valeurs des arguments de la ligne de commande. Le nombre total d'arguments de ligne de commande peut être compté en utilisant len () fonction. L'utilisation de ce module est décrite dans la partie de l'article.







Exemple 1 : Lecture du nombre d'arguments et de valeurs d'arguments

Créez un fichier avec le script python suivant. Ici, les valeurs des arguments de la ligne de commande sont stockées dans la variable, argv comme les autres langues. len () La méthode compte le nombre total d'arguments passés au moment de l'exécution du script. Les valeurs des arguments sont imprimées sous forme de tableau à la fin du script.



# Importer le module sys
importer système

# Affiche le nombre total d'arguments
imprimer('Total des arguments :', longueur(système.argv))
imprimer(« Les valeurs des arguments sont : », p(système.argv))

Sortir:



Le script ci-dessus est exécuté ici à l'aide de quatre arguments de ligne de commande. Le premier argument est le nom du script et les autres sont des valeurs numériques. La sortie suivante apparaîtra après l'exécution du script.





Exemple 2 : Lecture des valeurs d'argument à l'aide de la boucle



Dans l'exemple précédent, les valeurs des arguments sont affichées sous forme de tableau. Créez un fichier avec le script suivant pour imprimer le type de variable d'argument et imprimez chaque valeur d'argument dans chaque ligne en utilisant la boucle for.

# Importer le module sys
importer système

# Affiche le type de la variable, sys.argv
imprimer(taper(système.argv))

# Affiche chaque argument de ligne de commande dans chaque ligne
imprimer(« Les arguments de la ligne de commande sont : »)
pourjedans système.argv:
imprimer(je)

Sortir:

Le script ci-dessus est exécuté en fournissant trois arguments avec le nom du script. La sortie suivante apparaîtra après l'exécution du script.

Analyser l'argument de ligne de commande à l'aide du module getopt

surmonté module est utilisé pour analyser les arguments de la ligne de commande avec les options. surmonté () La méthode de ce module est utilisée pour lire les arguments. Cette méthode a trois arguments. Les deux premiers arguments sont obligatoires et le dernier argument est facultatif. Les utilisations de ces arguments sont données ci-dessous.

arguments : Il contient l'argument extrait de l'argument de la ligne de commande.

option_courte : Il peut s'agir de n'importe quelle lettre qui passe avec l'argument.

option_longue : Il permet de définir des options longues en deux parties. Il s'agit du nom et de la valeur de l'option.

Syntaxe: getopt.getopt(args, short_option, [long_option])

Exemple 3 : lecture des valeurs d'argument à l'aide d'options getopt courtes

surmonté module contient plus de fonctionnalités que système module. L'exemple suivant montre comment les options courtes peuvent être utilisées dans surmonté () méthode. argv La variable stockera les arguments de la ligne de commande en omettant le nom du script. Ensuite, deux options sont définies dans le surmonté () méthode qui peut être utilisée avec l'argument au moment de l'exécution. Si une erreur se produit, un message d'erreur s'affichera.

# Importer le module getopt
importer surmonté

# Importer le module sys
importer système

# Stocker la variable d'argument en omettant le nom du script
argv= système.argv[1:]

essayer:
# Définir les options courtes getopt
options,arguments= surmonté.surmonté(argv, « x : y : »)

# affiche les options et l'argument
imprimer(options)
imprimer(arguments)

sauf surmonté.GetoptError:

# Imprimer le message d'erreur si la mauvaise option est fournie
imprimer(« La mauvaise option est fournie »)

# Terminer le script
système.sortir(2)

Sortir:

Exécutez le script sans aucun argument, les arguments avec les bonnes options et les arguments avec la mauvaise option.

Exemple 4 : lecture des valeurs d'argument à l'aide des options getopt courtes et longues

Cet exemple montre comment les options courtes et longues peuvent être utilisées avec les valeurs d'argument. Il ajoutera deux nombres lorsque '-à' ou '-ajouter' sera utilisé comme option et soustraira deux nombres lorsque ‘ -s' ou ' -sous' sera utilisé comme option au moment de l'exécution.

# Importer le module getopt
importer surmonté

# Importer le module sys
importer système

# Stocker la variable d'argument en omettant le nom du script
argv= système.argv[1:]

# Initialiser la variable de résultat
résultat=0

essayer:

# Définir les options courtes et longues getopt
options,arguments= surmonté.surmonté(système.argv[1:], 'comme', ['ajouter=','sous='])

# Lisez chaque option en utilisant la boucle for
pouropter,en colèredansoption :
# Calculer la somme si l'option est -a ou --add
siopterdans ('-à', '--ajouter'):
résultat= entier(argv[1])+entier(argv[2])

# Calculer la traction solaire si l'option est -s ou --sub
elifopterdans ('-s', '--sous'):
résultat= entier(argv[1])-entier(argv[2])

imprimer('Résultat = ',résultat)

sauf surmonté.GetoptError:

# Imprimer le message d'erreur si la mauvaise option est fournie
imprimer(« La mauvaise option est fournie »)

# Terminer le script
système.sortir(2)

Sortir:

Exécutez le script sans aucun argument ni option, les arguments avec l'option '-a', les arguments avec l'option '-s' et les arguments avec la mauvaise option.

Analyser l'argument de la ligne de commande à l'aide du module argparse

Le module Argparse contient de nombreuses options pour lire les arguments de ligne de commande. Les valeurs d'argument par défaut, l'argument avec le type de données, les arguments positionnels, le message d'aide, etc. peuvent être fournis par ce module.

Exemple 5 : lecture d'arguments de ligne de commande à l'aide de argparse

L'exemple suivant montre l'utilisation de argparse module pour lire l'argument de la ligne de commande. Ici, deux options sont définies pour la lecture des arguments de ligne de commande. Ceux-ci sont '-n' ou '-nom' et « -e » ou « –e-mail ». Si l'utilisateur fournit un mauvais argument, il affichera une erreur avec un message d'utilisation. Si l'utilisateur fournit des options correctes avec les arguments, il affichera les valeurs des arguments. si l'utilisateur exécute le script avec l'option '–help', il fournira le message nécessaire pour exécuter le script.

# Importer le module argparse
importerargparse

# Importer le module sys
importer système

# Déclarer la fonction pour définir les arguments de la ligne de commande
déflireOptions(arguments=système.argv[1:]):
analyseur =argparse.ArgumentParser(la description='Les listes de commandes d'analyse.')
analyseur.add_argument('-n', '--Nom', aider='Tapez votre nom.')
analyseur.add_argument('-Et', '--e-mail', aider=« Tapez votre e-mail. »)
opte= analyseur.parse_args(arguments)
reveniropte

# Appeler la fonction pour lire les valeurs des arguments
options=lireOptions(système.argv[1:])
imprimer(option.Nom)
imprimer(option.e-mail)

Sortir:

Exécutez le script avec la mauvaise option, l'option correcte et l'option d'aide.

Conclusion:

Différentes manières de lire les arguments de ligne de commande sont expliquées dans ce didacticiel à l'aide de trois modules python. J'espère que ce tutoriel aidera le codeur qui souhaite lire des données à l'aide d'arguments de ligne de commande en python.

Regardez la vidéo de l'auteur : ici