aiida_gulp.validation package

Subpackages

• aiida_gulp.validation.schemas package
  • Module contents

Submodules

aiida_gulp.validation.utils module

Utility functions for validating JSON objects against schemas.

aiida_gulp.validation.utils.load_schema(name)

Read and return a JSON schema.

If the name is an absolute path, it will be used as is, otherwise it will be loaded as resource from the internal json schema module.

Parameters

name (str) –

Returns

Return type

dict

aiida_gulp.validation.utils.load_validator(schema)

Create a validator for a schema.

Parameters

schema (str or dict) – schema or path to schema

Returns

the validator to use

Return type

jsonschema.IValidator

aiida_gulp.validation.utils.validate_against_schema(data, schema)

Validate json-type data against a schema.

Parameters

• data (dict) –

• schema (dict or str) – schema, name of schema resource, or absolute path to a schema

Raises

• jsonschema.exceptions.SchemaError – if the schema is invalid

• jsonschema.exceptions.ValidationError – if the instance is invalid

Returns

return True if validated

Return type

bool

Module contents

Package for validating JSON objects against schemas.