File size: 1,905 Bytes
f15d29e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | # Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
import argparse
import sys
from typing import Callable, TypeVar, cast
from omegaconf import OmegaConf
R = TypeVar("R")
def get_config(argv: list[str] | None, config_cls: Callable[..., R]) -> R:
"""
Utility function to get OmegaConf config options.
Args:
argv: Either a list of command line arguments to parse, or None.
If None, this argument is set from sys.argv.
config_cls: Dataclass object specifying config structure
(i.e. which fields to expect in the config).
It should be the class itself, NOT an instance of the class.
Returns:
Config object, which will pass as an instance of `config_cls` among other things.
Note: the type for this could be specified more carefully, but OmegaConf's typing
system is a bit complex. See OmegaConf's docs for "structured" for more info.
"""
if argv is None:
argv = sys.argv[1:]
# Parse command line arguments
parser = argparse.ArgumentParser(allow_abbrev=False) # prevent prefix matching issues
parser.add_argument(
"--config",
type=str,
action="append",
default=list(),
help="Path to a yaml config file. "
"Argument can be repeated multiple times, with later configs overwriting previous ones.",
)
args, config_changes = parser.parse_known_args(argv)
# Read configs from file and command line
conf_yamls = [OmegaConf.load(c) for c in args.config]
conf_cli = OmegaConf.from_cli(config_changes)
# Make merged config options
# CLI options take priority over YAML file options
schema = OmegaConf.structured(config_cls)
config = OmegaConf.merge(schema, *conf_yamls, conf_cli)
OmegaConf.set_readonly(config, True) # should not be written to
return cast(R, config)
|