NumPy | busday_count method
Start your free 7-days trial now!
busday_count(~) method counts the number of valid dates given a range of datetimes. Note that busday stands for business day, but we can specify what a "business" day is via the parameters.
The starting datetime. Datetimes are essentially strings formatted like so:
The ending datetime. This is exclusive, that is, if you specify
enddates=A and one of your dates does include A, that date will not be included in the count.
The days of the week that are considered to be valid. You could either specify a string of length 7 with 0s representing invalid and 1s representing valid weekdays, from Monday to Sunday. For instance,
"1111100" would mean that weekends (Saturday and Sunday) would be invalid dates. Also, instead of typing in binaries, you could also use three-character abbreviations like:
Mon Tue Wed Thu Fri Sat Sun
"Mon Wed Fri" would mean that only Mondays, Wednesdays and Fridays are valid dates, and all other weekdays are invalid.
Alternatively, you could provide an array of booleans of size 7, where True means that that corresponding weekday is valid, and False otherwise. For instance,
[True,True,True,True,True,False,False] would again mean that weekends would be invalid dates.
weekmask="1111100", that is, valid weekdays are from Monday to Friday (both inclusive).
An array of datetimes that are deemed as invalid dates.
An busdaycalender object that specifies which dates are deemed as valid dates. If this parameter is provided, then you should not specify parameters weekmask and holidays.
Numpy array |
We can store the result in
out, which saves memory space as a new Array is not created.
If a datetime is provided for
enddates, then a single integer is returned. A Numpy array of integers that represent count of the dates that fall between the specified range.
To count the number of days that are not Mondays and Sundays during 2020-12-20 to 2020-12-28:
np.busday_count("2020-12-20", "2020-12-28", "0111110")5
To count the number of days that are not 2020-12-25 and 2020-12-27 during 2020-12-20 to 2020-12-28:
christmas_break = ["2020-12-25", "2020-12-27"]np.busday_count("2020-12-20", "2020-12-28", holidays= christmas_break)4
Using busdaycal object
To count the number of dates that are Mondays and Tuesdays during 2020-12-20 to 2020-12-28:
bdc = np.busdaycalendar(weekmask="Mon Tue")np.busday_count("2020-12-20", "2020-12-28", busdaycal=bdc)2