validictory module

validate

validictory.validate(data, schema, validator_cls=<class 'validictory.validator.SchemaValidator'>, format_validators=None, required_by_default=True, blank_by_default=False)

Validates a parsed json document against the provided schema. If an error is found a ValidationError is raised.

If there is an issue in the schema a SchemaError will be raised.

Parameters:

• data – python data to validate
• schema – python dictionary representing the schema (see `schema format`_)
• validator_cls – optional validator class (default is SchemaValidator)
• format_validators – optional dictionary of custom format validators
• required_by_default – defaults to True, set to False to make required schema attribute False by default.

SchemaValidator

class validictory.SchemaValidator(format_validators=None, required_by_default=True, blank_by_default=False)

Validator largely based upon the JSON Schema proposal but useful for validating arbitrary python data structures.

Parameters:

• format_validators – optional dictionary of custom format validators
• required_by_default – defaults to True, set to False to make required schema attribute False by default.
• blank_by_default – defaults to False, set to True to make blank schema attribute True by default.

Exceptions

class validictory.ValidationError

validation errors encountered during validation (subclass of ValueError)

class validictory.SchemaError

errors encountered in processing a schema (subclass of ValueError)