Types#

exception model_api.models.types.ConfigurableValueError(message, prefix=None)#

Bases: ValueError

class model_api.models.types.BaseValue(description='No description available', default_value=None)#

Bases: object

build_error()#
Return type:

None

get_value(value)#
update_default_value(default_value)#
validate(value)#
class model_api.models.types.BooleanValue(**kwargs)#

Bases: BaseValue

from_str(value)#
Return type:

bool | None

validate(value)#
class model_api.models.types.DictValue(**kwargs)#

Bases: BaseValue

from_str(value)#
validate(value)#
class model_api.models.types.ListValue(value_type=None, description='No description available', default_value=[])#

Bases: BaseValue

from_str(value)#
Return type:

list[Any] | None

validate(value)#
class model_api.models.types.NumericalValue(value_type=<class 'float'>, choices=(), min=None, max=None, **kwargs)#

Bases: BaseValue

from_str(value)#
Return type:

Any

validate(value)#
class model_api.models.types.StringValue(choices=(), description='No description available', default_value='')#

Bases: BaseValue

from_str(value)#
Return type:

str | None

validate(value)#
model_api.models.types.get_python_type(base_value)#

Helper function that extracts the corresponding Python type from a BaseValue instance.

Parameters:

base_value (BaseValue) – An instance of BaseValue or its subclass

Return type:

type | type[Any]

Returns:

The corresponding Python type (int, float, bool, str, list, dict, or object)