Python | Pandas tseries.offsets.CustomBusinessDay.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. DateOffets 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.CustomBusinessDay.onOffset() function to check if the given timestamp is on offset or not.

Syntax: pandas.tseries.offsets.CustomBusinessDay.onOffset(dt)

Parameter :
dt : date



Returns : boolean

Example #1: Use pandas.tseries.offsets.CustomBusinessDay.onOffset() function to check if the given timestamp is on offset or not.

filter_none

edit
close

play_arrow

link
brightness_4
code

# importing pandas as pd
import pandas as pd
  
# Creating Timestamp
ts = pd.Timestamp('2019-4-23 11:15:00')
  
# Create an offset
cbd = pd.tseries.offsets.CustomBusinessDay(weekmask = 'Mon Tue Wed')
  
# Print the Timestamp
print(ts)
  
# Print the Offset
print(cbd)

chevron_right


Output :

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

filter_none

edit
close

play_arrow

link
brightness_4
code

# Adding the offset to the given timestamp
new_timestamp = ts + cbd
  
# Print the updated timestamp
print(new_timestamp)
  
# check if the given timestamp
# is on offset or not
result = cbd.onOffset(pd.Timestamp('2019-4-22 11:15:00'))
  
# print the result
print(result)

chevron_right


Output :

As we can see in the output, we have successfully created an offset and added it to the given timestamp. We have also checked if the given timestamp is on offset or not.



Example #2: Use pandas.tseries.offsets.CustomBusinessDay.onOffset() function to check if the given timestamp is on offset or not.

filter_none

edit
close

play_arrow

link
brightness_4
code

# importing pandas as pd
import pandas as pd
  
# Creating Timestamp
ts = pd.Timestamp('2019-4-23 11:15:00')
  
# Create an offset
cbd = pd.tseries.offsets.CustomBusinessDay(n = 3, weekmask = 'Mon Tue Wed Thu')
  
# Print the Timestamp
print(ts)
  
# Print the Offset
print(cbd)

chevron_right


Output :

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

filter_none

edit
close

play_arrow

link
brightness_4
code

# Adding the offset to the given timestamp
new_timestamp = ts + cbd
  
# Print the updated timestamp
print(new_timestamp)
  
# check if the given timestamp
# is on offset or not
result = cbd.onOffset(pd.Timestamp('2019-4-19 11:15:00'))
  
# print the result
print(result)

chevron_right


Output :

As we can see in the output, we have successfully created an offset and added it to the given timestamp. We have also checked if the given offset object is anchored or not.



My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.




Article Tags :

Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.