Skip to content

_errors

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

AttachmentTypeError

Bases: Exception

Source code in FoSpy/_errors.py 
3
4
class AttachmentTypeError(Exception):
    pass

BlockDispatchError

Bases: Exception

Source code in FoSpy/_errors.py 
6
7
class BlockDispatchError(Exception):
    pass

FailedValidatorError

Bases: PropertyError

Source code in FoSpy/_errors.py 
 96
 97
 98
 99
100
101
102
103
104
class FailedValidatorError(PropertyError):
    def __init__(self, key, blockObj, cause:Exception, *args, blockDict={}, hint="Failed to validate property: ", **kwargs):

        super().__init__(key, blockObj, *args, blockDict=blockDict, hint=hint, **kwargs)

        self.cause = cause

        self.__cause__ = cause
        self.summary = f"Failed to validate '{key}'"

__cause__ instance-attribute 

__cause__ = cause

cause instance-attribute 

cause = cause

summary instance-attribute 

summary = f'Failed to validate '{key}''

__init__ 

__init__(
    key,
    blockObj,
    cause,
    *args,
    blockDict={},
    hint="Failed to validate property: ",
    **kwargs
)
Source code in FoSpy/_errors.py 
 97
 98
 99
100
101
102
103
104
def __init__(self, key, blockObj, cause:Exception, *args, blockDict={}, hint="Failed to validate property: ", **kwargs):

    super().__init__(key, blockObj, *args, blockDict=blockDict, hint=hint, **kwargs)

    self.cause = cause

    self.__cause__ = cause
    self.summary = f"Failed to validate '{key}'"

FileBlockNotFoundError

Bases: Exception

Source code in FoSpy/_errors.py 
10
11
class FileBlockNotFoundError(Exception):
    pass

FoSpyStructureError

Bases: Exception

Source code in FoSpy/_errors.py 
13
14
class FoSpyStructureError(Exception):
    pass

ListBlockError

Bases: Exception

Source code in FoSpy/_errors.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
class ListBlockError(Exception):
    def __init__(self, blockObj, *args, hint="Error constructing ListBlock", posthint:str=None, **kwargs):
        self.blockObj = blockObj
        self.typ_nm, _, _ = _get_block_info(blockObj)
        self.hint = hint
        self.posthint = posthint
        self._build_hint()

        super().__init__(self.hint, *args, **kwargs)
        self.summary = f"Error constructing '{self.typ_nm}'."

    def _build_hint(self):
        self._build_prehint()
        self._build_posthint()

    def _build_prehint(self):
        self.hint += f" ({self.typ_nm} Type)"

    def _build_posthint(self):
        self.hint += f":\n{self.posthint}"

blockObj instance-attribute 

blockObj = blockObj

hint instance-attribute 

hint = hint

posthint instance-attribute 

posthint = posthint

summary instance-attribute 

summary = f'Error constructing '{self.typ_nm}'.'

__init__ 

__init__(
    blockObj,
    *args,
    hint="Error constructing ListBlock",
    posthint=None,
    **kwargs
)
Source code in FoSpy/_errors.py 
115
116
117
118
119
120
121
122
123
def __init__(self, blockObj, *args, hint="Error constructing ListBlock", posthint:str=None, **kwargs):
    self.blockObj = blockObj
    self.typ_nm, _, _ = _get_block_info(blockObj)
    self.hint = hint
    self.posthint = posthint
    self._build_hint()

    super().__init__(self.hint, *args, **kwargs)
    self.summary = f"Error constructing '{self.typ_nm}'."

_build_hint 

_build_hint()
Source code in FoSpy/_errors.py 
125
126
127
def _build_hint(self):
    self._build_prehint()
    self._build_posthint()

_build_posthint 

_build_posthint()
Source code in FoSpy/_errors.py 
132
133
def _build_posthint(self):
    self.hint += f":\n{self.posthint}"

_build_prehint 

_build_prehint()
Source code in FoSpy/_errors.py 
129
130
def _build_prehint(self):
    self.hint += f" ({self.typ_nm} Type)"

ListBlockMismatchError

Bases: ListBlockError

