load config from command arguments

[dc3ea9f]

Hi, I want to use --from_yaml to specify use which config file, then load it to Config, use Config.parse() to modify the specified config.

The current code is:

from chanfig import Config
from rich import print


if __name__ == '__main__':
    yaml_config = Config()
    yaml_config.add_argument('--from_yaml', type=str, required=True)
    yaml_config.parse()
    config = Config.from_yaml(yaml_config.from_yaml)
    config = config.parse()
    print(config)

While it is a little ugly, and when run with --help, it only shows help messages of yaml_config since the first parser is used.

Is there a more elegant way to do so?

[ZhiyuanChen]

config.parse has a parameter named default_config. This allow you to apply your CLI arguments on a config file.

from chanfig import Config
from rich import print


if __name__ == '__main__':
    config = config.parse(default_config="config")
    print(config)

python xxx.py --config default.yaml

[dc3ea9f]

Thank you. It fixed it.

[dc3ea9f]

sorry for the late response, I have just tested the snippet, however, when run with --help, it won't show keys in the configuration file, even run with --config.

❯ python run.py --config configs/exps/test.yaml --help
usage: run.py [-h] [--config CONFIG]

options:
  -h, --help       show this help message and exit
  --config CONFIG

[ZhiyuanChen]

sorry for the late response, I have just tested the snippet, however, when run with --help, it won't show keys in the configuration file, even run with --config.

❯ python run.py --config configs/exps/test.yaml --help

usage: run.py [-h] [--config CONFIG]



options:

  -h, --help       show this help message and exit

  --config CONFIG

Im not sure if it’s possible to achieve this.

Merging a config file happens after parsed the command line arguments.

--help is handled by argparse when parsing the command line arguments.

[dc3ea9f]

Yes, I know it is a little weird to load from config and then add to the argparse, but it could be better if we can support this. This may change a lot of logic when loading and parsing the config.

[ZhiyuanChen]

Yes, I'll need some time for this, hopefully by the end of August.