Exemples Python Argparse
Interface de ligne de commande
Une méthode pour négocier avec un script de ligne de commande serait via l'interface de ligne de commande ou CLI. Bien que Python ait plusieurs modules que nous pouvons utiliser pour construire des interfaces de ligne de commande pour différents scripts, le package Python Argparse est désormais la méthode efficace pour le faire.
Le module Argparse pour Python a été mis à disposition en tant que composant du cadre standard. C'est la méthode préférée pour créer une interface Python. Les bibliothèques «Getopt» et «Optparse» précédentes ont été remplacées par celle-ci car elles manquaient plusieurs fonctionnalités cruciales.
Utilisations du module Argparse
Ce sont les utilisations du module Python Argparse:
-
- Fournit différentes unités d'arguments pour un seul élément.
- Prend en charge l'utilisation des paramètres de position.
- Autoriser l'intermédiaire pour les sous-communs.
- Activer la modification des éléments du préfixe.
Sur la base de certains paramètres, un analyseur de ligne de commande principal peut utiliser des analyseurs de ligne de commande supplémentaires.
Utilisation d'une interface de ligne de commande
Maintenant que nous sommes conscients de ce qu'est une interface de ligne de commande, nous pourrions nous inquiéter de savoir quand il serait approprié de l'intégrer dans le programme. La règle générale est que nous penserons à une interface de ligne de commande si nous décidons d'offrir une méthode conviviale pour personnaliser le projet.
La technique appropriée consiste à utiliser le module Python Argparse. C'est un excellent moyen de gérer la valeur en construisant une interface de ligne de commande à l'aide du module Python Argparse à moins que nous ne construisons un script de ligne de commande compliqué qui nécessite un fichier de configuration pour fonctionner. De cette façon peut permettre à l'utilisateur de désigner dont le fichier de configuration utilise.
Comment construire une interface de ligne de commande à l'aide du package Python Argparse
Il y a 4 phases à utiliser le module Python Argparse:
-
- Incluez le framework Argparse dans Python.
- Construire l'analyseur.
- Fournir à l'analyseur des paramètres facultatifs et positionnels.
- Exécutez la fonction PARSE_ARGS ().
Un objet défini par l'utilisateur avec un attribut de base pour chaque paramètre d'entrée obtenu à partir de la ligne de commande est ce que nous pouvons obtenir après avoir appelé la méthode PARSE_ARGS ().
Exécutons différents exemples dans lesquels nous utilisons le module Argparse.
Exemple n ° 1
Une interface efficace pour le traitement des paramètres de ligne de commande est fournie par l'outil Argparse. Il montre l'utilisation générale du programme, les instructions et les exceptions du programme. L'utilisation de paramètres de ligne de commande appropriés est démontrée dans l'illustration suivante.
Cet exemple calcule la zone du cercle à l'aide d'un rayon d'un paramètre de la ligne de commande. Pour ajouter des paramètres et les analyser, l'analyseur d'objet ArgumentParser a été construit. Un paramètre RADIUS est ajouté par l'utilisateur, bien qu'il soit laissé comme un paramètre facultatif. La méthode ne renvoie pas d'exception et définirait la valeur du paramètre sur aucune si l'utilisateur ne donne pas de valeur pour cela, comme le montre le scénario ci-dessous.
Importer Argparse
Parser = Argparse.ArgumentPaSer (Description = 'Trouver le rayon d'un cercle donné')
analyseur.add_argument ('- r', '- radius', type = int, help = 'radius calculé de tout cercle donné')
args = analyseur.parse_args ()
def main ():
imprimer (args.rayon)
principal()
Au début du programme, nous importerons le fichier d'en-tête «Argparse». Dans l'étape suivante, nous initialiserons une variable «analyser», et en même temps, nous appellerons la méthode ArgumentPraser (). Cette fonction est liée au module ArgParse. Nous avons donné la «description» comme paramètre de la fonction argumentpraser (). Ensuite, nous ajoutons différents paramètres, nous utilisons donc la fonction add_argument (). Cette fonction a trois paramètres qui incluent le rayon du cercle, le type de données du rayon et la valeur de l'argument «d'aide».
Après avoir précisé les arguments, nous invoquerons la fonction parse_args () du package d'analyse. Maintenant, définissons le corps de la méthode principale (). Dans cette fonction, nous avons utilisé la fonction print () pour afficher le rayon du cercle donné. En fin de compte, nous utilisons la méthode principale ().
Exemple n ° 2
Le «requis» est un argument de la méthode add_argument () de l'objet argumentaire. Les paramètres de l'attribut «F» ou «FOO» ne sont pas nécessaires et, par conséquent, seront éliminés par défaut. Le paramètre «requis» peut être défini sur true si l'utilisateur souhaite insérer ce paramètre. Comme indiqué ci-dessous, chaque fois que nous définissons un attribut comme «requis» mais ne spécifiez pas de valeur pour cela, le compilateur renvoie une exception.
Importer Argparse
Parser = Argparse.ArgumentPaSer (Description = 'déterminer le rayon de tout cercle', prog = 'le programme', usage = '% (prog) s [options]')
analyseur.add_argument ('- r', '- radius', type = int, requis = true, help = 'rayon calculé de tout cercle donné')
args = analyseur.parse_args ()
def main ():
imprimer (args.rayon)
principal()
Tout d'abord, nous allons intégrer le module «Argparse». L'étape suivante consiste à initialiser la variable «analyseur» et à appliquer simultanément la méthode argumentPaSer (). Cette méthode est associée au package Argparse. Les arguments pour la méthode ArgumentParser () sont des description et progres.
Ensuite, nous ajoutons quelques paramètres supplémentaires en utilisant la méthode add_argument (). Le rayon du cercle, le type de données du rayon et la valeur du paramètre «Help» sont les quatre arguments pour cette fonction. Nous définissons la valeur du paramètre «requis» sur «vrai».
En plus de cela, nous appellerons la méthode parse_args () du fichier d'en-tête d'analyseur après avoir fourni les arguments. Ensuite, nous définirons le corps de la fonction principale (). La méthode print () a été utilisée ici dans le corps de la fonction principale pour montrer le rayon du cercle. Nous utilisons enfin la fonction principale ().
Conclusion
En terminant cet article, nous comprenons maintenant une interface de ligne de commande et la méthode de construction d'un seul argument de ligne de commande à l'aide du package Argparse. Nous avons également discuté de ce qu'est le module Python Argparse et pourquoi les utilisateurs l'utiliseront s'ils doivent générer du code Python de ligne de commande. Comment et quand créer efficacement une interface de base à l'aide du framework Argparse. Nous avons également observé l'utilisation innovante du module Argparse. Une interface de ligne de commande efficace peut fournir aux utilisateurs un mécanisme pour s'engager avec leur système.