typed-args 0.6.0

Parse command line arguments by defining dataclasses

TypedArgs

Strong typed command line argument parser for Python.

This project is inspired by TeXitoi/structopt.

Install

From pypi

pip install typed-args

If you want to use it on python 3.5 and 3.6 please install dataclasses:

pip install dataclasses

Core Functionality

Check _test_v0_6.py for add_argument_group and add_subparsers.

Create a parser

argparse

import argparse
parser = argparse.ArgumentParser(prog='ProgramName')

typed-args

import typed_args as ta

@ta.argument_parser(prog='ProgramName')
class Args:
    pass

Add arguments

argparse

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

typed-args

import typed_args as ta

@ta.argument_parser()
class Args:
    filename: str = ta.add_argument()                    # positional argument, use the attribute name automatically
    count: str = ta.add_argument('-c', '--count')        # option that takes a value, also can be annotated as Optional[str]
    verbose: bool = ta.add_argument('-v', '--verbose', 
                                    action='store_true') # on/off flag

Parse args

argparse

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

typed-args

args = Args.parse_args()
print(args.filename, args.count, args.verbose)