jsonvalidate package

Submodules

jsonvalidate.jsonvalidate module

jsonvalidate.jsonvalidate

Module that provides a helper classes for defining schema and validation for json

class jsonvalidate.jsonvalidate.BooleanContract(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.Type

class jsonvalidate.jsonvalidate.Contract(*args, **kwargs)

Bases: object

Abstract Base class for both primitives types

check(*args)

last method in MRO chain that will eventually return false as an error

class jsonvalidate.jsonvalidate.EnumContract(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.Contract

check(val)

last method in MRO chain that will eventually return false as an error

class jsonvalidate.jsonvalidate.EnumError(actual, enums)

Bases: jsonvalidate.jsonvalidate.Error

A class that represents enum invalidation error

class jsonvalidate.jsonvalidate.Error

Bases: object

Base class that is subclassed by Concrete error types.

todict()

Converts python object to serializable dictionary.

class jsonvalidate.jsonvalidate.FloatContract(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.Type

Type Contract for Float

class jsonvalidate.jsonvalidate.IntegerContract(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.Type

Type Contract for Integer

class jsonvalidate.jsonvalidate.KeyMissingContract(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.Contract

check(val)

Checks for key mismatch

class jsonvalidate.jsonvalidate.KeyMissingError

Bases: jsonvalidate.jsonvalidate.Error

A class that represents key mismatch error

class jsonvalidate.jsonvalidate.LengthContract(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.Contract

check(val)

last method in MRO chain that will eventually return false as an error

class jsonvalidate.jsonvalidate.LengthError(actual_length=None, expected_min_length=None, expected_max_length=None)

Bases: jsonvalidate.jsonvalidate.Error

A class that represents length invalidation error

class jsonvalidate.jsonvalidate.List(object_shape)

Bases: jsonvalidate.jsonvalidate.Contract

check(value)

last method in MRO chain that will eventually return false as an error

class jsonvalidate.jsonvalidate.NullContract(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.Contract

A Null Contract class that implements check method for nullable value

check(val)

Checks if the value is null and delegate the method call to next method in MRO

class jsonvalidate.jsonvalidate.NullError

Bases: jsonvalidate.jsonvalidate.Error

A class that represents null error

class jsonvalidate.jsonvalidate.Object(object_shape)

Bases: jsonvalidate.jsonvalidate.Contract

check(value)

last method in MRO chain that will eventually return false as an error

class jsonvalidate.jsonvalidate.RangeContract(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.Contract

Applicable to Integer

check(val)

last method in MRO chain that will eventually return false as an error

class jsonvalidate.jsonvalidate.RangeError(actual_val, valid_range)

Bases: jsonvalidate.jsonvalidate.Error

A subclass of error for range validation

class jsonvalidate.jsonvalidate.RegExContract(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.Contract

check(val)

Checks if the value match regex and delegate the method call to next method in MRO

class jsonvalidate.jsonvalidate.RegExError

Bases: jsonvalidate.jsonvalidate.Error

A class that represents regex error

class jsonvalidate.jsonvalidate.StringContract(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.Type

Type Contract for String

class jsonvalidate.jsonvalidate.Type(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.Contract

Abstract Base class for Type validation

check(val)

Checks for type mismatch.

jsonvalidate.jsonvalidate.err(error)

Utility function for returning serializable json payload.

Module contents

Top-level package for jsonvalidate.

class jsonvalidate.String(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.KeyMissingContract, jsonvalidate.jsonvalidate.NullContract, jsonvalidate.jsonvalidate.StringContract, jsonvalidate.jsonvalidate.RegExContract, jsonvalidate.jsonvalidate.LengthContract, jsonvalidate.jsonvalidate.EnumContract

Composition/Mixins for String

class jsonvalidate.Integer(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.KeyMissingContract, jsonvalidate.jsonvalidate.NullContract, jsonvalidate.jsonvalidate.IntegerContract, jsonvalidate.jsonvalidate.RangeContract, jsonvalidate.jsonvalidate.EnumContract

Composition/Mixins for Integer

class jsonvalidate.Float(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.KeyMissingContract, jsonvalidate.jsonvalidate.NullContract, jsonvalidate.jsonvalidate.FloatContract, jsonvalidate.jsonvalidate.RangeContract, jsonvalidate.jsonvalidate.EnumContract

Composition/Mixins for Float

class jsonvalidate.Boolean(*args, **kwargs)

Bases: jsonvalidate.jsonvalidate.KeyMissingContract, jsonvalidate.jsonvalidate.NullContract, jsonvalidate.jsonvalidate.BooleanContract

Composition/Mixins for Boolean

class jsonvalidate.Object(object_shape)

Bases: jsonvalidate.jsonvalidate.Contract

check(value)

last method in MRO chain that will eventually return false as an error

class jsonvalidate.List(object_shape)

Bases: jsonvalidate.jsonvalidate.Contract

check(value)

last method in MRO chain that will eventually return false as an error