polars.datatypes.Decimal

class polars.datatypes.Decimal(
    precision: int | None = None,
    scale: int = 0,
)

Decimal 128-bit type with an optional precision and non-negative scale.

Parameters:

precision

Maximum number of digits in each number. If set to None (default), the precision is set to 38 (the maximum supported by Polars).

scale

Number of digits to the right of the decimal point in each number.

__init__(
    precision: int | None = None,
    scale: int = 0,
) → None

Methods

__init__([precision, scale])
base_type()	Return this DataType's fundamental/root type class.
from_python(py_type)	Return the Polars data type corresponding to a given Python type.
is_(other)	Check if this DataType is the same as another DataType.
is_decimal()	Check whether the data type is a decimal type.
is_extension()	Check whether the data type is an extension type.
is_float()	Check whether the data type is a floating point type.
is_integer()	Check whether the data type is an integer type.
is_nested()	Check whether the data type is a nested type.
is_numeric()	Check whether the data type is a numeric type.
is_object()	Check whether the data type is an object type.
is_signed_integer()	Check whether the data type is a signed integer type.
is_temporal()	Check whether the data type is a temporal type.
is_unsigned_integer()	Check whether the data type is an unsigned integer type.
max()	Return a literal expression representing the maximum value of this data type.
min()	Return a literal expression representing the minimum value of this data type.
to_dtype_expr()	Return a DataTypeExpr with a static DataType.
to_python()	Return the Python type corresponding to this Polars data type.

Attributes

precision
scale