configure argparse from function signature
Project description
argparse_action
argparse_action
aims to be a minimalistic extension of argparse
and creates
cli options from the function signature given by inspect.signature
.
import argparse
import argparse_action
parser = argparse.ArgumentParser()
action = argparse_action.Action(parser)
@action.add("e")
def echo(word, upper=False):
print(word.upper() if upper else word)
namespace = parser.parse_args()
namespace.action(namespace)
Asumes that the code above is saved as my_script.py
:
$ python3 my_script.py echo hello
hello
$ python3 my_script.py e hello
hello
$ python3 my_script.py echo --upper hello
HELLO
Installation
pip install argparse_action
Configuration
make dev
CI check
The check
make target collects the targets which are run by the CI server.
make check
Testing
The test
target requires a virtulenv where argparse_action
is installed.
The dev
target creates that virtualenv under .venv
directory.
make test
Formatting
The argparse_action project is formatted with black
. The CI check invokes the
check-format
target to ensure that the python files are formatted with
black
.
make check-format
black
can be run with the format
make target.
make format
Linter
The lint
target runs pylint
over the argparse_action project.
make lint
Documentation
Documentation can be build with the doc
make target. To ensure the documentation build
tools the make dev
has to be executed once before make doc
.
make doc
Online version can be read at readthedocs.org.
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.
Source Distribution
Built Distribution
File details
Details for the file argparse_action-0.5.2.tar.gz
.
File metadata
- Download URL: argparse_action-0.5.2.tar.gz
- Upload date:
- Size: 8.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea1504b2175a512101a81daccbac0b2328584392e89a64afbd5a5eaca92f77e8 |
|
MD5 | d732696dc722839eeee2a0839e42489c |
|
BLAKE2b-256 | 5ff0540d51b09ab29f54832fe54175aeb5d4fdc3f47febaa811693e8741faa2d |
File details
Details for the file argparse_action-0.5.2-py3-none-any.whl
.
File metadata
- Download URL: argparse_action-0.5.2-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 847998ccb4e6b65de3d989b1e45dbf34d251643f2bc6d9e3adfd3626bd2d4221 |
|
MD5 | 3bbfa03fed9caf6e52d77e485f47bb2b |
|
BLAKE2b-256 | 4a98f7f74906feaf16792ce2a6e331a5f6517d0ea43ccd0b24985d32b935f87a |