zim.config.dicts.ConfigDefinition

class documentation

class ConfigDefinition(object): (source)

Known subclasses: zim.config.dicts.Boolean, zim.config.dicts.Choice, zim.config.dicts.ConfigDefinitionByClass, zim.config.dicts.Coordinate, zim.config.dicts.Float, zim.config.dicts.Integer, zim.config.dicts.String

View In Hierarchy

Definition for a key in a ConfigDict

Method	`__eq__`	Undocumented
Method	`__init__`	Undocumented
Method	`__ne__`	Undocumented
Method	`check`	No summary
Method	`tostring`	Undocumented
Class Variable	`__slots__`	Undocumented
Instance Variable	`allow_empty`	Undocumented
Instance Variable	`default`	Undocumented
Method	`_check_allow_empty`	Undocumented
Method	`_eval_string`	Undocumented

def __eq__(self, other): (source)

overridden in zim.config.dicts.Choice, zim.config.dicts.ConfigDefinitionByClass, zim.config.dicts.Range

Undocumented

def __init__(self, default, allow_empty=False): (source)

overridden in zim.config.dicts.Choice, zim.config.dicts.ConfigDefinitionByClass, zim.config.dicts.Coordinate, zim.config.dicts.Range, zim.config.dicts.String

Undocumented

def __ne__(self, other): (source)

Undocumented

def check(self, value): (source)

overridden in zim.config.dicts.Boolean, zim.config.dicts.Choice, zim.config.dicts.ConfigDefinitionByClass, zim.config.dicts.Coordinate, zim.config.dicts.Float, zim.config.dicts.Integer, zim.config.dicts.String

Check value to be a valid value for this key

Returns
(converted) value if valid
Raises
`ValueError`	if value is invalid and can not be converted

def tostring(self, value): (source)

overridden in zim.config.dicts.ConfigDefinitionByClass, zim.config.dicts.String

Undocumented

__slots__: tuple[str, ...] = (source)

overridden in zim.config.dicts.Choice, zim.config.dicts.ConfigDefinitionByClass, zim.config.dicts.Range

Undocumented

allow_empty = (source)

Undocumented

default = (source)

Undocumented

def _check_allow_empty(self, value): (source)

Undocumented

def _eval_string(self, value): (source)

Undocumented