Class Float

traitlets/traitlets.py:2718–2781

A float trait.

class Float(TraitType[G, S]):
    """A float trait."""

    default_value = 0.0
    info_text = "a float"

    @t.overload
    def __init__(
        self: Float[float, int | float],
        default_value: float | Sentinel = ...,
        allow_none: Literal[False] = ...,
        read_only: bool | None = ...,
        help: str | None = ...,
        config: t.Any | None = ...,
        **kwargs: t.Any,
    ) -> None:
        ...

    @t.overload
    def __init__(
        self: Float[int | None, int | float | None],
        default_value: float | Sentinel | None = ...,
        allow_none: Literal[True] = ...,
        read_only: bool | None = ...,
        help: str | None = ...,
        config: t.Any | None = ...,
        **kwargs: t.Any,
    ) -> None:
        ...

    def __init__(
        self: Float[int | None, int | float | None],
        default_value: float | Sentinel | None = Undefined,
        allow_none: bool = False,
        read_only: bool | None = False,
        help: str | None = None,
        config: t.Any | None = None,
        **kwargs: t.Any,
    ) -> None:
        self.min = kwargs.pop("min", -float("inf"))
        self.max = kwargs.pop("max", float("inf"))
        super().__init__(
            default_value=default_value,
            allow_none=allow_none,
            read_only=read_only,
            help=help,
            config=config,
            **kwargs,
        )

    def validate(self, obj: t.Any, value: t.Any) -> G:
        if isinstance(value, int):
            value = float(value)
        if not isinstance(value, float):
            self.error(obj, value)
        return _validate_bounds(self, obj, value)  # type:ignore[no-any-return]

    def from_string(self, s: str) -> G: