JSON Schema Validator¶

Errors module¶

Error classes used by this package.

exception json_schema_validator.errors.SchemaError¶

Exception raised when there is a problem with the schema itself.

exception json_schema_validator.errors.ValidationError(message, new_message=None, object_expr=None, schema_expr=None)¶

Exception raised on mismatch between the validated object and the schema.

message¶

Old and verbose message that contains less helpful message and lots of JSON data (deprecated).

new_message¶

Short and concise message about the problem.

object_expr¶

A JavaScript expression that evaluates to the object that failed to validate. The expression always starts with a root object called 'object'.

schema_expr¶

A JavaScript expression that evaluates to the schema that was checked at the time validation failed. The expression always starts with a root object called 'schema'.

Misc module¶

Stuff that does not belong anywhere else

Schema module¶

Helper module to work with raw JSON Schema

class json_schema_validator.schema.Schema(json_obj)¶

JSON schema object

enum¶

Enumeration of possible correct values.

Must be either None or a non-empty list of valid objects. The list must not contain duplicate elements.

pattern¶

Note

JSON schema specifications says that this value SHOULD follow the EMCA 262/Perl 5 format. We cannot support this so we support python regular expressions instead. This is still valid but should be noted for clarity.

:returns None or compiled regular expression

properties¶

The properties property contains schema for each property in a dictionary.

The dictionary name is the property name. The dictionary value is the schema object itself.

type¶

Return the ‘type’ property of this schema.

The return value is always a list of correct JSON types. Correct JSON types are one of the pre-defined simple types or another schema object.

List of built-in simple types: * ‘string’ * ‘number’ * ‘integer’ * ‘boolean’ * ‘object’ * ‘array’ * ‘any’ (default)

Shortcuts module¶

One liners that make the code shorter

json_schema_validator.shortcuts.validate(schema_text, data_text)¶

Validate specified JSON text (data_text) with specified schema (schema text). Both are converted to JSON objects with simplesjon.loads().

Parameters:	schema_text (str) – Text of the JSON schema to check against data_text (str) – Text of the JSON object to check
Returns:	Same as json_schema_validator.validator.Validator.validate()
Raises:	Whatever may be raised by simplejson (in particular simplejson.decoder.JSONDecoderError, a subclass of ValueError)
Raises:	Whatever may be raised by json_schema_validator.validator.Validator.validate(). In particular json_schema_validator.errors.ValidationError and json_schema_validator.errors.SchemaError

Validator module¶

Validator implementation

class json_schema_validator.validator.Validator¶

JSON Schema validator.

Can be used to validate any JSON document against a json_schema_validator.schema.Schema.

classmethod validate(schema, obj)¶

Validate specified JSON object obj with specified Schema instance schema.

Parameters:	schema (json_schema_validator.schema.Schema) – Schema to validate against obj – JSON object to validate
Return type:	bool
Returns:	True on success
Raises:	json_schema_validator.errors.ValidationError – if the object does not match schema. json_schema_validator.errors.SchemaError – if the schema itself is wrong.