NumPy

319 guides

keyboard_arrow_down

Other math topics

Dagster

Pandas

NumPy

Matplotlib

PySpark

MySQL

chevron_leftDocumentation

Method argpartition

NumPy Random Generator4 topics

Method choice Method dot Method finfo Method histogram Method iinfo Method max Method mean Method place Method roots Method seed Method uniform Method view Method zeros Method sum Object busdaycalendar Method is_busday Property dtype Method unique Method loadtxt Method vsplit Method fliplr Method setdiff1d Method msort Method argsort Method lexsort Method around Method nanmax Method nanmin Method nanargmax Method nanargmin Method argmax Method argmin Property itemsize Method spacing Method fix Method ceil Method diff Property flat Property real Property base Method flip Method delete Method amax Method amin Method logical_xor Method logical_or Method logical_not Method logical_and Method logaddexp Method logaddexp2 Method logspace Method not_equal Method equal Method greater_equal Method less Method less_equal Method remainder Method mod Method empty Method greater Method isfinite Method busday_count Method repeat Method var Method random_sample Method random Method sign Method std Method absolute Method abs Method sort Method randint Method isreal Method linspace Method gradient Method all Method sample Property T Property imag Method cov Method insert Method log Method log1p Method exp2 Method expm1 Method exp Method arccos Method cos Method arcsin Method sin Method tan Method fromiter Method trim_zeros Method diagflat Method savetxt Method count_nonzero Property size Property shape Method reshape Method resize Method triu Method tril Method eye Method arange Method fill_diagonal Method tile Method save Method transpose Method swapaxes Method meshgrid Property mgrid Method rot90 Method log2 Method radians Method deg2rad Method rad2deg Method degrees Method log10 Method append Method cumprod Property nbytes Method tostring Property data Method modf Method fmod Method tolist Method datetime_as_string Method datetime_data Method array_split Method itemset Method floor Method put_along_axis Method cumsum Method bincount Method put Method putmask Method take Method hypot Method sqrt Method square Method floor_divide Method tri Method signbit Method flatten Method ravel Method roll Method isrealobj Method diag Method diagonal Method quantile Method ones Method iscomplexobj Method iscomplex Method isscalar Method divmod Method isnat Method percentile Method isnan Method divide Method add Method reciprocal Method positive Method subtract Method median Method isneginf Method isposinf Method float_power Method power Method negative Method maximum Method average Method isinf Method multiply Method busday_offset Method identity Method interp Method squeeze Method get_printoptions Method savez_compressed Method savez Method load Method asfarray Method clip Method array Method array_equiv Method array_equal Method frombuffer Method set_string_function Method matmul Method genfromtxt Method fromfunction Method asscalar Method searchsorted Method full_like Method full Method shares_memory Method ptp Method digitize Method argwhere Method geomspace Method zeros_like Method fabs Method flatnonzero Method vstack Method dstack Method fromstring Method tobytes Method expand_dims Method ranf Method arctan Method item Method extract Method compress Method choose Method asarray Method asmatrix Method allclose Method isclose Method any Method corrcoef Method trunc Method prod Method cross Method true_divide Method hsplit Method split Method rint Method ediff1d Method lcm Method gcd Method cbrt Method flipud Property ndim Method array2string Method set_printoptions Method where Method hstack

Char32 topics

check_circle

Mark as learned

thumb_up

thumb_down

chat_bubble_outline

Comment

auto_stories Bi-column layout

settings

NumPy | is_busday method

schedule Aug 12, 2023

Last updated

local_offer

Python●NumPy

Parameters

1. dates | array-like of datetime

The input array of datetimes. Datetimes are essentially strings formatted like so:


        
        
            
                
                
                    "2020-05-25"

2. weekmasklink | string or array-like of boolean | optional

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

For instance, "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.

By default, weekmask="1111100", that is, valid weekdays are from Monday to Friday (both inclusive).

3. holidayslink | array-like of datetime | optional

An array of datetimes that are deemed as invalid dates.

4. busdaycallink | busdaycalender | optional

An busdaycalendar object that specifies which dates are deemed as valid dates. If this parameter is provided, then you should not specify parameters weekmask and holidays.

Return value

A Numpy array of booleans, where True represents a valid datetime, and False otherwise.

Examples

Specifying a weekmask


        
        
            
                
                
                     np.is_busday(["2020-12-25", "2020-12-26", "2020-12-27"], "1111110")
                
            
            array([ True,  True, False])

Here, we're setting Sunday as an invalid date - if you check your calendar, you'll see that "2020-12-27" is a Sunday, so this is why we get a False for that entry.

Specifying holidays


        
        
            
                
                
                    holidays = ["2020-12-25"]
np.is_busday(["2020-12-25", "2020-12-26", "2020-12-27"], "1111111", holidays)
                
            
            array([False,  True,  True])

Here, False is returned for 2020-12-25 since we specified that date as a holiday, and holidays are considered to be invalid dates.

Specifying a valid date

Instead of specifying invalid dates, we can also specify just the valid dates and make all other dates invalid:


        
        
            
                
                
                    bdc = np.busdaycalendar(weekmask="1111111", holidays=["2020-12-26"])
np.is_busday(["2020-12-25", "2020-12-26", "2020-12-27"], busdaycal=bdc)
                
            
            array([ True, False,  True])

Here, busdaycalendar object specifies what dates are considered to be valid. It may be confusing here but the holidays used in the constructor of busdaycalender is a list of valid datetimes.

Published by Isshin Inada

Edited by 0 others

Did you find this page useful?

thumb_up

thumb_down

Comment

Citation

Ask a question or leave a feedback...

thumb_up

thumb_down

chat_bubble_outline

settings

Enjoy our search

Hit / to insta-search docs and recipes!