fivalid is lightweight field data validator.
validation:
>>> from fivalid import validators
>>> num = validators.Number(max=20)
>>> num(10)
>>> num(21)
validators.InvalidValueError: over max
>>> strnum = validators.All(
... validators.Number(), validators.String())
>>> strnum('100')
>>> strnum(100)
validators.InvalidValueError: not same type
field value validation and conversion:
>>> from fivalid import BaseField, validators, converters
>>> class PercentageField(BaseField):
... validator = validators.All(
... validators.Number(min=0, max=100),
... validators.String())
... converter = converters.int_converter
>>> field = PercentageField()
>>> field('99')
99
>>> field('200')
fivalid.validators.InvalidValueError: over max
>>> input_data = {'lightness': '70'}
>>> lightness_field = PercentageField(empty_value='')
>>> lightness = lightness_field(input_data.get('lightness', ''))
>>> print lightness
70
>>> input_data2 = {}
>>> lightness = lightness_field(input_data2.get('lightness', ''))
>>> print lightness
None
data structure validation (same as the input data structure will be return, but all values are None. because it’s only for the purpose of validation):
>>> from fivalid import StructuredFields, Dict
>>> from fivalid.validators import String, Length, All, Flag
>>> rule = Dict(
... {'comment': All(String(), Length(max=500)),
... 'nickname': All(String(), Length(max=20)),
... 'remember me': Flag()}
... )
>>> data = {'comment': 'Hello, fivalid.',
... 'nickname': 'John Doe',
... 'remember me': '1'}
>>> stfields = StructuredFields(rule)
>>> stfields(data)
{'comment': None, 'nickname': None, 'remember me': None}
>>> StructuredFields.validate(data, rule) # same as
{'comment': None, 'nickname': None, 'remember me': None}
data structure validation and conversion:
>>> from fivalid import StructuredFields, Dict, BaseField
>>> from fivalid.validators import String, Length, All, Flag
>>> from fivalid.converters import truthvalue_converter
>>> class CommentField(BaseField):
... validator = All(String(), Length(max=500))
>>> class NicknameField(BaseField):
... validator = All(String(), Length(max=20))
>>> class RememberMeField(BaseField):
... validator = Flag()
... converter = truthvalue_converter
>>> rule = Dict(
... {'comment': CommentField(required=True),
... 'nickname': NicknameField(),
... 'remember me': RememberMeField()}
... )
>>> stfields = StructuredFields(rule)
>>> stfields({'comment': 'Hello, fivalid.',
... 'nickname': 'John Doe',
... 'remember me': '1'}
... )
{'comment': u'Hello, fivalid.', 'nickname': u'John Doe', 'remember me': True}
comparation of the validator:
>>> from fivalid.validators import Length, All, String
>>> assert Length(max=10) == Length(max=10)
>>> assert Length(max=10) != Length(min=4)
>>> assert All(Length(min=3), String()) == All(Length(min=3), String())
>>> assert All(Length(min=3), String()) != All(Length(min=1), String())
replace the validator and/or converter without inheritance:
>>> from fivalid.validators import Flag
>>> from fivalid.converters import truthvalue_converter
>>> from fivalid.fields import BaseField
>>> field = BaseField(validator=Flag(),
... converter=truthvalue_converter)
>>> field('1')
True
required flag is True and missing input value in field.
Error occurred while validation.
Get generator that exception stack trace info of validator.
This generator will generate info about the validator or the rule(subclass of StructureRule) that exception is raised.
The type of info is dict, and keys are:
Note
The info is generated in order from the caller.
| Returns: | Generator object. |
|---|
Value is invalid.
Subclass of validators.ValidationError
Value type is invalid.
Subclass of validators.ValidationError
Error occurred while value conversion.