Documentation
•
pip install dcargs
dcargs is a library for typed CLI interfaces
and configuration objects.
Our core interface, dcargs.cli(), generates argument parsers from type-annotated
callables: functions, dataclasses, classes, and nested dataclasses and classes.
This can be used as a replacement for argparse:
| with argparse | with dcargs |
"""Sum two numbers from argparse."""
import argparse
parser = argparse.ArgumentParser()
parser.add_argument(
"--a",
type=int,
required=True,
)
parser.add_argument(
"--b",
type=int,
default=3,
)
args = parser.parse_args()
print(args.a + args.b) |
"""Sum two numbers by calling a
function with dcargs."""
import dcargs
def main(a: int, b: int = 3) -> None:
print(a + b)
dcargs.cli(main)"""Sum two numbers by instantiating
a dataclass with dcargs."""
from dataclasses import dataclass
import dcargs
@dataclass
class Args:
a: int
b: int = 3
args = dcargs.cli(Args)
print(args.a + args.b) |
For more sophisticated examples, see our documentation.