pandera.engines.pandas_engine.Period

class pandera.engines.pandas_engine.Period(freq)

Representation of pandas pd.Period.

Attributes

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

Methods

__init__(freq)

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(pd_dtype)

Convert a pandas.PeriodDtype to a Pandera pandera.engines.pandas_engine.Period.

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.