pandas.api.types.is_period_dtype — pandas 2.2.3 documentation (original) (raw)

pandas.api.types.is_period_dtype(arr_or_dtype)[source]#

Check whether an array-like or dtype is of the Period dtype.

Deprecated since version 2.2.0: Use isinstance(dtype, pd.Period) instead.

Parameters:

arr_or_dtypearray-like or dtype

The array-like or dtype to check.

Returns:

boolean

Whether or not the array-like or dtype is of the Period dtype.

Examples

from pandas.core.dtypes.common import is_period_dtype is_period_dtype(object) False is_period_dtype(pd.PeriodDtype(freq="D")) True is_period_dtype([1, 2, 3]) False is_period_dtype(pd.Period("2017-01-01")) False is_period_dtype(pd.PeriodIndex([], freq="Y")) True