Skip to content

config/__init__

Full documentation pages are generated for docstring reference only and may contain symbols imported from other modules. Imported symbols are not distinguished from locally defined symbols and will appear in any module that they are imported into. For better information on where symbols should be imported from, review the sourcecode on the github.

FoSpy.config

DEFAULT_FILE module-attribute 

DEFAULT_FILE = load.get_default_file()

SESSION_START module-attribute 

SESSION_START = None

USER_FILE module-attribute 

USER_FILE = load.get_user_file()

__all__ module-attribute 

__all__ = ['values']

module module-attribute 

module = sys.modules[__name__]

values module-attribute 

values = None

NestedConfig

Bases: types.ModuleType

Source code in FoSpy/config/__init__.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
class NestedConfig(types.ModuleType):
    def __init__(self, config_dict, name, *args, parent_name =__name__,**kwargs):
        super().__init__(f"{parent_name}.{name}", *args, **kwargs)
        self.__package__ = parent_name
        self.__file__ = __file__
        self.__all__ = []
        self._enforced = {}
        for key, val in config_dict.items():
            setattr(self, key, val)

    def __getattr__(self, key):
        # Auto-create nested modules
        mod = NestedConfig({}, key, parent_name=self.__name__)
        setattr(self, key, mod)
        return mod

    def __setattr__(self, key, val):
        # Convert dicts to nested modules automatically
        if not key.startswith("_"):
            if key in self._enforced:
                goodchecks, badchecks, hint=self._enforced[key]
                if (
                    not any(check(val) for check in goodchecks) or
                    any(check(val) for check in badchecks)
                ):
                    raise ValueError(f"Error setting config value '{key}': {hint}")
            if key not in self.__all__:
                self.__all__.append(key)

            if isinstance(val, dict):
                val = NestedConfig(val, key, parent_name=self.__name__)

        super().__setattr__(key, val)

    def __iter__(self):
        return iter(self())

    def to_dict(self):
        out = {}
        for key in self.__all__:
            val = getattr(self, key)
            if isinstance(val, NestedConfig):
                out[key] = val.to_dict()
            else:
                out[key] = val
        return out

    def get(self, key, default=None):
        val = getattr(self, key)
        if isinstance(val, NestedConfig):
            if val() == {}:
                return default
            return val()
        return val

    def __call__(self):
        return self.to_dict()

__all__ instance-attribute 

__all__ = []

__file__ instance-attribute 

__file__ = __file__

__package__ instance-attribute 

__package__ = parent_name

_enforced instance-attribute 

_enforced = {}

__call__ 

__call__()
Source code in FoSpy/config/__init__.py 
175
176
def __call__(self):
    return self.to_dict()

__getattr__ 

__getattr__(key)
Source code in FoSpy/config/__init__.py 
130
131
132
133
134
def __getattr__(self, key):
    # Auto-create nested modules
    mod = NestedConfig({}, key, parent_name=self.__name__)
    setattr(self, key, mod)
    return mod

__init__ 

__init__(
    config_dict, name, *args, parent_name=__name__, **kwargs
)
Source code in FoSpy/config/__init__.py 
121
122
123
124
125
126
127
128
def __init__(self, config_dict, name, *args, parent_name =__name__,**kwargs):
    super().__init__(f"{parent_name}.{name}", *args, **kwargs)
    self.__package__ = parent_name
    self.__file__ = __file__
    self.__all__ = []
    self._enforced = {}
    for key, val in config_dict.items():
        setattr(self, key, val)

__iter__ 

__iter__()
Source code in FoSpy/config/__init__.py 
154
155
def __iter__(self):
    return iter(self())

__setattr__ 

__setattr__(key, val)
Source code in FoSpy/config/__init__.py 
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
def __setattr__(self, key, val):
    # Convert dicts to nested modules automatically
    if not key.startswith("_"):
        if key in self._enforced:
            goodchecks, badchecks, hint=self._enforced[key]
            if (
                not any(check(val) for check in goodchecks) or
                any(check(val) for check in badchecks)
            ):
                raise ValueError(f"Error setting config value '{key}': {hint}")
        if key not in self.__all__:
            self.__all__.append(key)

        if isinstance(val, dict):
            val = NestedConfig(val, key, parent_name=self.__name__)

    super().__setattr__(key, val)

get 

get(key, default=None)
Source code in FoSpy/config/__init__.py 
167
168
169
170
171
172
173
def get(self, key, default=None):
    val = getattr(self, key)
    if isinstance(val, NestedConfig):
        if val() == {}:
            return default
        return val()
    return val

