akparse package
A simple and easy-to-use CLI parse tool package. You can use '-', '--', ',', '|', '{', '}', '[', ']', '=' and character to define your CLI API and the constraints are as follows:
- '-' : indicate a short option, followed by a character usually.
- '--': indicate a long option, followed by a word usually.
- ',' : indicate a required option of one CLI API defined.
- '|' : indicate a parallel option of one CLI API defined with same prefix.
- '{}': indicate the parallel option, always with '|' together.
- '[]': indicate the optional option.
- '=' : indicate the k-v option.
eg, one disk-file API:
# create a disk file when be defined: --create,-p=[--user=,-a=]
disk-file --create -p file_path
disk-file --create -p file_path --user u1 -a 777
# query a disk file when be defined: --query[{-p=|--list}]
disk-file --query
disk-file --query -p file_path
disk-file --query --list
usage
import sys
from akparse.parsers import AkParser
from akparse.utils.ak_echo import AkEcho
from akparse.errs.ak_error import AkError
flag_name = None
flag_options = None
try:
file_parser = AkParser()
file_parser.add("help", "{-h|--help}")
file_parser.add("file_create", "--create,-p=[--user=,-a=]")
file_parser.add("file_query", "--query[{-p=|--list}]")
file_parser.add("file_set", "--set{-p=,--user=,-a=|--limit=}")
file_parser.add("file_delete", "--delete,-p=[--user=]")
file_parser.add("file_status", "--status")
flag_name, flag_options = file_parser.parse(sys.argv[1:])
except AkError as err:
AkEcho.ak_err(AkError.ERROR_PARSE_MSG + err.msg)
# Print parse result
AkEcho.ak_echo(flag_name)
AkEcho.ak_echo(flag_options)
Please see more detail usage in examples
Install
This package is also released to PyPi.org. View at https://pypi.org/project/akparse/
pip install akparse
659 Dec 28, 2022
69 Oct 24, 2022
3 Jul 4, 2022
24 Oct 10, 2022
1 Nov 7, 2021
23 Jul 4, 2022
2 Dec 6, 2021
1 Dec 11, 2021
75 Dec 4, 2022
9 May 17, 2022
16 May 29, 2022
166 Dec 30, 2022
5 Nov 22, 2022
1 Oct 12, 2021
4 Aug 4, 2022
14 Sep 11, 2022
2 Dec 10, 2021
1 Nov 5, 2021
1 Feb 5, 2022