Python Pandas - Format the string representation of the PeriodIndex object

To format the string representation of the PeriodIndex object, use the periodIndex.strftime() method. Set the format specifiers as an argument.

At first, import the required libraries −

import pandas as pd

Create a PeriodIndex object. PeriodIndex is an immutable ndarray holding ordinal values indicating regular periods in time −

periodIndex = pd.PeriodIndex(['2021-09-25 07:30:35', '2019-10-30 04:15:45',
'2020-07-15 02:55:15', '2022-06-25 09:40:55'], freq="Y")

Display PeriodIndex object −

print("PeriodIndex...\n", periodIndex)

Display the formatted result −

print("\nString representation (format with different directives)...\n",
periodIndex.strftime('%b. %d, %Y was a %A'))

Example

Following is the code −

import pandas as pd

# Create a PeriodIndex object
# PeriodIndex is an immutable ndarray holding ordinal values indicating regular periods in time
# We have set the frequency using the "freq" parameter
periodIndex = pd.PeriodIndex(['2021-09-25 07:30:35', '2019-10-30 04:15:45',
'2020-07-15 02:55:15', '2022-06-25 09:40:55'], freq="Y")

# Display PeriodIndex object
print("PeriodIndex...\n", periodIndex)

# Display PeriodIndex frequency
print("\nPeriodIndex frequency object...\n", periodIndex.freq)

# Display PeriodIndex frequency as string
print("\nPeriodIndex frequency object as a string...\n", periodIndex.freqstr)

# display the formatted result
print("\nString representation (format with different directives)...\n",
periodIndex.strftime('%b. %d, %Y was a %A'))

Output

This will produce the following code −

PeriodIndex...
PeriodIndex(['2021', '2019', '2020', '2022'], dtype='period[A-DEC]')

PeriodIndex frequency object...
<YearEnd: month=12>

PeriodIndex frequency object as a string...
A-DEC

String representation (format with different directives)...
Index(['Dec. 31, 2021 was a Friday', 'Dec. 31, 2019 was a Tuesday', 'Dec. 31, 2020 was a Thursday', 'Dec. 31, 2022 was a Saturday'],
dtype='object')