Skip to main content

is_instance_schema

Returns a schema that checks if a value is an instance of a class, equivalent to python's isinstance method, e.g.:

from pydantic_core import SchemaValidator, core_schema

class A:
pass

schema = core_schema.is_instance_schema(cls=A)
v = SchemaValidator(schema)
v.validate_python(A())
def is_instance_schema(
cls: Any,
cls_repr: str | None = None,
ref: str | None = None,
metadata: dict[str, Any] | None = None,
serialization: SerSchema | None = None
) - > IsInstanceSchema

Returns a schema that checks if a value is an instance of a class, equivalent to python's isinstance method.

Parameters

NameTypeDescription
clsAnyThe class type that the input value must be an instance of.
cls_repr`strNone` = None
ref`strNone` = None
metadata`dict[str, Any]None` = None
serialization`SerSchemaNone` = None

Returns

TypeDescription
IsInstanceSchemaA dictionary-based schema configuration used by pydantic-core to perform instance checks during validation.