Package konval :: Module vocabval :: Class Synonyms

Class Synonyms

                 object --+    
                          |    
basevalidator.BaseValidator --+
                              |
                             Synonyms

Known Subclasses:

typeval.StrToBool

Map values to other values.

Note that this does not explicitly throw errors. If a value is un-mapped, it is simply returned.

Instance Methods

[hide private]

__init__(self, d)
For example:

source code

convert_value(self, value)
Transform a value to the desired form.

source code

Inherited from basevalidator.BaseValidator: __call__, convert, make_conversion_error_msg, make_validation_error_msg, raise_conversion_error, raise_validation_error, validate, validate_value

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, d)
(Constructor)

source code

For example:

>>> d = {'foo': 1, 'bar': 2}
>>> v = Synonyms(d)
>>> v('foo')
1
>>> v('quux')
'quux'

Parameters:

d - a dictionary mapping input values to output values

Returns:

the mapped value or the original is no mapping available

Overrides: object.__init__

convert_value(self, value)

source code

Transform a value to the desired form.

This is the workhorse method that is called by convert to transform passed values. As such, errors are signalled by throwing a meaningful exception. This is one of the obvious and easiest places to customize behaviour by overriding in a subclass.

Parameters:

value - value to be transformed

Returns:

the transformed value

Overrides: basevalidator.BaseValidator.convert_value

(inherited documentation)

Class Synonyms

__init__(self, d) (Constructor)

convert_value(self, value)

init(self, d)
(Constructor)