Source code in FoSpy/_errors.py 
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
class ListBlockMismatchError(ListBlockError):
    def __init__(self, blockObj, candidate, idx:int, *args, hint="Error adding block to ListBlock:", posthint:str=None, cause:Exception=None, **kwargs):
        self.candidate = candidate


        super().__init__(blockObj, *args, hint=hint, **kwargs)

        self.summary = f"(Index: {idx})"

        if cause is not None:
            self.__cause__ = cause
            self.cause = cause

    def _build_prehint(self):
        self.hint += f"\nCandidate:\n{self.candidate}\nis not a valid entry for this list block"
        super()._build_prehint()

    def _build_posthint(self):
        typ_nm = self.blockObj._reqCls.__name__
        self.hint += f"\nCandidates must be coersible to {typ_nm} objects."
        super()._build_posthint()

__cause__ instance-attribute 

__cause__ = cause

candidate instance-attribute 

candidate = candidate

cause instance-attribute 

cause = cause

summary instance-attribute 

summary = f'(Index: {idx})'

__init__ 

__init__(
    blockObj,
    candidate,
    idx,
    *args,
    hint="Error adding block to ListBlock:",
    posthint=None,
    cause=None,
    **kwargs
)
Source code in FoSpy/_errors.py 
137
138
139
140
141
142
143
144
145
146
147
def __init__(self, blockObj, candidate, idx:int, *args, hint="Error adding block to ListBlock:", posthint:str=None, cause:Exception=None, **kwargs):
    self.candidate = candidate


    super().__init__(blockObj, *args, hint=hint, **kwargs)

    self.summary = f"(Index: {idx})"

    if cause is not None:
        self.__cause__ = cause
        self.cause = cause

_build_posthint 

_build_posthint()
Source code in FoSpy/_errors.py 
153
154
155
156
def _build_posthint(self):
    typ_nm = self.blockObj._reqCls.__name__
    self.hint += f"\nCandidates must be coersible to {typ_nm} objects."
    super()._build_posthint()

_build_prehint 

_build_prehint()
Source code in FoSpy/_errors.py 
149
150
151
def _build_prehint(self):
    self.hint += f"\nCandidate:\n{self.candidate}\nis not a valid entry for this list block"
    super()._build_prehint()

MissingPropertyError

Bases: PropertyError

Source code in FoSpy/_errors.py 
91
92
93
94
class MissingPropertyError(PropertyError):
    def __init__(self, key, blockObj, *args, blockDict={}, hint="Missing required property: ", **kwargs):
        super().__init__(key, blockObj, *args, blockDict=blockDict, hint=hint, **kwargs)
        self.summary = f"Missing '{key}'"

summary instance-attribute 

summary = f'Missing '{key}''

__init__ 

__init__(
    key,
    blockObj,
    *args,
    blockDict={},
    hint="Missing required property: ",
    **kwargs
)
Source code in FoSpy/_errors.py 
92
93
94
def __init__(self, key, blockObj, *args, blockDict={}, hint="Missing required property: ", **kwargs):
    super().__init__(key, blockObj, *args, blockDict=blockDict, hint=hint, **kwargs)
    self.summary = f"Missing '{key}'"

MultipleErrors

Bases: ExceptionGroup

Source code in FoSpy/_errors.py 
39
40
class MultipleErrors(ExceptionGroup):
    pass

MultipleListBlockErrors

Bases: MultipleErrors, ListBlockError

Source code in FoSpy/_errors.py 
158
159
class MultipleListBlockErrors(MultipleErrors, ListBlockError):
    pass

MultiplePropertyErrors

Bases: MultipleErrors, PropertyError

Source code in FoSpy/_errors.py 
72
73
class MultiplePropertyErrors(MultipleErrors, PropertyError):
    pass

PropertyAliasError

Bases: PropertyError

Source code in FoSpy/_errors.py 
106
107
108
109
110
111
112
class PropertyAliasError(PropertyError):
    def __init__(self, key, blockObj, *args, blockDict={}, hint="Problem with aliased property: ", posthint:str=None, **kwargs):
        super().__init__(key, blockObj, *args, blockDict=blockDict, hint=hint, **kwargs)
        if posthint is not None:
            self.args[0] += "\n" + posthint

        self.summary = f"Alias error for '{key}'"

summary instance-attribute 

summary = f'Alias error for '{key}''

__init__ 

