Skip to main content

none_schema

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

from pydantic_core import SchemaValidator, core_schema

schema = core_schema.none_schema()
v = SchemaValidator(schema)
assert v.validate_python(None) is None
def none_schema(
ref: str | None = None,
metadata: dict[str, Any] | None = None,
serialization: SerSchema | None = None
) - > NoneSchema

Returns a schema that matches a None value.

Parameters

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

Returns

TypeDescription
NoneSchemaA core schema object that validates and serializes None values.