pg.typing.Float¶

Accessible via pg.typing.Float.

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

Bases: pg.typing.Number

Value spec for float type.

Examples:

# A required float value.
pg.typing.Float()

# A required float value with min and max value (both inclusive.)
pg.typing.Float(min_value=1.0, max_value=10.0)

# A float value with the default value set to 1
pg.typing.Float(default=1)

# An optional float value with default value set to None.
pg.typing.Float().noneable()

# An optional float value with default value set to 1.0.
pg.typing.Float(default=1.0).noneable()

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