Function validate

st2common/st2common/util/schema/__init__.py:403–435

Custom validate function which supports default arguments combined with the "required" property. Note: This function returns cleaned instance with default values assigned. :param use_default: True to support the use of the optional "default" property. :type use_default: ``bool

(
    instance,
    schema,
    cls=None,
    use_default=True,
    allow_default_none=False,
    *args,
    **kwargs,
)

def validate(
    instance,
    schema,
    cls=None,
    use_default=True,
    allow_default_none=False,
    *args,
    **kwargs,
):
    """
    Custom validate function which supports default arguments combined with the "required"
    property.

    Note: This function returns cleaned instance with default values assigned.

    :param use_default: True to support the use of the optional "default" property.
    :type use_default: ``bool``
    """
    instance = fast_deepcopy_dict(instance)
    schema_type = schema.get("type", None)
    instance_is_dict = isinstance(instance, dict)

    if use_default and allow_default_none:
        schema = modify_schema_allow_default_none(schema=schema)

    # TODO: expand default handling to more than just objects
    if use_default and schema_type == "object" and instance_is_dict:
        instance = assign_default_values(instance=instance, schema=schema)

    # pylint: disable=assignment-from-no-return
    jsonschema.validate(instance=instance, schema=schema, cls=cls, *args, **kwargs)

    return instance


VALIDATORS = {"draft4": jsonschema.Draft4Validator, "custom": CustomValidator}