Back to Prefect

validation

docs/v3/api-ref/python/prefect-utilities-schema_tools-validation.mdx

3.6.30.dev32.9 KB
Original Source

prefect.utilities.schema_tools.validation

Functions

is_valid_schema <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/validation.py#L65" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
is_valid_schema(schema: ObjectSchema, preprocess: bool = True) -> None

validate <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/validation.py#L74" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
validate(obj: dict[str, Any], schema: ObjectSchema, raise_on_error: bool = False, preprocess: bool = True, ignore_required: bool = False, allow_none_with_default: bool = False) -> list[JSONSchemaValidationError]

is_valid <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/validation.py#L112" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
is_valid(obj: dict[str, Any], schema: ObjectSchema) -> bool

prioritize_placeholder_errors <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/validation.py#L117" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
prioritize_placeholder_errors(errors: list[JSONSchemaValidationError]) -> list[JSONSchemaValidationError]

build_error_obj <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/validation.py#L141" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
build_error_obj(errors: list[JSONSchemaValidationError]) -> dict[str, Any]

process_properties <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/validation.py#L232" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
process_properties(properties: dict[str, dict[str, Any]], required_fields: list[str], allow_none_with_default: bool = False) -> None

preprocess_schema <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/validation.py#L246" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
preprocess_schema(schema: ObjectSchema, allow_none_with_default: bool = False) -> ObjectSchema

Classes

CircularSchemaRefError <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/validation.py#L18" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

ValidationError <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/schema_tools/validation.py#L22" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>