Exceptions: Python

Exception classes used throughout Guardrails for SDK and model errors.

GuardrailException

Bases: Exception

Base class for exceptions thrown by :mod:guardrails.

Source code in src/mendguardrails/exceptions.py

class GuardrailException(Exception):
    """Base class for exceptions thrown by :mod:`guardrails`."""

UserError

Bases: GuardrailException

Error raised when the user misuses the SDK.

Source code in src/mendguardrails/exceptions.py

class UserError(GuardrailException):
    """Error raised when the user misuses the SDK."""

    message: str

    def __init__(self, message: str):
        """Initialize the exception with a human readable message."""
        super().__init__(message)
        self.message = message

__init__

__init__(message: str)

Initialize the exception with a human readable message.

Source code in src/mendguardrails/exceptions.py

def __init__(self, message: str):
    """Initialize the exception with a human readable message."""
    super().__init__(message)
    self.message = message

ModelBehaviorError

Bases: GuardrailException

Error raised when the model returns malformed or invalid data.

Source code in src/mendguardrails/exceptions.py

class ModelBehaviorError(GuardrailException):
    """Error raised when the model returns malformed or invalid data."""

    message: str

    def __init__(self, message: str):
        """Initialize with information on the misbehaviour."""
        super().__init__(message)
        self.message = message

__init__

__init__(message: str)

Initialize with information on the misbehaviour.

Source code in src/mendguardrails/exceptions.py

def __init__(self, message: str):
    """Initialize with information on the misbehaviour."""
    super().__init__(message)
    self.message = message

GuardrailEnforcementTriggered

Bases: GuardrailException

Raised when a guardrail triggers enforcement.

Source code in src/mendguardrails/exceptions.py

class GuardrailEnforcementTriggered(GuardrailException):
    """Raised when a guardrail triggers enforcement."""

    guardrail_result: "GuardrailResult"
    """The result data from the triggering guardrail."""

    def __init__(self, guardrail_result: "GuardrailResult"):
        """Initialize storing the result which caused the enforcement."""
        self.guardrail_result = guardrail_result
        super().__init__(
            f"Guardrail {self.guardrail_name} triggered enforcement",
        )

    @property
    def guardrail_name(self) -> str:
        """Registered name of the guardrail that triggered enforcement."""
        return _guardrail_name_from_result(self.guardrail_result)

guardrail_result instance-attribute

guardrail_result: GuardrailResult = guardrail_result

The result data from the triggering guardrail.

guardrail_name property

guardrail_name: str

Registered name of the guardrail that triggered enforcement.

__init__

__init__(guardrail_result: GuardrailResult)

Initialize storing the result which caused the enforcement.

Source code in src/mendguardrails/exceptions.py

def __init__(self, guardrail_result: "GuardrailResult"):
    """Initialize storing the result which caused the enforcement."""
    self.guardrail_result = guardrail_result
    super().__init__(
        f"Guardrail {self.guardrail_name} triggered enforcement",
    )

ConfigError

Bases: GuardrailException

Configuration bundle could not be loaded or validated.

Source code in src/mendguardrails/exceptions.py

class ConfigError(GuardrailException):
    """Configuration bundle could not be loaded or validated."""

    def __init__(self, message: str):
        """Initialize with a short description of the failure."""
        super().__init__(message)
        self.message = message

__init__

__init__(message: str)

Initialize with a short description of the failure.

Source code in src/mendguardrails/exceptions.py

def __init__(self, message: str):
    """Initialize with a short description of the failure."""
    super().__init__(message)
    self.message = message

ContextValidationError

Bases: GuardrailException

Raised when CLI context fails to match guardrail specification.

Source code in src/mendguardrails/exceptions.py

class ContextValidationError(GuardrailException):
    """Raised when CLI context fails to match guardrail specification."""

    def __init__(self, message: str):
        """Initialize with details about the schema mismatch."""
        super().__init__(message)
        self.message = message

__init__

__init__(message: str)

Initialize with details about the schema mismatch.

Source code in src/mendguardrails/exceptions.py

def __init__(self, message: str):
    """Initialize with details about the schema mismatch."""
    super().__init__(message)
    self.message = message