pandera.engines.pandas_engine.Category

class pandera.engines.pandas_engine.Category(categories=None, ordered=False)

Semantic representation of a pandas.CategoricalDtype.

Attributes

auto_coerce	Whether to force coerce to be True in all cases
categories
continuous	Whether the number data type is continuous.
ordered
type	Native pandas dtype boxed by the data type.

Methods

__init__(categories=None, ordered=False)

check(pandera_dtype, data_container=None)

Check that pandera DataType are equivalent.

Parameters:

• pandera_dtype (DataType) – Expected DataType.

• data_container (Union[Series, DataFrame, 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)

Pure coerce without catching exceptions.

Return type:

Union[Series, DataFrame]

coerce_value(value)

Coerce an value to a particular type.

Return type:

Any

classmethod from_parametrized_dtype(cat)

Convert a categorical to a Pandera pandera.dtypes.pandas_engine.Category.

try_coerce(data_container)

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

Return type:

Union[Series, DataFrame]

__call__(data_container)

Coerce data container to the data type.