Skip to main content

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

Project description

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)
  • category: Choisir une catégorie pour l'affichage du help

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()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zpp_args-1.3.3.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

zpp_args-1.3.3-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file zpp_args-1.3.3.tar.gz.

File metadata

  • Download URL: zpp_args-1.3.3.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: nexus/0.5.0 CPython/3.10.11 Windows/10

File hashes

Hashes for zpp_args-1.3.3.tar.gz
Algorithm Hash digest
SHA256 0dfb75f84a77b257c83c55d182cdf567bdccc186e87eb488106d10397fb3c377
MD5 977e70995f545dab063039268e11acfe
BLAKE2b-256 864bdfe1d60eb3b5a4832a1cbfde7c13be52315f675028411e600b1a0832613a

See more details on using hashes here.

File details

Details for the file zpp_args-1.3.3-py3-none-any.whl.

File metadata

  • Download URL: zpp_args-1.3.3-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: nexus/0.5.0 CPython/3.10.11 Windows/10

File hashes

Hashes for zpp_args-1.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 494e9417229ed36d8411975de7ea15a228eef857ef737541f703323595d0ee02
MD5 3d3cd8adf0442e55b456eec8fe528c17
BLAKE2b-256 e0abf16ad5203bfffa2aeed4163022a45d56b0de36bfc9d1b3be493d374a45f7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page