Open In App

Python | Pandas tseries.offsets.BusinessDay.onOffset

Improve
Improve
Like Article
Like
Save
Share
Report

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.BusinessDay.onOffset() function returns a boolean value. It returns True if the given Business day Offset is on Offset else it return False

Syntax: pandas.tseries.offsets.BusinessDay.onOffset()

Parameter : None

Returns : boolean

Example #1: Use pandas.tseries.offsets.BusinessDay.onOffset() function to check if the given Business day offset object is on offset or not.




# importing pandas as pd
import pandas as pd
  
# Creating Timestamp
ts = pd.Timestamp('2019-10-10 07:15:11')
  
# Create an offset of 5 Business days
bd = pd.tseries.offsets.BusinessDay(n = 5)
  
# Print the Timestamp
print(ts)
  
# Print the DateOffset
print(bd)


Output :

Now we will add the Business day offset to the given timestamp object to increment the datetime value. We will also check if the given Business day offset object is on offset or not.




# Adding the Business day offset to the given timestamp
new_timestamp = ts + bd
  
# Print the updated timestamp
print(new_timestamp)
  
# check if the offset is 
# on offset or not
result = bd.onOffset()
  
# print the result
print(result)


Output :

As we can see in the output, we have successfully created an offset of 5 Business days and added it to the given timestamp. The given function has returned False indicating the given offset object is not on offset.

Example #2 : Use pandas.tseries.offsets.BusinessDay.onOffset() function to check if the given Business day offset object is on offset or not.




# importing pandas as pd
import pandas as pd
  
# Creating Timestamp
ts = pd.Timestamp('2019-10-10 07:15:11')
  
# Create an offset of 10 Business days and 10 hours
bd = pd.tseries.offsets.BusinessDay(offset = datetime.timedelta(days = 10, hours = 10))
  
# Print the Timestamp
print(ts)
  
# Print the DateOffset
print(bd)


Output :

Now we will add the Business day offset to the given timestamp object to increment the datetime value. We will also check if the given Business day offset object is on offset or not.




# Adding the Business day offset to the given timestamp
new_timestamp = ts + bd
  
# Print the updated timestamp
print(new_timestamp)
  
# check if the offset is 
# on offset or not
result = bd.onOffset()
  
# print the result
print(result)


Output :

As we can see in the output, we have successfully created an offset of 10 Business days & 10 hours and added it to the given timestamp. The given function has returned False indicating the given offset object is not on offset.



Last Updated : 23 Apr, 2019
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads