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
or add it to your Poetry project:
$ poetry add 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.
:param param1: The first parameter.
:param param2: The second parameter.
"""
print(locals())
if __name__ == '__main__':
Arger(main).run()
-
Here Arger is just a subclass of
ArgumentParser
. It will not conceal you from using otherargparse
libraries. -
run this normally with
python test.py 100 param2
- Checkout examples folder and documentation to see more of
arger
in 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
Argument
class 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
*args
supported but no**kwargs
support 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
Project details
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.