pandas.arrays.PeriodArray#

class pandas.arrays.PeriodArray(values, dtype=None, freq=None, copy=False)[源代码]#

用于存储 Period 数据的 Pandas 扩展数组。

用户应使用 array() 来创建新实例。

Parameters:
valuesUnion[PeriodArray, Series[period], ndarray[int], PeriodIndex]

要存储的数据。这些应该是可以直接转换为序数值而无需推断或复制的数组(PeriodArray, ndarray[int64]),或者围绕此类数组的“框”(Series[period], PeriodIndex)。

dtypePeriodDtype, optional

一个 PeriodDtype 实例,从中提取 freq。如果同时指定了 freqdtype,则频率必须匹配。

freqstr 或 DateOffset

要用于数组的 freq。主要在 values 是整数 ndarray 时适用,此时 freq 是必需的。当 values 是 PeriodArray(或其“框”)时,会检查 values.freq 是否与 freq 匹配。

copybool,默认 False

存储前是否复制序数值。

参见

Period

Represents a period of time.

PeriodIndex

Period 数据的不可变 Index。

period_range

创建一个固定频率的 PeriodArray。

array

构造一个 pandas 数组。

Notes

PeriodArray 有两个组成部分:

  • ordinals : integer ndarray

  • freq : pd.tseries.offsets.Offset

值以 1D ndarray 的整数形式实际存储。这些被称为“序数值”,表示相对于某个基准的某种偏移量。

freq 指示数组元素覆盖的范围。PeriodArray 中的所有元素都具有相同的 freq

Examples

>>> pd.arrays.PeriodArray(pd.PeriodIndex(['2023-01-01',
...                                       '2023-01-02'], freq='D'))
<PeriodArray>
['2023-01-01', '2023-01-02']
Length: 2, dtype: period[D]

Attributes

None

Methods

None