typed command line argument parser
Project description
typed-cap
Cap is a python Command-line Argument Parser that provides typing support. Using Cap requires less code to generate a more easy to use parser.
Usage
⚠️ typed_cap
required python>=3.9
pip install typed_cap
Quick Example
from typed_cap import Cap
class Args:
"""description here"""
# @alias=c
config: str | None
"""file path to config file"""
# @alias=d
depth: int
"""depth of search"""
dry_run: bool = True
"""run without making any changes"""
cap = Cap(Args)
parsed = cap.parse()
print(parsed.args.__dict__)
print(parsed.argv)
python demo.py
# Cap.parse: option depth:int is required but it is missing
# ArgsParserMissingArgument
python demo.py --help
# description here
#
# OPTIONS:
# -c,--config file path to config file
# -d,--depth depth of search
# --dry_run run without making any changes (default: True)
# -h,--help display the help text
python demo.py -d 5 hello typed cap
# {'depth': 5, 'config': None, 'dry_run': True}
# ['hello', 'typed', 'cap']
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
typed_cap-0.3.1.tar.gz
(526.5 kB
view hashes)
Built Distribution
typed_cap-0.3.1-py3-none-any.whl
(29.2 kB
view hashes)
Close
Hashes for typed_cap-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbc5992238b097888b64a65ecb84dea92eb2daa2fdc533899e571c3ee3f902fb |
|
MD5 | bdf6015e6427a25ad9a4844cb4748766 |
|
BLAKE2b-256 | ea830b5d2008f1e3bb0d69470bc3bdcfac23409ebbc673ed1dd03bd7a4b2a26a |