pandera.engines.pandas_engine.Period¶

class pandera.engines.pandas_engine.Period(freq)[source]¶

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

check(pandera_dtype, data_container=None)[source]¶

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)[source]¶

Pure coerce without catching exceptions.

coerce_value(value)[source]¶

Coerce an value to a particular type.

classmethod from_parametrized_dtype(pd_dtype)[source]¶: Convert a pandas.PeriodDtype to a Pandera pandera.engines.pandas_engine.Period.

try_coerce(data_container)[source]¶

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

__call__(data_container)[source]¶: Coerce data container to the data type.