API Reference
- Overview
- Settings reference
- REST API
- CLI Reference
- Python SDK Reference
- artifacts
- automations
- cache_policies
- context
- engine
- exceptions
- filesystems
- flow_engine
- flow_runs
- flows
- futures
- main
- plugins
- results
- schedules
- serializers
- states
- task_engine
- task_runners
- task_runs
- task_worker
- tasks
- transactions
- variables
- prefect.assets
- prefect.blocks
- prefect.cli
- prefect.client
- prefect.concurrency
- prefect.deployments
- prefect.docker
- prefect.events
- prefect.infrastructure
- prefect.input
- prefect.locking
- prefect.logging
- prefect.runner
- prefect.runtime
- prefect.server
- prefect.settings
- prefect.telemetry
- prefect.testing
- prefect.types
- prefect.utilities
- prefect.workers
schema_tools
validation
prefect.utilities.schema_tools.validation
Functions
is_valid_schema
Copy
is_valid_schema(schema: ObjectSchema, preprocess: bool = True) -> None
validate
Copy
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
Copy
is_valid(obj: dict[str, Any], schema: ObjectSchema) -> bool
prioritize_placeholder_errors
Copy
prioritize_placeholder_errors(errors: list[JSONSchemaValidationError]) -> list[JSONSchemaValidationError]
build_error_obj
Copy
build_error_obj(errors: list[JSONSchemaValidationError]) -> dict[str, Any]
process_properties
Copy
process_properties(properties: dict[str, dict[str, Any]], required_fields: list[str], allow_none_with_default: bool = False) -> None
preprocess_schema
Copy
preprocess_schema(schema: ObjectSchema, allow_none_with_default: bool = False) -> ObjectSchema
Classes
CircularSchemaRefError
ValidationError
Assistant
Responses are generated using AI and may contain mistakes.