polars.Decimal#

class polars.Decimal(precision: int | None = None, scale: int = 0)[source]#

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

Warning

This functionality is considered unstable. It is a work-in-progress feature and may not always work as expected. It may be changed at any point without it being considered a breaking change.

Parameters:
precision

Maximum number of digits in each number. If set to None (default), the precision is inferred.

scale

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

__init__(precision: int | None = None, scale: int = 0)[source]#

Methods

__init__([precision, scale])

base_type()

Return this DataType's fundamental/root type class.

is_(other)

Check if this DataType is the same as another DataType.

is_decimal()

Check whether the data type is a decimal type.

is_float()

Check whether the data type is a temporal type.

is_integer()

Check whether the data type is an integer type.

is_nested()

Check whether the data type is a nested type.

is_not(other)

Check if this DataType is NOT the same as another DataType.

is_numeric()

Check whether the data type is a numeric 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.

Attributes

precision

scale