pandas.PeriodIndex¶

class pandas.PeriodIndex[source]¶

Immutable ndarray holding ordinal values indicating regular periods in time such as particular years, quarters, months, etc.

Index keys are boxed to Period objects which carries the metadata (eg, frequency information).

Parameters:

data : array-like (1-dimensional), optional

Optional period-like data to construct index with

copy : bool

Make a copy of input ndarray

freq : string or period object, optional

One of pandas period strings or corresponding objects

start : starting value, period-like, optional

If data is None, used as the start point in generating regular period data.

periods : int, optional, > 0

Number of periods to generate, if generating index. Takes precedence over end argument

end : end value, period-like, optional

If periods is none, generated index will extend to first conforming period on or just past end argument

year : int, array, or Series, default None

month : int, array, or Series, default None

quarter : int, array, or Series, default None

day : int, array, or Series, default None

hour : int, array, or Series, default None

minute : int, array, or Series, default None

second : int, array, or Series, default None

tz : object, default None

Timezone for converting datetime64 data to Periods

dtype : str or PeriodDtype, default None