Skip to main content

argparse with type annotations

Project description

TypedArgs

Build Status

Strong type args.

This project is inspired by TeXitoi/structopt.

Install

From pypi

pip install typed-args

From github

pip install git+https://github.com/SunDoge/typed-args.git@v0.3

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

pip install dataclasses

Usage

from dataclasses import dataclass

from typed_args import TypedArgs, add_argument


@dataclass
class Args(TypedArgs):
    data: str = add_argument(metavar='DIR', help='path to dataset')
    arch: str = add_argument('-a', '--arch', metavar='ARCH', default='resnet18',
                             help='model architecture (default: resnet18)')
    num_workers: int = add_argument('-j', '--workers', default=4, metavar='N',
                                    help='number of data loading workers (default: 4)')

    def __post_init__(self):
        """
        anothor way to init
        """
        self.parse_args()


def test_args():
    data = '/path/to/dataset'
    arch = 'resnet50'
    num_workers = 8

    argv = f'{data} -a {arch} --workers {num_workers}'.split()

    args = Args.from_args(argv)

    args1 = Args() # if __post_init__ is defined

    assert args.arch == arch
    assert args.data == data
    assert args.num_workers == num_workers


if __name__ == "__main__":
    test_args()

Limitation

Currently, we don't support add_group and sub parser.

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-args-0.3.5.tar.gz (5.1 kB view hashes)

Uploaded Source

Built Distribution

typed_args-0.3.5-py3-none-any.whl (5.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page