Annotated Handlers

Type annotations to use with __get_pydantic_core_schema__ and __get_pydantic_json_schema__.

GetJsonSchemaHandler

Handler to call into the next JSON schema generation function.

属性：

名称	类型	描述
mode	JsonSchemaMode	Json schema mode, can be validation or serialization.

resolve_ref_schema

resolve_ref_schema(maybe_ref_json_schema: JsonSchemaValue) -> JsonSchemaValue

Get the real schema for a {"$ref": ...} schema. If the schema given is not a $ref schema, it will be returned as is. This means you don't have to check before calling this function.

参数：

名称	类型	描述	默认
maybe_ref_json_schema	JsonSchemaValue	A JsonSchemaValue which may be a $ref schema.	必需

引发：

类型	描述
LookupError	If the ref is not found.

返回：

名称	类型	描述
JsonSchemaValue	JsonSchemaValue	A JsonSchemaValue that has no $ref.

源代码位于： .venv/lib/python3.13/site-packages/pydantic/annotated_handlers.py

def resolve_ref_schema(self, maybe_ref_json_schema: JsonSchemaValue, /) -> JsonSchemaValue:
    """Get the real schema for a `{"$ref": ...}` schema.
    If the schema given is not a `$ref` schema, it will be returned as is.
    This means you don't have to check before calling this function.

    Args:
        maybe_ref_json_schema: A JsonSchemaValue which may be a `$ref` schema.

    Raises:
        LookupError: If the ref is not found.

    Returns:
        JsonSchemaValue: A JsonSchemaValue that has no `$ref`.
    """
    raise NotImplementedError

GetCoreSchemaHandler

Handler to call into the next CoreSchema schema generation function.

field_name property

field_name: str | None

Get the name of the closest field to this validator.

generate_schema

generate_schema(source_type: Any) -> CoreSchema

Generate a schema unrelated to the current context. Use this function if e.g. you are handling schema generation for a sequence and want to generate a schema for its items. Otherwise, you may end up doing something like applying a min_length constraint that was intended for the sequence itself to its items!

参数：

名称	类型	描述	默认
source_type	Any	The input type.	必需

返回：

名称	类型	描述
CoreSchema	CoreSchema	The pydantic-core CoreSchema generated.

源代码位于： .venv/lib/python3.13/site-packages/pydantic/annotated_handlers.py

def generate_schema(self, source_type: Any, /) -> core_schema.CoreSchema:
    """Generate a schema unrelated to the current context.
    Use this function if e.g. you are handling schema generation for a sequence
    and want to generate a schema for its items.
    Otherwise, you may end up doing something like applying a `min_length` constraint
    that was intended for the sequence itself to its items!

    Args:
        source_type: The input type.

    Returns:
        CoreSchema: The `pydantic-core` CoreSchema generated.
    """
    raise NotImplementedError

resolve_ref_schema

resolve_ref_schema(maybe_ref_schema: CoreSchema) -> CoreSchema

Get the real schema for a definition-ref schema. If the schema given is not a definition-ref schema, it will be returned as is. This means you don't have to check before calling this function.

参数：

名称	类型	描述	默认
maybe_ref_schema	CoreSchema	A CoreSchema, ref-based or not.	必需

引发：

类型	描述
LookupError	If the ref is not found.

返回：

类型	描述
CoreSchema	A concrete CoreSchema.

源代码位于： .venv/lib/python3.13/site-packages/pydantic/annotated_handlers.py

def resolve_ref_schema(self, maybe_ref_schema: core_schema.CoreSchema, /) -> core_schema.CoreSchema:
    """Get the real schema for a `definition-ref` schema.
    If the schema given is not a `definition-ref` schema, it will be returned as is.
    This means you don't have to check before calling this function.

    Args:
        maybe_ref_schema: A `CoreSchema`, `ref`-based or not.

    Raises:
        LookupError: If the `ref` is not found.

    Returns:
        A concrete `CoreSchema`.
    """
    raise NotImplementedError