yawning_titan.config.item_types.str_item

Classes

StrItem	The bool config item.
StrProperties	The BoolProperties class holds the properties relevant for defining and validating a bool value.

class yawning_titan.config.item_types.str_item.StrProperties(_allowed_types=None, allow_null=None, default=None, options=None)

The BoolProperties class holds the properties relevant for defining and validating a bool value.

allow_null = None

True if the config value can be left empty, otherwise False.

default = None

The default value.

options = None

A list of allowed values for the item.

__init__(_allowed_types=None, allow_null=None, default=None, options=None)

validate(val)

Validates a bool against the properties set in BoolProperties.

Parameters:

val – A bool to be validated.

Returns:

An instance of config_toolbox.config.types.ValueValidation.

Raise:

config_toolbox.exceptions.ValidationError when validation fails.

class yawning_titan.config.item_types.str_item.StrItem(value, doc=None, alias=None, depends_on=None, properties=None)

The bool config item.

__init__(value, doc=None, alias=None, depends_on=None, properties=None)