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
  - __init__
  - annotations
  - asyncutils
  - callables
  - collections
  - compat
  - context
  - dispatch
  - dockerutils
  - engine
  - filesystem
  - generics
  - hashing
  - importtools
  - math
  - names
  - processutils
  - pydantic
  - render_swagger
  - schema_tools
    - __init__
    - hydration
    - validation
  - services
  - slugify
  - templating
  - text
  - timeout
  - urls
  - visualization
- prefect.workers

On this page

prefect.utilities.schema_tools.hydration
Functions
handler
call_handler
null_handler
json_handler
jinja_handler
workspace_variable_handler
hydrate
Classes
HydrationContext
build
Placeholder
is_error
RemoveValue
is_error
HydrationError
is_error
is_error
message
KeyNotFound
is_error
key
message
message
ValueNotFound
key
key
message
TemplateNotFound
key
key
message
VariableNameNotFound
key
key
message
InvalidJSON
is_error
message
message
InvalidJinja
is_error
message
message
WorkspaceVariableNotFound
is_error
message
message
variable_name
WorkspaceVariable
is_error
ValidJinja
is_error

`prefect.utilities.schema_tools.hydration`

Functions

`handler`

handler(kind: PrefectKind) -> Callable[[Handler], Handler]

`call_handler`

call_handler(kind: PrefectKind, obj: dict[str, Any], ctx: HydrationContext) -> Any

`null_handler`

null_handler(obj: dict[str, Any], ctx: HydrationContext)

`json_handler`

json_handler(obj: dict[str, Any], ctx: HydrationContext)

`jinja_handler`

jinja_handler(obj: dict[str, Any], ctx: HydrationContext) -> Any

`workspace_variable_handler`

workspace_variable_handler(obj: dict[str, Any], ctx: HydrationContext) -> Any

`hydrate`

hydrate(obj: dict[str, Any], ctx: Optional[HydrationContext] = None) -> dict[str, Any]

Classes

`HydrationContext`

Methods:

`build`

build(cls, session: AsyncSession, raise_on_error: bool = False, render_jinja: bool = False, render_workspace_variables: bool = False) -> Self

`Placeholder`

Methods:

`is_error`

is_error(self) -> bool

`RemoveValue`

Methods:

`is_error`

is_error(self) -> bool

`HydrationError`

Methods:

`is_error`

is_error(self) -> bool

`is_error`

is_error(self) -> bool

`message`

message(self) -> str

`KeyNotFound`

Methods:

`is_error`

is_error(self) -> bool

`key`

key(self) -> str

`message`

message(self) -> str

`message`

message(self) -> str

`ValueNotFound`

Methods:

`key`

key(self) -> str

`key`

key(self) -> str

`message`

message(self) -> str

`TemplateNotFound`

Methods:

`key`

key(self) -> str

`key`

key(self) -> str

`message`

message(self) -> str

`VariableNameNotFound`

Methods:

`key`

key(self) -> str

`key`

key(self) -> str

`message`

message(self) -> str

`InvalidJSON`

Methods:

`is_error`

is_error(self) -> bool

`message`

message(self) -> str

`message`

message(self) -> str

`InvalidJinja`

Methods:

`is_error`

is_error(self) -> bool

`message`

message(self) -> str

`message`

message(self) -> str

`WorkspaceVariableNotFound`

Methods:

`is_error`

is_error(self) -> bool

`message`

message(self) -> str

`message`

message(self) -> str

`variable_name`

variable_name(self) -> str

`WorkspaceVariable`

Methods:

`is_error`

is_error(self) -> bool

`ValidJinja`

Methods:

`is_error`

is_error(self) -> bool

__init__validation

API Reference

​prefect.utilities.schema_tools.hydration

​Functions

​handler

​call_handler

​null_handler

​json_handler

​jinja_handler

​workspace_variable_handler

​hydrate

​Classes

​HydrationContext

​build

​Placeholder

​is_error

​RemoveValue

​is_error

​HydrationError

​is_error

​is_error

​message

​KeyNotFound

​is_error

​key

​message

​message

​ValueNotFound

​key

​key

​message

​TemplateNotFound

​key

​key

​message

​VariableNameNotFound

​key

​key

​message

​InvalidJSON

​is_error

​message

​message

​InvalidJinja

​is_error

​message

​message

​WorkspaceVariableNotFound

​is_error

​message

​message

​variable_name

​WorkspaceVariable

​is_error

​ValidJinja

​is_error

`prefect.utilities.schema_tools.hydration`

Functions

`handler`

`call_handler`

`null_handler`

`json_handler`

`jinja_handler`

`workspace_variable_handler`

`hydrate`

Classes

`HydrationContext`

`build`

`Placeholder`

`is_error`

`RemoveValue`

`is_error`

`HydrationError`

`is_error`

`is_error`

`message`

`KeyNotFound`

`is_error`

`key`

`message`

`message`

`ValueNotFound`

`key`

`key`

`message`

`TemplateNotFound`

`key`

`key`

`message`

`VariableNameNotFound`

`key`

`key`

`message`

`InvalidJSON`

`is_error`

`message`

`message`

`InvalidJinja`

`is_error`

`message`

`message`

`WorkspaceVariableNotFound`

`is_error`

`message`

`message`

`variable_name`

`WorkspaceVariable`

`is_error`

`ValidJinja`

`is_error`