dcargs
dcargs is a tool for generating portable, reusable, and strongly typed CLI interfaces from dataclass definitions.
We expose one function, parse(Type[T]) -> T, which takes a dataclass type and instantiates it via an argparse-style CLI interface. If we create a script called simple.py:
import dataclasses
import dcargs
@dataclasses.dataclass
class Args:
field1: str # A string field.
field2: int # A numeric field.
if __name__ == "__main__":
args = dcargs.parse(Args)
print(args)
Running python simple.py --help would print:
usage: simple.py [-h] --field1 STR --field2 INT
optional arguments:
-h, --help show this help message and exit
required arguments:
--field1 STR A string field.
--field2 INT A numeric field.
And, from python simple.py --field1 string --field2 4:
Args(field1='string', field2=4)
Feature list
The parse function supports a wide range of dataclass definitions, while automatically generating helptext from comments/docstrings. Some of the basic features are shown in the example below.
Our unit tests cover many more complex type annotations, including classes containing:
- Types natively accepted by
argparse: str, int, float, pathlib.Path, etc - Default values for optional parameters
- Booleans, which are automatically converted to flags when provided a default value (eg
action="store_true"oraction="store_false"; in the latter case, we prefix names withno-) - Enums (via
enum.Enum; argparse'schoicesis populated and arguments are converted automatically) - Various container types. Some examples:
typing.ClassVartypes (omitted from parser)typing.Optionaltypestyping.Literaltypes (populates argparse'schoices)typing.Sequencetypes (populates argparse'snargs)typing.Listtypes (populates argparse'snargs)typing.Tupletypes, such astyping.Tuple[T, T, T]ortyping.Tuple[T, ...](populates argparse'snargs, and converts automatically)typing.Finaltypes andtyping.Annotated(for parsing, these are effectively no-ops)- Nested combinations of the above:
Optional[Literal[T]],Final[Optional[Sequence[T]]], etc
- Nested dataclasses
- Simple nesting (see
OptimizerConfigexample below) - Unions over nested dataclasses (subparsers)
- Optional unions over nested dataclasses (optional subparsers)
- Simple nesting (see
- Generic dataclasses (including nested generics, see ./examples/generics.py)
A usage example is available below. Examples of additional features can be found in the tests.
Comparisons to alternative tools
There are several alternative libraries to dcargs; here's a rough summary of some of them:
| Parsers from dataclasses | Parsers from attrs | Nested dataclasses | Subparsers (via Unions) | Containers | Choices from literals | Docstrings as helptext | |
|---|---|---|---|---|---|---|---|
| dcargs | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| datargs | ✓ | ✓ | ✓ | ✓ | ✓ | ||
| simple-parsing | ✓ | ✓ | ✓ | ✓ | soon | ✓ | |
| argparse-dataclass | ✓ | ||||||
| argparse-dataclasses | ✓ | ||||||
| dataclass-cli | ✓ | ||||||
| hf_argparser | ✓ | ✓ |
Some other distinguishing factors that dcargs has put effort into:
- Robust handling of forward references
- Support for nested containers and generics
- Strong typing: we actively avoid relying on strings or dynamic namespace objects (eg
argparse.Namespace) - Simplicity + strict abstractions: we're focused on a single function API, and don't leak any argparse implementation details to the user level. We also intentionally don't offer any way to add argument parsing-specific logic to dataclass definitions. (in contrast, some of the libaries above rely heavily on dataclass field metadata, or on the more extreme end inheritance+decorators to make parsing-specific dataclasses)
Example usage
This code:
"""An argument parsing example.
Note that there are multiple possible ways to document dataclass attributes, all
of which are supported by the automatic helptext generator.
"""
import dataclasses
import enum
import dcargs
class OptimizerType(enum.Enum):
ADAM = enum.auto()
SGD = enum.auto()
@dataclasses.dataclass
class OptimizerConfig:
# Variant of SGD to use.
type: OptimizerType
# Learning rate to use.
learning_rate: float = 3e-4
# Coefficient for L2 regularization.
weight_decay: float = 1e-2
@dataclasses.dataclass
class ExperimentConfig:
experiment_name: str # Experiment name to use.
optimizer: OptimizerConfig
seed: int = 0
"""Random seed. This is helpful for making sure that our experiments are
all reproducible!"""
if __name__ == "__main__":
config = dcargs.parse(ExperimentConfig, description=__doc__)
print(config)
Generates the following argument parser:
$ python example.py --help
usage: example.py [-h] --experiment-name STR --optimizer.type {ADAM,SGD} [--optimizer.learning-rate FLOAT]
[--optimizer.weight-decay FLOAT] [--seed INT]
An argument parsing example.
Note that there are multiple possible ways to document dataclass attributes, all
of which are supported by the automatic helptext generator.
optional arguments:
-h, --help show this help message and exit
--optimizer.learning-rate FLOAT
Learning rate to use. (default: 0.0003)
--optimizer.weight-decay FLOAT
Coefficient for L2 regularization. (default: 0.01)
--seed INT Random seed. This is helpful for making sure that our experiments are
all reproducible! (default: 0)
required arguments:
--experiment-name STR
Experiment name to use.
--optimizer.type {ADAM,SGD}
Variant of SGD to use.
10 Nov 09, 2021
89 Dec 17, 2022
27 Jan 01, 2023
3.2k Jan 09, 2023
2 Jul 20, 2022
1 Jan 13, 2022
3 Oct 26, 2022
2 Apr 09, 2022
2 Jan 13, 2022
6 Dec 25, 2021
5 Nov 18, 2022
4 Dec 22, 2021
1 Dec 29, 2021
6.2k Jan 08, 2023
5 Nov 24, 2022
97 Oct 22, 2022
52 Dec 10, 2022
4 Apr 11, 2022
69 Oct 24, 2022
2 Oct 09, 2022