Skip to main content

complex_schema

Returns a schema that matches a complex value, e.g.:

from pydantic_core import SchemaValidator, core_schema

schema = core_schema.complex_schema()
v = SchemaValidator(schema)
assert v.validate_python('1+2j') == complex(1, 2)
assert v.validate_python(complex(1, 2)) == complex(1, 2)
def complex_schema(
strict: bool | None = None,
ref: str | None = None,
metadata: dict[str, Any] | None = None,
serialization: SerSchema | None = None
) - > ComplexSchema

Returns a schema that matches a complex value.

Parameters

NameTypeDescription
strict`boolNone` = None
ref`strNone` = None
metadata`dict[str, Any]None` = None
serialization`SerSchemaNone` = None

Returns

TypeDescription
ComplexSchemaA core schema configuration that validates complex number objects or strings that can be converted to complex numbers.