Skip to content

_enforce

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._enforce

REGISTRY module-attribute 

REGISTRY = {
    "str": str,
    "bool": bool,
    "int": int,
    "float": float,
}

_add_enforcement 

_add_enforcement(module, checks)
Source code in FoSpy/config/_enforce.py 
21
22
23
24
25
26
27
28
29
30
def _add_enforcement(module, checks):
    module._enforced = {}

    for key, val in checks.items():
        if isinstance(val, dict):
            setattr(module, key, _add_enforcement(getattr(module, key), val))
        elif isinstance(val, tuple):
            module._enforced[key] = val

    return module

_generate_checks 

_generate_checks(enforced_dict)
Source code in FoSpy/config/_enforce.py 
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
def _generate_checks(enforced_dict):
    out = {}

    for key, val in enforced_dict.items():

        if isinstance(val, dict):
            out[key] = _generate_checks(val)

        elif isinstance(val, list):
            if (
                not len(val)==3 or 
                not all([isinstance(v, list) for v in val[:2]]) or 
                not isinstance(val[2], str)):
                raise ValueError("Enforcement json should contain a [goodchecks, badchecks, hint] set for each enforced key")

            goodchecks, badchecks, hint = val
            enforce = []
            for checkset in val[:2]:
                checks = []
                for typestr in checkset:
                    if ":" in typestr:
                        typ, arg = typestr.split(":")
                        typ = REGISTRY.get(typ, None)
                        if typ is None:
                            raise ValueError(f"Unknown enforcement type '{typ}' in {key}")
                        checks.append(lambda x, t=typ, a=arg: x == t(a))

                    else:
                        typ = REGISTRY.get(typestr, None)
                        if typ is None:
                            raise ValueError(f"Unknown enforcement type '{typestr}' in {key}")
                        checks.append(lambda x, t=typ: isinstance(x, t))

                enforce.append(checks)
            out[key] = (*enforce, hint)

        else:
            raise ValueError(f"Enforcement json should contain a [goodchecks, badchecks, hint] set for each enforced key")

    return out

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)