edq.cli.config.list

 1"""
 2List the current configuration options.
 3"""
 4
 5import argparse
 6import sys
 7
 8import edq.core.argparser
 9
10CONFIG_FIELD_SEPARATOR: str = "\t"
11
12def run_cli(args: argparse.Namespace) -> int:
13    """ Run the CLI. """
14
15    rows = []
16
17    for (key, value) in args._config.items():
18        row = [key, str(value)]
19        if (args.show_origin):
20            config_source_obj = args._config_sources.get(key)
21
22            origin = config_source_obj.path
23            if (origin is None):
24                origin = config_source_obj.label
25
26            row.append(origin)
27
28        rows.append(CONFIG_FIELD_SEPARATOR.join(row))
29
30    rows.sort()
31
32    if (not args.skip_header):
33        header = ["Key", "Value"]
34        if (args.show_origin):
35            header.append("Origin")
36
37        rows.insert(0, (CONFIG_FIELD_SEPARATOR.join(header)))
38
39    print("\n".join(rows))
40    return 0
41
42def main() -> int:
43    """ Get a parser, parse the args, and call run. """
44
45    return run_cli(_get_parser().parse_args())
46
47def _get_parser() -> argparse.ArgumentParser:
48    """ Get a parser and add addition flags. """
49
50    parser = edq.core.argparser.get_default_parser(__doc__.strip())
51    modify_parser(parser)
52
53    return parser
54
55def modify_parser(parser: argparse.ArgumentParser) -> None:
56    """ Add this CLI's flags to the given parser. """
57
58    parser.add_argument("--show-origin", dest = 'show_origin',
59        action = 'store_true',
60        help = "Display where each configuration's value was obtained from.",
61    )
62
63    parser.add_argument("--skip-header", dest = 'skip_header',
64        action = 'store_true',
65        help = 'Skip headers when displaying configs.',
66    )
67
68if (__name__ == '__main__'):
69    sys.exit(main())