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

Class IsMember

source code

                 object --+    
                          |    
basevalidator.BaseValidator --+
                              |
                             IsMember

Only allow values of a particular set.

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 = IsMember([1, 2, 3])
>>> v(1)
1
>>> v(4)
Traceback (most recent call last):
...
ValueError: '4' is not a member of [1, 2, 3]
Instance Methods [hide private]
 
__init__(self, vocab)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
make_validation_error_msg(self, bad_val, err)
Generate an meaningful error message for a membership problem.
source code
 
validate_value(self, value)
Check a value is of the desired form.
source code

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

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_validation_error_msg(self, bad_val, err)

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

validate_value(self, value)

source code 

Check a value is of the desired form.

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

Parameters:
  • value - value to be checked
Returns:
success of validation.
Overrides: basevalidator.BaseValidator.validate_value
(inherited documentation)