Class Int

traitlets/traitlets.py:2593–2663

An int trait.

class Int(TraitType[G, S]):
    """An int trait."""

    default_value = 0
    info_text = "an int"

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

    def __init__(
        self,
        default_value: t.Any = Undefined,
        allow_none: bool = False,
        read_only: bool | None = None,
        help: str | None = None,
        config: t.Any | None = None,
        **kwargs: t.Any,
    ) -> None:
        self.min = kwargs.pop("min", None)
        self.max = kwargs.pop("max", None)
        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 not isinstance(value, int) and isinstance(value, numbers.Number):
            # allow casting integer-valued numbers to int
            # allows for more concise assignment like `4e9` which is a float
            try:
                int_value = int(value)
                if int_value == value:
                    value = int_value