pg.typing.Int¶

Accessible via pg.typing.Int.

class Int(default=MISSING_VALUE, min_value=None, max_value=None, is_noneable=False, frozen=False)[source]¶

Bases: pg.typing.Number

Value spec for int type.

Examples:

# A required int value.
pg.typing.Int()

# A required int value with min and max value (both inclusive.)
pg.typing.Int(min_value=1, max_value=10)

# A int value with the default value set to 1
pg.typing.Int(default=1)

# An optional int value with default value set to None.
pg.typing.Int().noneable()

# An optional int value with default value set to 1.
pg.typing.Int(default=1).noneable()

# A frozen int with value set to 1 that is not modifiable by subclasses.
pg.typing.Int().freeze(1)