Skip to main content

tuple_positional_schema

Returns a schema that matches a tuple of schemas, e.g.:

from pydantic_core import SchemaValidator, core_schema

schema = core_schema.tuple_positional_schema(
[core_schema.int_schema(), core_schema.str_schema()]
)
v = SchemaValidator(schema)
assert v.validate_python((1, 'hello')) == (1, 'hello')
def tuple_positional_schema(
items_schema: list[CoreSchema],
extras_schema: CoreSchema | None = None,
strict: bool | None = None,
ref: str | None = None,
metadata: dict[str, Any] | None = None,
serialization: IncExSeqOrElseSerSchema | None = None
) - > TupleSchema

Returns a schema that matches a tuple of schemas, e.g. where each element in the tuple corresponds to a specific schema in the provided list.

Parameters

NameTypeDescription
items_schemalist[CoreSchema]A list of schemas that the tuple items must match positionally; the value must be a tuple with items that match these schemas.
extras_schema`CoreSchemaNone` = None
strict`boolNone` = None
ref`strNone` = None
metadata`dict[str, Any]None` = None
serialization`IncExSeqOrElseSerSchemaNone` = None

Returns

TypeDescription
TupleSchemaA core schema object configured to validate positional tuple data structures.