pandas.DataFrame.to_period#

DataFrame.to_period(freq=None,axis=0,copy=None)[source]#

Convert DataFrame from DatetimeIndex to PeriodIndex.

Convert DataFrame from DatetimeIndex to PeriodIndex with desiredfrequency (inferred from index if not passed).

Parameters:

freqstr, default

Frequency of the PeriodIndex.

axis{0 or ‘index’, 1 or ‘columns’}, default 0

The axis to convert (the index by default).

copybool, default True

If False then underlying input data is not copied.

Note

Thecopy keyword will change behavior in pandas 3.0.Copy-on-Writewill be enabled by default, which means that all methods with acopy keyword will use a lazy copy mechanism to defer the copy andignore thecopy keyword. Thecopy keyword will be removed in afuture version of pandas.

You can already get the future behavior and improvements throughenabling copy on writepd.options.mode.copy_on_write=True

Returns:

DataFrame

The DataFrame has a PeriodIndex.

Examples

>>>idx=pd.to_datetime(...[..."2001-03-31 00:00:00",..."2002-05-31 00:00:00",..."2003-08-31 00:00:00",...]...)

>>>idxDatetimeIndex(['2001-03-31', '2002-05-31', '2003-08-31'],dtype='datetime64[ns]', freq=None)

>>>idx.to_period("M")PeriodIndex(['2001-03', '2002-05', '2003-08'], dtype='period[M]')

For the yearly frequency

>>>idx.to_period("Y")PeriodIndex(['2001', '2002', '2003'], dtype='period[Y-DEC]')