multiped-learning/common.py at main · Shaadalam9/multiped-learning · GitHub

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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
"""Contains various function used throughout this project."""
# by Pavlo Bazilinskyy <pavlo.bazilinskyy@gmail.com>
import os
import json
import pickle
import sys
from custom_logger import CustomLogger

root_dir = os.path.dirname(__file__)
cache_dir = os.path.join(root_dir, "_cache")
log_dir = os.path.join(root_dir, "_logs")
output_dir = os.path.join(root_dir, "_output")

logger = CustomLogger(__name__)  # use custom logger


def get_configs(
    entry_name: str,
    config_file_name: str = "config",
    config_default_file_name: str = "default.config",
):
    """
    Open the config file and return the requested entry.
    If no config file is found, open default.config.
    """
    # check if config file is updated
    if not check_config():
        sys.exit()
    try:
        with open(os.path.join(root_dir, config_file_name)) as f:
            content = json.load(f)
    except FileNotFoundError:
        with open(os.path.join(root_dir, config_default_file_name)) as f:
            content = json.load(f)
    return content[entry_name]


def check_config(
    config_file_name: str = "config", config_default_file_name: str = "default.config"
):
    """
    Check if config file has at least as many rows as default.config.
    """
    # load config file
    try:
        with open(os.path.join(root_dir, config_file_name)) as f:
            config = json.load(f)
    except FileNotFoundError:
        logger.error("Config file {} not found.", config_file_name)
        return False
    except json.decoder.JSONDecodeError:
        logger.error(
            "Config file badly formatted. Please update based on" + " default.config.",
            config_file_name,
        )
        return False
    # load default.config file
    try:
        with open(os.path.join(root_dir, config_default_file_name)) as f:
            default = json.load(f)
    except FileNotFoundError:
        logger.error("Default config file {} not found.", config_file_name)
        return False
    except json.decoder.JSONDecodeError:
        logger.error(
            "Config file badly formatted. Please update based on" + " default.config.",
            config_file_name,
        )
        return False
    # check length of each file
    if len(config) < len(default):
        logger.error(
            "Config file has {} variables, which is fewer than {} variables in default.config. Please"
            + " update.",
            len(config),
            len(default),
        )
        return False
    else:
        return True


def search_dict(dictionary, search_for, nested=False):
    """
    Search if dictionary value contains certain string search_for. If
    nested=True multiple levels are traversed.
    """
    for k in dictionary:
        if nested:
            for v in dictionary[k]:
                if search_for in v:
                    return k
                elif v in search_for:
                    return k
        else:
            if search_for in dictionary[k]:
                return k
            elif dictionary[k] in search_for:
                return k
    return None


def save_to_p(file, data, desription_data="data"):
    """
    Save data to a pickle file.
    """
    path = os.path.join(os.path.join(root_dir, "trust"), file)
    with open(path, "wb") as f:
        pickle.dump(data, f)
    logger.info("Saved " + desription_data + " to pickle file {}.", file)


def load_from_p(file, desription_data="data"):
    """
    Load data from a pickle file.
    """
    path = os.path.join(os.path.join(root_dir, "trust"), file)
    with open(path, "rb") as f:
        data = pickle.load(f)
    logger.info("Loaded " + desription_data + " from pickle file {}.", file)
    return data