zim.config.dicts.String

class documentation

class String(ConfigDefinition): (source)

Known subclasses: zim.config.dicts.StringAllowEmpty

View In Hierarchy

This class defines a config key that maps to a string
Method __init__ Undocumented
Method check No summary
Method tostring Undocumented

Inherited from ConfigDefinition:

Method __eq__ Undocumented
Method __ne__ Undocumented
Class Variable __slots__ Undocumented
Instance Variable allow_empty Undocumented
Instance Variable default Undocumented
Method _check_allow_empty Undocumented
Method _eval_string Undocumented
def __init__(self, default, allow_empty=False): (source)
overrides zim.config.dicts.ConfigDefinition.__init__
overridden in zim.config.dicts.StringAllowEmpty

Undocumented

def check(self, value): (source)
overrides zim.config.dicts.ConfigDefinition.check
Check value to be a valid value for this key
Returns
(converted) value if valid
Raises
ValueErrorif value is invalid and can not be converted
def tostring(self, value): (source)
overrides zim.config.dicts.ConfigDefinition.tostring

Undocumented