File size: 2,494 Bytes
e18c302 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 | from __future__ import annotations
import logging
import fastjsonschema # type: ignore
from aws_lambda_powertools.utilities.validation.exceptions import InvalidSchemaFormatError, SchemaValidationError
logger = logging.getLogger(__name__)
def validate_data_against_schema(
data: dict | str,
schema: dict,
formats: dict | None = None,
handlers: dict | None = None,
provider_options: dict | None = None,
) -> dict | str:
"""Validate dict data against given JSON Schema
Parameters
----------
data : dict
Data set to be validated
schema : dict
JSON Schema to validate against
formats: dict
Custom formats containing a key (e.g. int64) and a value expressed as regex or callback returning bool
handlers: Dict
Custom methods to retrieve remote schemes, keyed off of URI scheme
provider_options: Dict
Arguments that will be passed directly to the underlying validation call, in this case fastjsonchema.validate.
For all supported arguments see: https://horejsek.github.io/python-fastjsonschema/#fastjsonschema.validate
Returns
-------
Dict
The validated event. If the schema specifies a `default` value for fields that are omitted,
those default values will be included in the response.
Raises
------
SchemaValidationError
When schema validation fails against data set
InvalidSchemaFormatError
When JSON schema provided is invalid
"""
try:
formats = formats or {}
handlers = handlers or {}
provider_options = provider_options or {}
return fastjsonschema.validate(
definition=schema,
data=data,
formats=formats,
handlers=handlers,
**provider_options,
)
except (TypeError, AttributeError, fastjsonschema.JsonSchemaDefinitionException) as e:
raise InvalidSchemaFormatError(f"Schema received: {schema}, Formats: {formats}. Error: {e}")
except fastjsonschema.JsonSchemaValueException as e:
message = f"Failed schema validation. Error: {e.message}, Path: {e.path}, Data: {e.value}" # noqa: B306
raise SchemaValidationError(
message,
validation_message=e.message, # noqa: B306
name=e.name,
path=e.path,
value=e.value,
definition=e.definition,
rule=e.rule,
rule_definition=e.rule_definition,
)
|