Package konval :: Module containerval :: Class ToIndex
[hide private]
[frames] | no frames]

Class ToIndex

source code

                 object --+    
                          |    
basevalidator.BaseValidator --+
                              |
                             ToIndex

Convert to the index of the

Length limitations are expressed as (inclusive) minimum and maximum sizes. This is most useful for strings, but could be used for lists.

For example:

>>> v = ToIndex(['a', 'b', 'c'])
>>> v('a')
0
>>> v('d')
Traceback (most recent call last):
...
ValueError: 'd' is not a member of ['a', 'b', 'c']
Instance Methods [hide private]
 
__init__(self, vocab)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
make_conversion_error_msg(self, bad_val, err)
Generate an meaningful error message for a membership problem.
source code
 
convert_value(self, value)
Transform a value to the desired form.
source code

Inherited from basevalidator.BaseValidator: __call__, convert, 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, vocab)
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Overrides: object.__init__
(inherited documentation)

make_conversion_error_msg(self, bad_val, err)

source code 
Generate an meaningful error message for a membership problem.
Overrides: basevalidator.BaseValidator.make_conversion_error_msg

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)