Skip to main content

float_schema

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

from pydantic_core import SchemaValidator, core_schema

schema = core_schema.float_schema(le=0.8, ge=0.2)
v = SchemaValidator(schema)
assert v.validate_python('0.5') == 0.5
def float_schema(
allow_inf_nan: bool | None = None,
multiple_of: float | None = None,
le: float | None = None,
ge: float | None = None,
lt: float | None = None,
gt: float | None = None,
strict: bool | None = None,
ref: str | None = None,
metadata: dict[str, Any] | None = None,
serialization: SerSchema | None = None
) - > FloatSchema

Returns a schema that matches a float value.

Parameters

NameTypeDescription
allow_inf_nan`boolNone` = None
multiple_of`floatNone` = None
le`floatNone` = None
ge`floatNone` = None
lt`floatNone` = None
gt`floatNone` = None
strict`boolNone` = None
ref`strNone` = None
metadata`dict[str, Any]None` = None
serialization`SerSchemaNone` = None

Returns

TypeDescription
FloatSchemaA dictionary-based schema definition for validating and serializing floating-point numbers.