configuration

 1"""
 2.. include:: ../docs/configuration.md
 3"""
 4
 5import datetime
 6import os
 7import os.path
 8from os.path import isabs
 9from typing import Dict, Optional
10
11import yaml
12
13configDir = os.path.join(os.path.dirname(__file__), "..", "config")
14if not os.path.isdir(configDir):
15    os.makedirs(configDir,exist_ok=True)
16
17
18def save_to_file(configuration: Dict, configName: Optional[str] = None):
19    """
20    If a `configName` is passed, this will be used to construct the file
21    name. Otherwise the current time is used. Either way, config files are
22    written into the `config/` directory.
23    """
24    if configName is None:
25        now = datetime.datetime.now().strftime("%d.%m.%Y_%H:%M")
26        configName = f"{now}.yml"
27    configFilePath = os.path.join(configDir, configName)
28    with open(configFilePath, 'w') as file:
29        yaml.dump(configuration, file)
30    print(f"Configuration has been saved to {configFilePath}.")
31
32
33def from_abs_path(absoluteFilePath: str) -> Dict:
34    """
35    Load a Configuration from absolute file path.
36    """
37    assert os.path.isfile(
38        absoluteFilePath), f"{absoluteFilePath} not found"
39    with open(absoluteFilePath) as yamlFile:
40        yamlContent: Dict = yaml.load(yamlFile, Loader=yaml.Loader)
41    return yamlContent
42
43
44def from_rel_path(fileName: str) -> Dict:
45    """
46    Load a Configuration from relative file path.
47    """
48    curDir = os.path.abspath(os.path.curdir)
49    absoluteFilePath = os.path.join(curDir, fileName)
50    return from_abs_path(absoluteFilePath)
51
52
53def from_name(fileName: str) -> Dict:
54    """
55    Load a Configuration from `config/`.
56
57    `fileName` is the name of the file inside `config/`.
58    """
59    absoluteFilePath = os.path.join(configDir, fileName)
60    return from_abs_path(absoluteFilePath)
61
62
63def from_cli_options(options: Dict) -> Dict:
64    """
65    Take options from CLI and load correct config file.
66    """
67    configFile = options["config"]
68    try:
69        if isabs(configFile):
70            config = from_abs_path(configFile)
71        else:
72            config = from_rel_path(configFile)
73        name = config["name"]
74        print(f"Using configuration \"{name}\"")
75    except BaseException:
76        config = from_name("example.yml")
77        print("Using default configuration.")
78
79    return config
80
81
82if __name__ == "__main__":
83    import argparse
84    parser = argparse.ArgumentParser(description='Dry run of parsing the provided configuration file.')
85    parser.add_argument('--config', help='Relative path to config file.',)
86    config = from_cli_options(vars(parser.parse_args()))
87    print(config)