pandas.PeriodIndex

class pandas.PeriodIndex

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 (1d integer np.ndarray or PeriodArray), 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.

Deprecated since version 0.24.0.

periods : int, optional, > 0

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

Deprecated since version 0.24.0.

end : end value, period-like, optional

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

Deprecated since version 0.24.0.

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

See also

Index

The base pandas Index type.

Period

Represents a period of time.

DatetimeIndex

Index with datetime64 data.

TimedeltaIndex

Index of timedelta64 data.

period_range

Create a fixed-frequency PeriodIndex.

Notes

Creating a PeriodIndex based on start, periods, and end has been deprecated in favor of period_range().

Examples

>>> idx = pd.PeriodIndex(year=year_arr, quarter=q_arr)

Attributes

day	The days of the period
dayofweek	The day of the week with Monday=0, Sunday=6
dayofyear	The ordinal day of the year
days_in_month	The number of days in the month
daysinmonth	The number of days in the month
freq	Return the frequency object if it is set, otherwise None.
freqstr	Return the frequency object as a string if it is set, otherwise None.
hour	The hour of the period
is_leap_year	Logical indicating if the date belongs to a leap year
minute	The minute of the period
month	The month as January=1, December=12
quarter	The quarter of the date
second	The second of the period
week	The week ordinal of the year
weekday	The day of the week with Monday=0, Sunday=6
weekofyear	The week ordinal of the year
year	The year of the period

end_time
qyear
start_time

Methods

asfreq(self, \*args, \*\*kwargs)	Convert the Period Array/Index to the specified frequency freq.
strftime(self, \*args, \*\*kwargs)	Convert to Index using specified date_format.
to_timestamp(self, \*args, \*\*kwargs)	Cast to DatetimeArray/Index.