Module pedantic.decorators.fn_deco_validate.exceptions

Classes

class ConversionError (msg: str)

Is raised if a type cast failed.

Expand source code

class ConversionError(ValidateException):
    """ Is raised if a type cast failed. """

Ancestors

• ValidateException
• builtins.Exception
• builtins.BaseException

class ExceptionDictKey

Expand source code

class ExceptionDictKey:
    VALUE = 'VALUE'
    MESSAGE = 'MESSAGE'
    PARAMETER = 'PARAMETER'
    VALIDATOR = 'VALIDATOR'

Class variables

var MESSAGE

var PARAMETER

var VALIDATOR

var VALUE

class InvalidHeader (msg: str, parameter_name: str, value: Optional[Any] = None, validator_name: Optional[str] = None)

Is raised if there is a validation error in a FlaskHeaderParameter.

Expand source code

class InvalidHeader(ParameterException):
    """ Is raised if there is a validation error in a FlaskHeaderParameter. """

Ancestors

• ParameterException
• ValidateException
• builtins.Exception
• builtins.BaseException

Inherited members

• ParameterException:
  • from_validator_exception

class ParameterException (msg: str, parameter_name: str, value: Optional[Any] = None, validator_name: Optional[str] = None)

An exception that is raised inside a Parameter.

Expand source code

class ParameterException(ValidateException):
    """ An exception that is raised inside a Parameter. """

    def __init__(self, msg: str, parameter_name: str,
                 value: Optional[Any] = None, validator_name: Optional[str] = None) -> None:
        super().__init__(msg=msg)
        self.validator_name = validator_name
        self.parameter_name = parameter_name
        self.value = value

    @classmethod
    def from_validator_exception(cls, exception: ValidatorException, parameter_name: str = '') -> 'ParameterException':
        """ Creates a parameter exception from a validator exception. """
        return cls(
            value=exception.value,
            msg=exception.message,
            validator_name=exception.validator_name,
            parameter_name=parameter_name or exception.parameter_name,
        )

    def __str__(self) -> str:
        return str(self.to_dict)

    @property
    def to_dict(self) -> Dict[str, str]:
        return {
            ExceptionDictKey.VALUE: str(self.value),
            ExceptionDictKey.MESSAGE: self.message,
            ExceptionDictKey.VALIDATOR: self.validator_name,
            ExceptionDictKey.PARAMETER: self.parameter_name,
        }

Ancestors

• ValidateException
• builtins.Exception
• builtins.BaseException

Subclasses

• InvalidHeader

Static methods

def from_validator_exception(exception: ValidatorException, parameter_name: str = '') ‑> ParameterException

Creates a parameter exception from a validator exception.

Expand source code

@classmethod
def from_validator_exception(cls, exception: ValidatorException, parameter_name: str = '') -> 'ParameterException':
    """ Creates a parameter exception from a validator exception. """
    return cls(
        value=exception.value,
        msg=exception.message,
        validator_name=exception.validator_name,
        parameter_name=parameter_name or exception.parameter_name,
    )

Instance variables

var to_dict : Dict[str, str]

Expand source code

@property
def to_dict(self) -> Dict[str, str]:
    return {
        ExceptionDictKey.VALUE: str(self.value),
        ExceptionDictKey.MESSAGE: self.message,
        ExceptionDictKey.VALIDATOR: self.validator_name,
        ExceptionDictKey.PARAMETER: self.parameter_name,
    }

class TooManyArguments (msg: str)

Is raised if the function got more arguments than expected.

Expand source code

class TooManyArguments(ValidateException):
    """ Is raised if the function got more arguments than expected. """

Ancestors

• ValidateException
• builtins.Exception
• builtins.BaseException

class ValidateException (msg: str)

The base class for all exception thrown by the validate decorator.

Expand source code

class ValidateException(Exception):
    """ The base class for all exception thrown by the validate decorator. """

    def __init__(self, msg: str) -> None:
        self.message = msg

Ancestors

• builtins.Exception
• builtins.BaseException

Subclasses

• ConversionError
• ParameterException
• TooManyArguments
• ValidatorException

class ValidatorException (msg: str, validator_name: str, value: Any, parameter_name: str = '')

An exception that is raised inside the validate() function of a Validator.

Expand source code

class ValidatorException(ValidateException):
    """ An exception that is raised inside the validate() function of a Validator. """

    def __init__(self, msg: str, validator_name: str, value: Any, parameter_name: str = '') -> None:
        super().__init__(msg=msg)
        self.validator_name = validator_name
        self.value = value
        self.parameter_name = parameter_name

    def __str__(self) -> str:
        return f'{self.validator_name}: {self.message} Value: {self.value}'

Ancestors

• ValidateException
• builtins.Exception
• builtins.BaseException