Typed Argument Parsing with Pydantic
Project description
pydantic-argparse
Typed Argument Parsing with Pydantic
Help
Documentation coming soon.
Installation
Install using:
pip3 install pydantic-argparse
Example
import pydantic
import pydantic_argparse
class Arguments(pydantic.BaseModel):
"""Arguments for CLI"""
# Required Args
aaa: str = pydantic.Field(description="I'm a required string")
bbb: int = pydantic.Field(description="I'm a required integer")
ccc: bool = pydantic.Field(description="I'm a required bool")
# Optional Args
ddd: bool = pydantic.Field(False, description="I'm an optional bool (default False)")
eee: bool = pydantic.Field(True, description="I'm an optional bool (default True)")
def main() -> None:
"""Main example function."""
# Create Parser and Parse Args
parser = pydantic_argparse.ArgumentParser(
model=Arguments,
prog="Example",
description="Example Description",
version="0.0.1",
epilog="Example Epilog",
)
args = parser.parse_typed_args()
# Print Args
print(args)
if __name__ == "__main__":
main()
$ python3 example.py --help
usage: Example [-h] [-v] --aaa AAA --bbb BBB --ccc | --no-ccc [--ddd] [--no-eee]
Example Description
required arguments:
--aaa AAA I'm a required string
--bbb BBB I'm a required integer
--ccc, --no-ccc I'm a required bool
optional arguments:
--ddd I'm an optional bool (default False)
--no-eee I'm an optional bool (default True)
help:
-h, --help show this help message and exit
-v, --version show program's version number and exit
Example Epilog
$ python3 example.py --aaa hello --bbb 123 --no-ccc
aaa='hello' bbb=123 ccc=False ddd=False eee=True
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
pydantic-argparse-0.3.1.tar.gz
(11.5 kB
view hashes)
Built Distribution
Close
Hashes for pydantic_argparse-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f59cc6434574491fb5642eebab4f6f772442d7f37d4abfa70a3907700fadfa6 |
|
MD5 | 9ec8633f59df7159bfd384e74d095c0f |
|
BLAKE2b-256 | 680b4ec7bd94ee5c861c6fabc23de2d70107c83b25f5a25acf753dc8bc26cb20 |