pandas.bdate_range#

pandas.bdate_range(start=None, end=None, periods=None, freq='B', tz=None, normalize=True, name=None, weekmask=None, holidays=None, inclusive='both', **kwargs)[源代码]#

返回一个固定频率的 DatetimeIndex,默认为工作日。

参数:
startstr 或 datetime-like, 默认 None

生成日期的左边界。

endstr 或 datetime-like, 默认 None

生成日期的右边界。

periodsint, 默认 None

要生成的周期数。

freqstr, Timedelta, datetime.timedelta, 或 DateOffset, 默认 ‘B’

频率字符串可以带有多重,例如 ‘5h’。默认值为工作日 (‘B’)。

tzstr 或 None

返回本地化 DatetimeIndex 的时区名称,例如 Asia/Beijing。

normalizebool,默认为 False

在生成日期范围之前将 start/end 日期规范化为午夜。

name可哈希,默认为 None

结果 DatetimeIndex 的名称。

weekmaskstr 或 None, 默认 None

有效的周内工作日掩码,传递给 numpy.busdaycalendar,仅在传递自定义频率字符串时使用。默认值 None 等同于 ‘Mon Tue Wed Thu Fri’。

holidayslist-like 或 None, 默认 None

从有效工作日集合中排除的日期,传递给 numpy.busdaycalendar,仅在传递自定义频率字符串时使用。

inclusive{“both”, “neither”, “left”, “right”}, 默认值 “both”

包括边界;是否将每个边界设置为闭合或开放。

**kwargs

为了兼容性。对结果没有影响。

返回:
DatetimeIndex

固定频率 DatetimeIndex。

另请参阅

date_range

返回固定频率的 DatetimeIndex。

period_range

返回固定频率的 PeriodIndex。

timedelta_range

返回一个固定频率的 TimedeltaIndex。

注意

在四个参数:start, end, periods, 和 freq 中,必须指定其中三个。指定 freqbdate_range 的要求。如果不想指定 freq,请使用 date_range

要了解更多关于频率字符串的信息,请参阅 此链接

示例

注意结果中如何跳过了两个周末。

>>> 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[us]', freq='B')