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 otherargparselibraries. -
run this normally with
python test.py 100 param2
- 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.
If needed you could declare it inside docstring like
:param arg1: -a --arg this is the document. Also one can usedef main(arg1:int=Argument(flags=('-a', '--arg'), ...): ... - The decorated functions can be composed to form nested sub-commands of any level.
- No external lib dependency
- Most of the Standard types supported. Please see examples for more supported types with examples.
- All argument to
ArgumentParser.add_argumentis supported. It can be updated witharger.Argumentclasses. *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
Similar Projects
argh
- has similar goals as to ease up using argparser.
- doesn't support type hints.
- No recent releases.
typer
- if you are using
click, I highly recommend you to check this library. - it is neat and many features are drawn from it.
- doesn't support loading help text for arguments from docstrings.
invoke
- doesn't support type hints.
cliche
- has similar goals.
- doesn't cover much use cases as
arger.
cliar
- no docstring support for help argument.
Recommended Alternatives
Projects that I highly recommend you to checkout.
This project was generated with cookiecutter using jacebrowning/template-python.
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
arger-1.2.3.tar.gz
(13.1 kB
view details)
Built Distribution
arger-1.2.3-py3-none-any.whl
(11.6 kB
view details)
File details
Details for the file arger-1.2.3.tar.gz.
File metadata
- Download URL: arger-1.2.3.tar.gz
- Upload date:
- Size: 13.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3186dcfb9211e6b4af9f5cedb90c75be67afc38007f19ba42db7e16d9e9917ec |
|
| MD5 | f5eda2d4e061285f9bd4ce3caf6fc45d |
|
| BLAKE2b-256 | 73f4d6013f7ac95eda0b7487012578b1d0c68e1e596b750915f45bb2d9524bbe |
File details
Details for the file arger-1.2.3-py3-none-any.whl.
File metadata
- Download URL: arger-1.2.3-py3-none-any.whl
- Upload date:
- Size: 11.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 133968cd3ad660b797090d3df4ed78a733392b52d7c5e96b0dffa4ce18bac69d |
|
| MD5 | 2a0388933d42ddfd9bfdff3bbb3725e6 |
|
| BLAKE2b-256 | 98d8d99484fbe404467d68767961ee9414ea18101dbd0f2c7663e95c01ada3fc |
