No project description provided
Project description
PAI Argument Parser
The PAI Argument Parser extends the common python argument parser by allowing to automatically parse and add arguments based on dataclasses.
See the following example for usage:
Simple Example
from typing import List
from paiargparse import pai_dataclass, pai_meta, PAIArgumentParser
from dataclasses import dataclass, field
@pai_dataclass
@dataclass
class SubmoduleParams:
required_float_arg: float
list_arg: List[int] = field(default_factory=lambda: [1, 2])
arg_with_custom_help: str = field(default="You can specify a custom help string", metadata=pai_meta(
help="Custom help string."
))
@pai_dataclass
@dataclass
class MyArguments:
required_int_arg: int
optional_str_arg: str = "This is cool stuff"
sub_params: SubmoduleParams = field(default_factory=lambda: SubmoduleParams(required_float_arg=2))
if __name__ == "__main__":
parser = PAIArgumentParser()
parser.add_root_argument("myArgs", MyArguments)
args = parser.parse_args()
Call with
python my_program.py --myArgs.required_int_arg 1 --myArgs.sub_params.required_float_arg 0.1
Other Features
- Changing of dataclasses to select different modules
- Default params from initial value
See examples and tests for a bunch of different settings and scenarios.
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
paiargparse-1.0.2.tar.gz
(17.4 kB
view hashes)
Built Distribution
Close
Hashes for paiargparse-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f404e318bcc941a039ea69256cbcb911226e87356052c9cad6a73b3e68815dcf |
|
MD5 | cedc84f5b6c317574f8a7feac7bbfd21 |
|
BLAKE2b-256 | 8ff3e2f5dfcd2a092d19cb8604bfd0c13f01bbc4a6aba4edc8860457aaa2ca22 |