Skip to content

Combined Errors

combined_errors

Base class for combining multiple errors into one.

Defines CombinedErrors which aggregates multiple Error instances into one.

CombinedErrors

Bases: Error[dict[str, object]]

Base class for combining multiple errors into one.

Source code in src/forging_blocks/foundation/errors/combined_errors.py 
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
class CombinedErrors[ErrorType: Error[dict[str, object]]](Error[dict[str, object]]):
    """Base class for combining multiple errors into one."""

    def __init__(self, errors: Iterable[ErrorType]) -> None:
        """Initialise with an iterable of errors to combine.

        Args:
            errors: The errors to aggregate. Stored internally as a
                tuple to preserve the original collection.
        """
        self._errors: Sequence[ErrorType] = tuple(errors)
        combined_message = f"{len(self._errors)} errors occurred."
        super().__init__(message=ErrorMessage(combined_message))

    def __repr__(self) -> str:
        """Return a concise string representation of the combined errors."""
        return f"<{self._get_title_prefix()} errors={len(self._errors)}>"

    def __str__(self) -> str:
        """Return a human-readable string representation of the combined errors."""
        error_details = "\n".join(f"- {str(error)}" for error in self._errors)
        return f"{self._get_title_prefix()}:\n{error_details}"

    def __iter__(self) -> Iterator[ErrorType]:
        """Iterate over the combined errors."""
        return iter(self._errors)

    def __len__(self) -> int:
        """Return the number of combined errors."""
        return len(self._errors)

    @property
    def errors(self) -> Sequence[ErrorType]:
        """The collection of combined errors."""
        return self._errors

    def as_debug_string(self) -> str:
        """Return a detailed, multi-line string for debugging, showing all contained errors."""
        error_strings = [
            f"    {e.as_debug_string().replace(chr(10), chr(10) + '    ')}" for e in self._errors
        ]
        return (
            f"{self._get_title_prefix()}(\n"
            f"  errors=[\n"
            + ("" if not error_strings else "\n".join(error_strings) + "\n")
            + "  ]\n"
            ")"
        )

    def _get_title_prefix(self) -> str:
        """Get the title prefix for this combined error type."""
        return self.__class__.__name__

errors: Sequence[ErrorType] property

The collection of combined errors.

__init__(errors: Iterable[ErrorType]) -> None

Initialise with an iterable of errors to combine.

Parameters:

Name Type Description Default
errors Iterable[ErrorType]

The errors to aggregate. Stored internally as a
tuple to preserve the original collection.

 required
Source code in src/forging_blocks/foundation/errors/combined_errors.py 
15
16
17
18
19
20
21
22
23
24
def __init__(self, errors: Iterable[ErrorType]) -> None:
    """Initialise with an iterable of errors to combine.

    Args:
        errors: The errors to aggregate. Stored internally as a
            tuple to preserve the original collection.
    """
    self._errors: Sequence[ErrorType] = tuple(errors)
    combined_message = f"{len(self._errors)} errors occurred."
    super().__init__(message=ErrorMessage(combined_message))

__repr__() -> str

Return a concise string representation of the combined errors.

Source code in src/forging_blocks/foundation/errors/combined_errors.py 
26
27
28
def __repr__(self) -> str:
    """Return a concise string representation of the combined errors."""
    return f"<{self._get_title_prefix()} errors={len(self._errors)}>"

__str__() -> str

Return a human-readable string representation of the combined errors.

Source code in src/forging_blocks/foundation/errors/combined_errors.py 
30
31
32
33
def __str__(self) -> str:
    """Return a human-readable string representation of the combined errors."""
    error_details = "\n".join(f"- {str(error)}" for error in self._errors)
    return f"{self._get_title_prefix()}:\n{error_details}"

__iter__() -> Iterator[ErrorType]

Iterate over the combined errors.

Source code in src/forging_blocks/foundation/errors/combined_errors.py 
35
36
37
def __iter__(self) -> Iterator[ErrorType]:
    """Iterate over the combined errors."""
    return iter(self._errors)

__len__() -> int

Return the number of combined errors.

Source code in src/forging_blocks/foundation/errors/combined_errors.py 
39
40
41
def __len__(self) -> int:
    """Return the number of combined errors."""
    return len(self._errors)

as_debug_string() -> str

Return a detailed, multi-line string for debugging, showing all contained errors.

Source code in src/forging_blocks/foundation/errors/combined_errors.py 
48
49
50
51
52
53
54
55
56
57
58
59
def as_debug_string(self) -> str:
    """Return a detailed, multi-line string for debugging, showing all contained errors."""
    error_strings = [
        f"    {e.as_debug_string().replace(chr(10), chr(10) + '    ')}" for e in self._errors
    ]
    return (
        f"{self._get_title_prefix()}(\n"
        f"  errors=[\n"
        + ("" if not error_strings else "\n".join(error_strings) + "\n")
        + "  ]\n"
        ")"
    )