to_dict 

to_dict()
Source code in FoSpy/config/__init__.py 
157
158
159
160
161
162
163
164
165
def to_dict(self):
    out = {}
    for key in self.__all__:
        val = getattr(self, key)
        if isinstance(val, NestedConfig):
            out[key] = val.to_dict()
        else:
            out[key] = val
    return out

_deep_merge 

_deep_merge(a, b)
Source code in FoSpy/config/__init__.py 
75
76
77
78
79
80
81
82
def _deep_merge(a, b):
    out = a.copy()
    for k, v in b.items():
        if k in out and isinstance(out[k], dict) and isinstance(v, dict):
            out[k] = _deep_merge(out[k], v)
        else:
            out[k] = v
    return out

_extract_user 

_extract_user(defaults, current)

Return only the parts of current that differ from defaults, in a structure that can be merged back over defaults to recover current.

Source code in FoSpy/config/__init__.py 
 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
def _extract_user(defaults, current):
    """
    Return only the parts of `current` that differ from `defaults`,
    in a structure that can be merged back over `defaults` to recover `current`.
    """


    if isinstance(defaults, dict) and isinstance(current, dict):
        out = {}
        keys = set(defaults) | set(current)
        for k in keys:
            if k not in defaults:

                out[k] = current[k]
            elif k in current:
                sub = _extract_user(defaults[k], current[k])
                if sub is not None:
                    out[k] = sub
        return out or None


    if isinstance(defaults, list) and isinstance(current, list):
        return current if defaults != current else None


    return current if defaults != current else None

_load_defaults 

_load_defaults()
Source code in FoSpy/config/__init__.py 
71
72
73
def _load_defaults():
    with open(DEFAULT_FILE, 'r') as f:
        return json.load(f)

_restart_session 

_restart_session()
Source code in FoSpy/config/__init__.py 
65
66
67
68
def _restart_session():
    global SESSION_START
    SESSION_START = _load()
    module.values = NestedConfig(SESSION_START, "values")

enforce_config 

enforce_config()
Source code in FoSpy/config/_enforce.py 
 9
10
11
12
13
14
15
16
17
18
19
def enforce_config():
    from . import module
    from ._load import get_enforced_file
    import json

    with open(get_enforced_file(), 'r') as f:
        enforced_dict = json.load(f)

    checks = _generate_checks(enforced_dict)

    module.values = _add_enforcement(module.values, checks)

load_user 

load_user(filepath=None)
Source code in FoSpy/config/__init__.py 
36
37
38
39
40
41
42
43
44
def load_user(filepath=None):
    if filepath is None:
        filepath = USER_FILE
    else:
        filepath = os.path.abspath(filepath)
    with open(filepath, 'r') as f:
        new_config = _deep_merge(module.values.to_dict(), json.load(f))

    module.values = NestedConfig(new_config, "values")

reset 

reset(prompt=True)
Source code in FoSpy/config/__init__.py 
53
54
55
56
57
58
59
60
61
62
63
def reset(prompt=True):
    if prompt and input("WARNING: Resetting the config to default values will delete the "
                        "existing user config and restart the session. Consider exporting "
                        "the current user overrides with save(filepath) before resetting. "
                        "You can also revert to the start of the session with revert().\n"
                        "Proceed with reset? (y/n): ").lower() != "y":
        return
    with open(USER_FILE, 'w') as f:
        f.write("{}")

    _restart_session()

revert 

revert(prompt=True)
Source code in FoSpy/config/__init__.py 
46
47
48
49
50
51
def revert(prompt=True):
    if prompt and input("WARNING: Reverting the config to the last saved user config will "
                        "lose any unsaved changes.\n"
                        "Proceed with reversion? (y/n): ").lower() != "y":
        return
    module.values = NestedConfig(SESSION_START, "values")

save_all 

save_all(filepath=None, prompt=True)
Source code in FoSpy/config/__init__.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def save_all(filepath=None, prompt=True):
    current = module.values.to_dict()
    defaults = _load_defaults()

    if filepath is None:
        filepath = USER_FILE
    else:
        filepath = os.path.abspath(filepath)

    if (filepath == USER_FILE and 
        prompt and 
        input("WARNING: Saving the config will overwrite the existing user config "
              "and restart the session. Consider exporting the current user "
              "overrides with save(filepath) before saving.\n"
              "Proceed with saving? (y/n): ").lower() != "y"):
        return

    with open(filepath, 'w') as f:
        json.dump(_extract_user(defaults, current), f, indent=4)

    if filepath == USER_FILE:
        _restart_session()