Cant Modify Immutable Attribute Error¶

`cant_modify_immutable_attribute_error` ¶

Error raised when code attempts to mutate a frozen or immutable attribute.

Defines CantModifyImmutableAttributeError, raised when an attempt is made
to set or delete an attribute on a value object or entity that has been frozen
by @auto_freeze. Extends RuntimeErrorMixin and Error[str],
making it catchable as both RuntimeError and Exception.

`CantModifyImmutableAttributeError` ¶

Bases: RuntimeErrorMixin, Error[str]

Raised when there is an attempt to modify an immutable attribute of an object.

Example

error = CantModifyImmutableAttributeError(class_name="MyEntity", attribute_name="id")
raise error

Source code in src/forging_blocks/foundation/errors/cant_modify_immutable_attribute_error.py

class CantModifyImmutableAttributeError(RuntimeErrorMixin, Error[str]):
    """Raised when there is an attempt to modify an immutable attribute of an object.

    Example:
        ```python
        error = CantModifyImmutableAttributeError(class_name="MyEntity", attribute_name="id")
        raise error
        ```

    """

    def __init__(self, class_name: str, attribute_name: str):
        """Initialise the error with the class and attribute that triggered the violation.

        Args:
            class_name: Name of the class whose immutable attribute was targeted.
            attribute_name: Name of the attribute that was being modified.

        """
        message = ErrorMessage(
            f"Cannot modify immutable attribute '{attribute_name}' of class '{class_name}'."
        )
        super().__init__(
            message,
            ErrorMetadata({"class_name": class_name, "attribute_name": attribute_name}),
        )

`init(class_name: str, attribute_name: str)` ¶

Initialise the error with the class and attribute that triggered the violation.

Parameters:

Name	Type	Description	Default
`class_name`	`str`	Name of the class whose immutable attribute was targeted.	required
`attribute_name`	`str`	Name of the attribute that was being modified.	required

Source code in src/forging_blocks/foundation/errors/cant_modify_immutable_attribute_error.py

def __init__(self, class_name: str, attribute_name: str):
    """Initialise the error with the class and attribute that triggered the violation.

    Args:
        class_name: Name of the class whose immutable attribute was targeted.
        attribute_name: Name of the attribute that was being modified.

    """
    message = ErrorMessage(
        f"Cannot modify immutable attribute '{attribute_name}' of class '{class_name}'."
    )
    super().__init__(
        message,
        ErrorMetadata({"class_name": class_name, "attribute_name": attribute_name}),
    )

Cant Modify Immutable Attribute Error¶