Document

bdate_range(start=None, end=None, periods: 'int | None' = None, freq='B', tz=None, normalize: 'bool' = True, name: 'Hashable' = None, weekmask=None, holidays=None, closed: 'lib.NoDefault' = <no_default>, inclusive: 'str | None' = None, **kwargs) -> 'DatetimeIndex'

Notes

Of the four parameters: start , end , periods , and freq , exactly three must be specified. Specifying freq is a requirement for bdate_range . Use date_range if specifying freq is not desired.

To learn more about the frequency strings, please see :None:None:`this link <https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases>`.

Parameters

start : str or datetime-like, default None: Left bound for generating dates.
end : str or datetime-like, default None: Right bound for generating dates.
periods : int, default None: Number of periods to generate.
freq : str or DateOffset, default 'B' (business daily): Frequency strings can have multiples, e.g. '5H'.
tz : str or None: Time zone name for returning localized DatetimeIndex, for example Asia/Beijing.
normalize : bool, default False: Normalize start/end dates to midnight before generating date range.
name : str, default None: Name of the resulting DatetimeIndex.
weekmask : str or None, default None: Weekmask of valid business days, passed to numpy.busdaycalendar , only used when custom frequency strings are passed. The default value None is equivalent to 'Mon Tue Wed Thu Fri'.
holidays : list-like or None, default None: Dates to exclude from the set of valid business days, passed to numpy.busdaycalendar , only used when custom frequency strings are passed.
closed : str, default None: Make the interval closed with respect to the given frequency to the 'left', 'right', or both sides (None).

deprecated

Argument :None:None:`closed` has been deprecated to standardize boundary inputs. Use :None:None:`inclusive` instead, to set each bound as closed or open.
inclusive : {"both", "neither", "left", "right"}, default "both": Include boundaries; Whether to set each bound as closed or open.

versionadded
**kwargs :: For compatibility. Has no effect on the result.

Returns

DatetimeIndex

Return a fixed frequency DatetimeIndex, with business day as the default frequency.

Examples

Note how the two weekend days are skipped in the result.

This example is valid syntax, but we were not able to check execution

>>> pd.bdate_range(start='1/1/2018', end='1/08/2018')
DatetimeIndex(['2018-01-01', '2018-01-02', '2018-01-03', '2018-01-04',
           '2018-01-05', '2018-01-08'],
          dtype='datetime64[ns]', freq='B')

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

File: /pandas/core/indexes/datetimes.py#1083
type: <class 'function'>
Commit: