zpp_args 1.2.0

Module pour le traitement des arguments d'une ligne de commande

zpp-args

Informations

Module pour le traitement des arguments d'une ligne de commande.
Trois sources possibles:

• sys.argv
• une chaîne de caractère
• une liste

Prérequis

• Python 3

Installation

pip install zpp_args

Utilisation

Conseil d'importation du module

from zpp_args import parser

Initialisation du parser

parse = parser(SOURCE, error_lock=False)

En paramètre supplémentaire, nous pouvons mettre:

• error_lock: Purge le retour de la fonction si une erreur s'est produite (Par défaut: False)

Initialisation des arguments

parse.set_argument(NAME)

L'initialisation doit prendre au moins un des deux paramètres suivants:

• shortcut: Pour les arguments courts (1 caractère)
• longname: Pour les arguments explicites (1 mot ou ensemble de mots séparés par le symbole _)

Si non précisé, la fonction initialise shortcut

En paramètre supplémentaire, nous pouvons mettre:

• error_lock: Purge le retour de la fonction si une erreur s'est produite (Par défaut: )
• type: Pour forcer l'argument reçu à un str ou un digit (Par défaut: None)
• default: Pour choisir une valeur par défaut(Par défaut: None)
• description: Pour ajouter une description à l'argument à afficher lors de l'appel de la commande help(Par défaut: None)
• required: Choisir si cet argument est nécessaire (Par défaut: False)
• store: Choisir si l'argument' est un simple True/False ou s'il attends une variable (Par défaut: bool)

Initialisation des paramètres

L'initialisation des paramètres va permettre d'agrémenter la commande help et de fixer une limite minimum lors de la récupération des paramètres

parse.set_argument(NAME)

En paramètre supplémentaire, nous pouvons mettre:

• description: Pour ajouter une description au paramètre à afficher lors de l'appel de la commande help(Par défaut: None)

Execution du parseur

argument, parameter = parse.load()

Retourne une liste avec les paramètres et une classe (StoreArgument) avec les arguments La StoreArgument peut retourner un dictionnaire en appelant argument.list_all()

Initialisation de la description de la commande

parse.set_description(DESCRIPTION)

Affichage de l'aide

parse.help()

Désactiver le check sur les paramètres

Pour désactiver le check du nombre de paramètres à envoyer, il suffit d'appeler la fonction suivante.

parse.disable_check()