Create argparser automatically from functions
Project description
Overview
A wrapper around argparser to help build CLIs from functions. Uses type-hints extensively :snake:.
Setup
:gear: Installation
Install it directly into an activated virtual environment:
$ pip install arger
:books: Usage
- create a python file called test.py
from arger import Arger
def main(param1: int, param2: str, kw1=None, kw2=False):
"""Example function with types documented in the docstring.
Args:
param1: The first parameter.
param2: The second parameter.
kw1: this is optional parameter.
kw2: this is boolean. setting flag sets True.
"""
print(locals())
arger = Arger(
main,
prog="pytest", # for testing purpose. otherwise not required
)
if __name__ == "__main__":
arger.run()
-
Here Arger is just a subclass of
ArgumentParser. It will not conceal you from using otherargparselibraries. -
run this normally with
$ python test.py -h
usage: pytest [-h] [-k KW1] [-w] param1 param2
Example function with types documented in the docstring.
positional arguments:
param1 The first parameter.
param2 The second parameter.
optional arguments:
-h, --help show this help message and exit
-k KW1, --kw1 KW1 this is optional parameter. (default: None)
-w, --kw2 this is boolean. setting flag sets True. (default: False)
$ python test.py 100 param2
{'param1': 100, 'param2': 'param2', 'kw1': None, 'kw2': False}
- Checkout examples folder and documentation to see more of
argerin action. It supports any level of sub-commands.
Features
-
Uses docstring to parse help comment for arguments. Supports
-
Flags will be generated from parameter-name.
- e.g.
def main(param: ...)->-p, --param - If needed you could declare it inside docstring like
:param arg1: -a --arg this is the document.
- e.g.
-
one can use
Argumentclass to pass any values to the parser.add_argument function -
The decorated functions can be composed to form nested sub-commands of any level.
-
Most of the Standard types supported. Please see examples for more supported types with examples.
NOTE
*argssupported but no**kwargssupport yet.- all optional arguments that start with underscore is not passed to
Parser. They are considered private to the function implementation. Some parameter names with special meaning
_namespace_-> to get the output from theArgumentParser.parse_args()_arger_-> to get the parser instance
Argparser enhancements
- web-ui : https://github.com/nirizr/argparseweb
- extra actions : https://github.com/kadimisetty/action-hero
- automatic shell completions using argcomplete
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file arger-1.4.4.tar.gz.
File metadata
- Download URL: arger-1.4.4.tar.gz
- Upload date:
- Size: 12.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.8.13 Linux/5.13.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1fd38c6b9d0dfd6d85fa2a257dffef3aec7298690b5dd7edcea551959b1656d0 |
|
| MD5 | f6b7a5c9d395662eda7f278f122b54b9 |
|
| BLAKE2b-256 | eeef49ee4f1722117cdbeaa30104b3220630101319c3a8ea8f72675130c36e6e |
File details
Details for the file arger-1.4.4-py3-none-any.whl.
File metadata
- Download URL: arger-1.4.4-py3-none-any.whl
- Upload date:
- Size: 12.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.8.13 Linux/5.13.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ee1befb90e72606eb0b49d8e3ad5146619e300c478392017e419cbd300664ba2 |
|
| MD5 | 04cedd1c34cf2f601a65a73194a8ce77 |
|
| BLAKE2b-256 | 76d581180404ba7e630cb361a108d738cc1f8af78e8876a905add28c29a176c3 |
