pandera.engines.polars_engine.Decimal

class pandera.engines.polars_engine.Decimal(precision=28, scale=0)[source]

Polars decimal data type.

Attributes

auto_coerce

Whether to force coerce to be True in all cases

continuous

Whether the number data type is continuous.

exact

Whether the data type is an exact representation of a number.

precision

The number of significant digits that the decimal type can represent.

rounding

The rounding mode supported by the Python decimal.Decimal class.

scale

The number of digits after the decimal point.

Methods

__init__(precision=28, scale=0)[source]
check(pandera_dtype, data_container=None)[source]

Check that pandera DataType are equivalent.

Parameters:
  • pandera_dtype (DataType) – Expected DataType.

  • data_container (Union[LazyFrame, PolarsData, None]) – Data container, used by data types that require the actual data for validation.

Return type:

Union[bool, Iterable[bool]]

Returns:

boolean scalar or iterable of boolean scalars, indicating which elements passed the check.

coerce(data_container)[source]

Coerce data container to the data type.

Return type:

LazyFrame

coerce_value(value)[source]

Coerce an value to a particular type.

classmethod from_parametrized_dtype(polars_dtype)[source]

Convert a polars.Decimal to a Pandera pandera.engines.polars_engine.Decimal.

try_coerce(data_container)[source]

Coerce data container to the data type, raises a ParserError if the coercion fails :raises: ParserError: if coercion fails

Return type:

LazyFrame

__call__(data_container)[source]

Coerce data container to the data type.