Options Framework Errors¶
consortium.framework._core.framework_exceptions.options_framework_exceptions
¶
OptionsFrameworkError(message='', detail=None)
¶
Bases: BaseFrameworkError
Base exception for all errors that occur within the options framework.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
OptionValueValidationError(message, detail=None)
¶
Bases: OptionsFrameworkError
Raised when a provided value for an option fails data validation when setting the
value through the option's set_option_value() method or when explicitly validating
the value through the option's validate_option_value() method.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
OptionConfigurationError(message='', detail=None)
¶
Bases: OptionsFrameworkError
Base exception for all errors that occur during the configuration of a particular option.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
InvalidOptionConfigurationParameterTypeError(option_str, parameter_name=None, parameter_type=None, error_message=None)
¶
Bases: OptionConfigurationError
Raised when a parameter provided to configure an option is not of the expected type during option configuration.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
EmptyOptionNameError(option_filepath)
¶
Bases: OptionConfigurationError
Raised when an empty name is provided for an option during option configuration.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
InvalidDefaultValueError(option_name, default_value, option_value_validation_error_message)
¶
Bases: OptionConfigurationError
Raised when the default value provided to an option through its default_value
parameter fails data validation through the option's validate_value() method
during option configuration.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
InvalidValidatingRegexError(option_name, validating_regex, regex_error_message)
¶
Bases: OptionConfigurationError
Raised when the validating_regex regex string provided for validating an option's
value is not a valid regex pattern that can be compiled during option configuration.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
InvalidOptionValueLengthRangeError(option_name, minimum_length, maximum_length)
¶
Bases: OptionConfigurationError
Raised when the minimum_length parameter provided for an option is greater than
the maximum_length parameter, resulting in an invalid range of string value
lengths during option configuration.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
InvalidOptionValueLengthBoundError(option_name, length_bound_parameter_name, length_bound)
¶
Bases: OptionConfigurationError
Raised when the minimum_length or maximum_length parameter provided for an
option specifying the max_length of the string value is less than zero during option
configuration.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
InvalidOptionValueRangeError(option_name, minimum_range_parameter_name, maximum_range_parameter_name, minimum_range, maximum_range)
¶
Bases: OptionConfigurationError
Raised when the less_than or less_than_or_equal_to parameter provided for an
option is greater than the greater_than or greater_than_or_equal_to parameter,
resulting in an invalid range of numeric values during option configuration.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
InvalidOptionIterableLengthRangeError(option_name, minimum_elements, maximum_elements)
¶
Bases: OptionConfigurationError
Raised when the minimum_elements parameter provided for an option is greater than
the maximum_elements parameter, resulting in an invalid range of iterable element
counts during option configuration.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
InvalidOptionIterableLengthBoundError(option_name, length_bound_parameter_name, length_bound)
¶
Bases: OptionConfigurationError
Raised when the minimum_elements or maximum_elements parameter provided for an
option specifying the number of elements in the iterable value is less than zero
during option configuration.
code = 'BASE_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
EmptyAvailableValuesError(option_name)
¶
Bases: OptionConfigurationError
Raised when the set of available values provided through the available_values
parameter is empty during option configuration.