__init__(
    key,
    blockObj,
    *args,
    blockDict={},
    hint="Problem with aliased property: ",
    posthint=None,
    **kwargs
)
Source code in FoSpy/_errors.py 
107
108
109
110
111
112
def __init__(self, key, blockObj, *args, blockDict={}, hint="Problem with aliased property: ", posthint:str=None, **kwargs):
    super().__init__(key, blockObj, *args, blockDict=blockDict, hint=hint, **kwargs)
    if posthint is not None:
        self.args[0] += "\n" + posthint

    self.summary = f"Alias error for '{key}'"

PropertyError

Bases: Exception

Source code in FoSpy/_errors.py 
42
43
44
45
46
47
48
49
50
51
52
class PropertyError(Exception):
    def __init__(self, key, blockObj, *args, blockDict={}, hint="Error for property: ", **kwargs):
        typ_nm, block_id, id_key = _get_block_info(blockObj, blockDict)

        hint += f"'{key}' for '{typ_nm}' object."
        if block_id is not None:
            hint += f" (ID: {id_key} = {block_id})"

        super().__init__(hint, *args, **kwargs)

        self.summary = f"Error on '{key}'"

summary instance-attribute 

summary = f'Error on '{key}''

__init__ 

__init__(
    key,
    blockObj,
    *args,
    blockDict={},
    hint="Error for property: ",
    **kwargs
)
Source code in FoSpy/_errors.py 
43
44
45
46
47
48
49
50
51
52
def __init__(self, key, blockObj, *args, blockDict={}, hint="Error for property: ", **kwargs):
    typ_nm, block_id, id_key = _get_block_info(blockObj, blockDict)

    hint += f"'{key}' for '{typ_nm}' object."
    if block_id is not None:
        hint += f" (ID: {id_key} = {block_id})"

    super().__init__(hint, *args, **kwargs)

    self.summary = f"Error on '{key}'"

ListBlockErrorGroup 

ListBlockErrorGroup(blockObj, errors=[])
Source code in FoSpy/_errors.py 
161
162
163
def ListBlockErrorGroup(blockObj, errors=[]):
    typ_nm, _, _ = _get_block_info(blockObj)
    return MultipleListBlockErrors(f"Error(s) occurred when trying to construct or modify '{typ_nm}' object.", errors)

PropertyErrorGroup 

PropertyErrorGroup(blockObj, blockDict={}, errors=[])
Source code in FoSpy/_errors.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
def PropertyErrorGroup(blockObj, blockDict={}, errors=[]):
    typ_nm, block_id, id_key = _get_block_info(blockObj, blockDict)

    hint = f"Property Error(s) occurred when trying to construct '{typ_nm}' object."

    if block_id is not None:
        hint += f" (ID: {id_key} = {block_id})"

    hint += "\n\n===Summary===\n"
    for error in errors:
        hint += "\n".join(_summarize_exception_group(error)) + "\n"

    return MultiplePropertyErrors(hint, errors)

_get_block_info 

_get_block_info(blockObj, blockDict={})
Source code in FoSpy/_errors.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def _get_block_info(blockObj, blockDict={}):
    if isinstance(blockObj, type):
        typ = blockObj
    else:
        typ = type(blockObj)

    typ_nm = typ.__name__

    if hasattr(typ, "_id_key"):
        id_key = typ._id_key
        block_id = blockDict.get(id_key, None)
    else:
        id_key = None
        block_id = None

    return typ_nm, block_id, id_key

_summarize_exception_group 

_summarize_exception_group(exc, indent=0)

Return a list of summary lines for an ExceptionGroup or PropertyError.

Source code in FoSpy/_errors.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def _summarize_exception_group(exc: Exception, indent: int = 0) -> list[str]:
    """Return a list of summary lines for an ExceptionGroup or PropertyError."""
    pad = "  " * indent
    lines = []

    if hasattr(exc, "summary"):
        lines.append(f"{pad}{exc.summary}")
        indent += 1

    if hasattr(exc, "cause"):
        lines.extend(_summarize_exception_group(exc.cause, indent))

    elif isinstance(exc, ExceptionGroup):
        for e in exc.exceptions:
            lines.extend(_summarize_exception_group(e, indent))

    elif not hasattr(exc, "summary"):
        msg = exc.args[0].strip().split("\n",1)[0]
        msg = msg[:60] + "..." if len(msg) > 80 else msg
        lines.append(f"{pad}{msg}")

    return lines