Python | Pandas tseries.offsets.DateOffset.onOffset

Dateoffsets are a standard kind of date increment used for a date range in Pandas. It works exactly like relativedelta in terms of the keyword args we pass in. DateOffsets work as follows, each offset specify a set of dates that conform to the DateOffset. For example, Bday defines this set to be the set of dates that are weekdays (M-F). DateOffsets can be created to move dates forward a given number of valid dates. For example, Bday(2) can be added to a date to move it two business days forward. If the date does not start on a valid date, first it is moved to a valid date and then offset is created. Pandas tseries.offsets.DateOffset.onOffset() function returns a boolean value. It returns True if the given DateOffset is onOffset from the passed date else it return False.

Syntax: pandas.tseries.offsets.DateOffset.onOffset() Parameter : None Returns : boolean

Example #1: Use pandas.tseries.offsets.DateOffset.onOffset() function to check if the passed date is onOffset for the given DateOffset. 

Python3

# importing pandas as pd
import pandas as pd

# importing the to_offset function
from pandas.tseries.frequencies import to_offset

# Creating Timestamp
ts = pd.Timestamp('2019-10-10 07:15:11')

# Create the DateOffset of 2 day
do = to_offset(freq = '2D')

# Print the Timestamp
print(ts)

# Print the DateOffset
print(do)

Output : Now we will add the dateoffset to the given timestamp object to increment the datetime value. We will also check if the given DateOffset is onOffset from the given date. 

Python3

# Adding the dateoffset to the given timestamp
new_timestamp = ts + do

# Print the updated timestamp
print(new_timestamp)

# Now we will check if the given DateOffset
# is onOffset from the passed date
print(do.onOffset())

Output : As we can see in the output, the function has returned True indicating the given DateOffset is onOffset from the passed date. Example #2: Use pandas.tseries.offsets.DateOffset.onOffset() function to check if the passed date is onOffset for the given DateOffset. 

Python3

# importing pandas as pd
import pandas as pd

# importing the to_offset function
from pandas.tseries.frequencies import to_offset

# Creating Timestamp
ts = pd.Timestamp('2019-10-10 07:15:11')

# Create the DateOffset
do = to_offset(freq = 'W-SUN')

# Print the Timestamp
print(ts)

# Print the DateOffset
print(do)

Output : Now we will add the dateoffset to the given timestamp object to increment the datetime value. We will also check if the given DateOffset is onOffset from the given date. 

Python3

# Adding the dateoffset to the given timestamp
new_timestamp = ts + do

# Print the updated timestamp
print(new_timestamp)

# Now we will check if the given DateOffset
# is onOffset from the passed date
print(do.onOffset())

Output : As we can see in the output, the function has returned False indicating the given DateOffset is not onOffset from the passed date.