Table Of Contents

Search

Enter search terms or a module, class or function name.

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

See also

Index
The base pandas Index type
Period
Represents a period of time
DatetimeIndex
Index with datetime64 data
TimedeltaIndex
Index of timedelta64 data

Examples

>>> idx = PeriodIndex(year=year_arr, quarter=q_arr)
>>> idx2 = PeriodIndex(start='2000', end='2010', freq='A')

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
end_time
freq
freqstr Return the frequency object as a string if its 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
qyear
second The second of the period
start_time
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

Methods

asfreq([freq, how]) Convert the PeriodIndex to the specified frequency freq.
strftime(date_format) Return an array of formatted strings specified by date_format, which supports the same string format as the python standard library.
to_timestamp([freq, how]) Cast to DatetimeIndex
tz_convert(tz) Convert tz-aware DatetimeIndex from one time zone to another (using
tz_localize(tz[, infer_dst]) Localize tz-naive DatetimeIndex to given time zone (using
Scroll To Top