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
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.9.tar.gz
(12.4 kB
view details)
Built Distribution
arger-1.2.9-py3-none-any.whl
(11.5 kB
view details)
File details
Details for the file arger-1.2.9.tar.gz.
File metadata
- Download URL: arger-1.2.9.tar.gz
- Upload date:
- Size: 12.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.0-1032-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c0156c1c3f52f278ce744e242e3213ceb7ab3ed847143c60df5b2926434d364c |
|
| MD5 | ea6996da1dbd9d3363754d67c36447e9 |
|
| BLAKE2b-256 | 34117d08258ce4be15b420f82dc58f78d37299c488e5b06c4cd3072076b5605b |
File details
Details for the file arger-1.2.9-py3-none-any.whl.
File metadata
- Download URL: arger-1.2.9-py3-none-any.whl
- Upload date:
- Size: 11.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.0-1032-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 53ab24b48f37280b4ea217d9dd418b0fe0d5b3cd9451b5e333b60704f97b216b |
|
| MD5 | 7835763352e8c7454e19902ace21fda9 |
|
| BLAKE2b-256 | 9c592fa1e4406a757b21e53d368ff8a975a6ef82e88f07adb848092b4b4a3fdc |
