Skip to content

_blockUtils

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.blocks._blockUtils

_calc_routine 

_calc_routine(attach=True)

Decorator for SingleBlock or ListBlock methods that calculate values from existing attributes.

calc_routine functions can be called at any time, but can also be queued to run at serialization, as in refreshing relevant calculated values before saving the file. See SingleBlock.add_calc_routine()

Source code in FoSpy/blocks/_blockUtils.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
def _calc_routine(attach=True):
    """
    Decorator for `SingleBlock` or `ListBlock` methods that calculate values
    from existing attributes.

    `calc_routine` functions can be called at any time, but can also be queued
    to run at serialization, as in refreshing relevant calculated values before
    saving the file. See `SingleBlock.add_calc_routine()`
    """
    def decorator(func):
        func._is_calc_routine = True
        func.__doc__ = (func.__doc__ or "") + "\nThis function is decorated as a calc_routine"

        return func
    return decorator

_get_block_classes 

_get_block_classes(module)
Source code in FoSpy/blocks/_blockUtils.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def _get_block_classes(module):
    from .blocks import Block
    import inspect

    __block_classes__ = []

    for name, obj in inspect.getmembers(module, inspect.isclass):
        if obj.__module__ != module.__name__:
            continue

        if issubclass(obj, Block):
            __block_classes__.append(name)

    return __block_classes__

_is_full_template 

_is_full_template(val)
Source code in FoSpy/blocks/_blockUtils.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def _is_full_template(val):
    from FoSpy.blocks.template import TemplateField
    if val == TemplateField().serialize():
        return True

    if isinstance(val, list):
        if len(val) != 1:
            return False
        if type(val[0]) is not dict:
            return False
        return _is_full_template(val[0])

    if isinstance(val, dict):
        for key, v in val.items():
            if key != "template_name" and not (key.startswith("_") or _is_full_template(v)):
                return False
        return True

_template_found 

_template_found(val)
Source code in FoSpy/blocks/_blockUtils.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def _template_found(val):
    from FoSpy.blocks.template import TemplateField
    if val == TemplateField().serialize():
        return True

    if isinstance(val, list):
        for d in val:
            if _template_found(d):
                return True
        return False

    if isinstance(val, dict):
        for key, v in val.items():
            if key != "template_name" and _template_found(v):
                return True
        return False

    return False

_unwrap_block 

_unwrap_block(struct)
Source code in FoSpy/blocks/_blockUtils.py 
17
18
19
20
21
22
23
24
25
def _unwrap_block(struct):
    from .blocks import SingleBlock
    while isinstance(struct,list) and len(struct) == 1:
        struct = struct[0]

    if isinstance(struct,SingleBlock):
        struct = struct.serialize(keepListType=True)
        struct = _unwrap_block(struct)
    return struct