argparse with type annotations
Project description
TypedArgs
Strong type args.
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
Usage
import argparse
from dataclasses import dataclass
from typed_args import TypedArgs, add_argument
"""
argparse
"""
parser = argparse.ArgumentParser(prog='PROG')
parser.add_argument(
'data', metavar='DIR', type=str,
help='path to dataset'
)
parser.add_argument(
'-a', '--arch', metavar='ARCH', default='resnet18', type=str,
help='model architecture (default: resnet18)'
)
parser.add_argument(
'-j', '--workers', default=4, metavar='N', type=int, dest='num_workers',
help='number of data loading workers (default: 4)'
)
"""
TypedArgs
"""
@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 parser_factory(self):
return argparse.ArgumentParser('PROG')
def test_args():
data = '/path/to/dataset'
arch = 'resnet50'
num_workers = 8
argv = f'{data} -a {arch} --workers {num_workers}'.split()
"""
from_args = parse_args, from_known_args = parse_known_args
"""
typed_args = Args.from_args(argv)
args = parser.parse_args(argv)
assert args.arch == typed_args.arch
assert args.data == typed_args.data
assert args.num_workers == typed_args.num_workers
if __name__ == "__main__":
test_args()
Limitation
Currently, we don't support add_group
and sub parser
.
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
typed-args-0.4.1a1.tar.gz
(6.1 kB
view hashes)
Built Distribution
Close
Hashes for typed_args-0.4.1a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd6facf553f11d3c3eada2115655297c4ee37773e53d5c30d8337213c0034034 |
|
MD5 | b2c0e9e079b61353807e1d369586e2d1 |
|
BLAKE2b-256 | 80b93e49969ada3dbc827b85a0389805030903e9cd3b699169c13bca29c82808 |