# zpp-args
## Informations
Module pour le traitement des arguments d'une ligne de commande.
<br>Trois sources possibles:
- sys.argv
- une chaîne de caractère
- une liste
### Prérequis
- Python 3
<br>
# Installation
```console
pip install zpp_args
```
# Utilisation
### Conseil d'importation du module
```python
from zpp_args import parser
```
<br>
### Initialisation du parser
```python
parse = parser(SOURCE, error_lock=False)
```
>En paramètre supplémentaire, nous pouvons mettre:<br/>
>- error_lock: Purge le retour de la fonction si une erreur s'est produite (Par défaut: False)
<br>
### Initialisation des arguments
```python
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:<br/>
>- 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
<br>
### 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
```python
parse.set_argument(NAME)
```
>En paramètre supplémentaire, nous pouvons mettre:<br/>
>- description: Pour ajouter une description au paramètre à afficher lors de l'appel de la commande help(Par défaut: None)
<br>
### Execution du parseur
```python
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()
<br>
### Initialisation de la description de la commande
```python
parse.set_description(DESCRIPTION)
```
<br>
### Affichage de l'aide
```python
parse.help()
```
<br>
### 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.
```python
parse.disable_check()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ZephyrOff/py-zpp_args",
"name": "zpp-args",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "terminal args zephyroff",
"author": "ZephyrOff",
"author_email": "contact@apajak.fr",
"download_url": "https://files.pythonhosted.org/packages/6b/4d/1be4e8def1fcfad916048cd883194c2a1d4d5164cd360c5a4196fae7082c/zpp_args-1.3.1.tar.gz",
"platform": "ALL",
"description": "# zpp-args\r\n## Informations\r\nModule pour le traitement des arguments d'une ligne de commande.\r\n<br>Trois sources possibles:\r\n- sys.argv\r\n- une cha\u00c3\u00aene de caract\u00c3\u00a8re\r\n- une liste\r\n\r\n### Pr\u00c3\u00a9requis\r\n- Python 3\r\n<br>\r\n\r\n# Installation\r\n```console\r\npip install zpp_args\r\n```\r\n\r\n# Utilisation\r\n### Conseil d'importation du module\r\n```python\r\nfrom zpp_args import parser\r\n```\r\n<br>\r\n\r\n### Initialisation du parser\r\n```python\r\nparse = parser(SOURCE, error_lock=False)\r\n```\r\n>En param\u00c3\u00a8tre suppl\u00c3\u00a9mentaire, nous pouvons mettre:<br/>\r\n>- error_lock: Purge le retour de la fonction si une erreur s'est produite (Par d\u00c3\u00a9faut: False)\r\n<br>\r\n\r\n### Initialisation des arguments\r\n```python\r\nparse.set_argument(NAME)\r\n```\r\nL'initialisation doit prendre au moins un des deux param\u00c3\u00a8tres suivants:\r\n- shortcut: Pour les arguments courts (1 caract\u00c3\u00a8re)\r\n- longname: Pour les arguments explicites (1 mot ou ensemble de mots s\u00c3\u00a9par\u00c3\u00a9s par le symbole \\_)\r\n\r\n_Si non pr\u00c3\u00a9cis\u00c3\u00a9, la fonction initialise shortcut_\r\n\r\n>En param\u00c3\u00a8tre suppl\u00c3\u00a9mentaire, nous pouvons mettre:<br/>\r\n>- error_lock: Purge le retour de la fonction si une erreur s'est produite (Par d\u00c3\u00a9faut: )\r\n>- type: Pour forcer l'argument re\u00c3\u00a7u \u00c3\u00a0 un str ou un digit (Par d\u00c3\u00a9faut: None)\r\n>- default: Pour choisir une valeur par d\u00c3\u00a9faut(Par d\u00c3\u00a9faut: None)\r\n>- description: Pour ajouter une description \u00c3\u00a0 l'argument \u00c3\u00a0 afficher lors de l'appel de la commande help(Par d\u00c3\u00a9faut: None)\r\n>- required: Choisir si cet argument est n\u00c3\u00a9cessaire (Par d\u00c3\u00a9faut: False)\r\n>- store: Choisir si l'argument' est un simple True/False ou s'il attends une variable (Par d\u00c3\u00a9faut: bool)\r\n>- category: Choisir une cat\u00c3\u00a9gorie pour l'affichage du help\r\n<br>\r\n\r\n### Initialisation des param\u00c3\u00a8tres\r\nL'initialisation des param\u00c3\u00a8tres va permettre d'agr\u00c3\u00a9menter la commande help et de fixer une limite minimum lors de la r\u00c3\u00a9cup\u00c3\u00a9ration des param\u00c3\u00a8tres\r\n```python\r\nparse.set_argument(NAME)\r\n```\r\n>En param\u00c3\u00a8tre suppl\u00c3\u00a9mentaire, nous pouvons mettre:<br/>\r\n>- description: Pour ajouter une description au param\u00c3\u00a8tre \u00c3\u00a0 afficher lors de l'appel de la commande help(Par d\u00c3\u00a9faut: None)\r\n<br>\r\n\r\n### Execution du parseur\r\n```python\r\nargument, parameter = parse.load()\r\n```\r\nRetourne une liste avec les param\u00c3\u00a8tres et une classe (StoreArgument) avec les arguments\r\nLa StoreArgument peut retourner un dictionnaire en appelant argument.list_all()\r\n\r\n<br>\r\n\r\n### Initialisation de la description de la commande\r\n```python\r\nparse.set_description(DESCRIPTION)\r\n```\r\n<br>\r\n\r\n### Affichage de l'aide\r\n```python\r\nparse.help()\r\n```\r\n<br>\r\n\r\n### D\u00c3\u00a9sactiver le check sur les param\u00c3\u00a8tres\r\nPour d\u00c3\u00a9sactiver le check du nombre de param\u00c3\u00a8tres \u00c3\u00a0 envoyer, il suffit d'appeler la fonction suivante.\r\n```python\r\nparse.disable_check()\r\n```\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Module pour le traitement des arguments d'une ligne de commande",
"version": "1.3.1",
"split_keywords": [
"terminal",
"args",
"zephyroff"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "10b0c56e4b2b57aecca4de131a030925",
"sha256": "04c3a15b91e041b8fc3ecb26679d51cb1db574d594625cb01ed95aff1502ecd0"
},
"downloads": -1,
"filename": "zpp_args-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "10b0c56e4b2b57aecca4de131a030925",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5684,
"upload_time": "2022-12-26T19:06:53",
"upload_time_iso_8601": "2022-12-26T19:06:53.952739Z",
"url": "https://files.pythonhosted.org/packages/05/c5/ce11a40b91fe8631394b55629ace3d7c4dc8729557bfa46062f87ee3b75b/zpp_args-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "8ae423e61b94d5ccb3f10792af87e0a1",
"sha256": "0b91d02627ca28179316a17f98bd767027947b567a564dcfc517e1f196a86c83"
},
"downloads": -1,
"filename": "zpp_args-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "8ae423e61b94d5ccb3f10792af87e0a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5828,
"upload_time": "2022-12-26T19:06:55",
"upload_time_iso_8601": "2022-12-26T19:06:55.589956Z",
"url": "https://files.pythonhosted.org/packages/6b/4d/1be4e8def1fcfad916048cd883194c2a1d4d5164cd360c5a4196fae7082c/zpp_args-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-26 19:06:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ZephyrOff",
"github_project": "py-zpp_args",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "zpp-args"
}
JSON
