Python Pandas - Return the count of increments applied on the given DateOffset object

To return the count of increments applied on the given DateOffset object, use the offset.n property in Pandas. This property returns the numerical value that represents how many units of the offset are being applied.

What is DateOffset?

A DateOffset is a Pandas object that represents a duration of time that can be added to or subtracted from a timestamp. When creating a DateOffset like "5M", the number 5 is the increment count, and "M" is the frequency (months in this case).

Getting the Increment Count

The .n property returns the count of increments for any DateOffset object ?

from pandas.tseries.frequencies import to_offset
import pandas as pd

# Set the timestamp object in Pandas
timestamp = pd.Timestamp('2021-09-26 03:25:02.000045')

# Display the Timestamp
print("Timestamp...\n", timestamp)

# Create the DateOffset
# We are incrementing the months here using the "M" frequency
offset = to_offset("5M")

# Display the DateOffset
print("\nDateOffset...\n", offset)

# Display the Updated Timestamp
print("\nUpdated Timestamp...\n", timestamp + offset)

# Return the count of increments on the given DateOffset object
print("\nThe count of increments on the DateOffset object...\n", offset.n)

Timestamp...
 2021-09-26 03:25:02.000045

DateOffset...
 <5 * MonthEnds>

Updated Timestamp...
 2022-01-31 03:25:02.000045

The count of increments on the DateOffset object..
 5

Different DateOffset Examples

The .n property works with various frequency types ?

from pandas.tseries.frequencies import to_offset

# Different DateOffset examples
day_offset = to_offset("3D")
hour_offset = to_offset("12H")
week_offset = to_offset("2W")

print("Day offset count:", day_offset.n)
print("Hour offset count:", hour_offset.n)
print("Week offset count:", week_offset.n)

Day offset count: 3
Hour offset count: 12
Week offset count: 2

Common Use Cases

The increment count is useful for:

• Validation − Checking how many units a DateOffset represents
• Calculations − Using the count in mathematical operations
• Dynamic operations − Adjusting time series operations based on offset magnitude

Conclusion

Use the .n property to retrieve the count of increments from any Pandas DateOffset object. This property is essential for understanding the magnitude of time-based operations in data analysis.