numpy.busday_offset#

numpy.busday_offset(dates, offsets, roll='raise', weekmask='1111100', holidays=None, busdaycal=None, out=None)#

首先根据 roll 规则将日期调整为有效日期,然后将偏移量应用于以有效日期计数的给定日期。

参数:
datesarray_like of datetime64[D]

要处理的日期数组。

offsetsarray_like of int

偏移量数组,它将与 dates 进行广播。

roll{‘raise’, ‘nat’, ‘forward’, ‘following’, ‘backward’, ‘preceding’, ‘modifiedfollowing’, ‘modifiedpreceding’}, optional

如何处理非有效日期的日期。默认值为 ‘raise’。

  • ‘raise’ 表示对无效日期引发异常。

  • ‘nat’ 表示为无效日期返回 NaT (not-a-time)。

  • ‘forward’ 和 ‘following’ 表示取之后第一个有效日期。

  • ‘backward’ 和 ‘preceding’ 表示取之前第一个有效日期。

  • ‘modifiedfollowing’ 表示取之后第一个有效日期,除非它跨越了月份边界,在这种情况下,取之前第一个有效日期。

  • ‘modifiedpreceding’ 表示取之前第一个有效日期,除非它跨越了月份边界,在这种情况下,取之后第一个有效日期。

weekmaskstr or array_like of bool, optional

一个七元素数组,指示星期一到星期日中的哪些是有效日期。可以指定为长度为七的列表或数组,例如 [1,1,1,1,1,0,0];长度为七的字符串,例如 ‘1111100’;或者一个字符串,例如 “Mon Tue Wed Thu Fri”,由三个字符的星期缩写组成,可选地用空格分隔。有效的缩写是:Mon Tue Wed Thu Fri Sat Sun

holidaysarray_like of datetime64[D], optional

被视为无效日期的日期数组。可以按任意顺序指定,并且会忽略 NaT (not-a-time) 日期。此列表以适合快速计算有效日期的规范化形式保存。

busdaycalbusdaycalendar, optional

一个 busdaycalendar 对象,该对象指定了有效日期。如果提供了此参数,则不能同时提供 weekmask 或 holidays。

outarray of datetime64[D], optional

如果提供,此数组将填充结果。

返回:
outarray of datetime64[D]

一个形状与 datesoffsets 广播后的形状相同的数组,包含应用了偏移量的日期。

另请参阅

busdaycalendar

一个指定自定义有效日期集的对象。

is_busday

返回一个布尔数组,指示有效日期。

busday_count

计算半开日期范围内有效日期的数量。

示例

>>> import numpy as np
>>> # First business day in October 2011 (not accounting for holidays)
... np.busday_offset('2011-10', 0, roll='forward')
np.datetime64('2011-10-03')
>>> # Last business day in February 2012 (not accounting for holidays)
... np.busday_offset('2012-03', -1, roll='forward')
np.datetime64('2012-02-29')
>>> # Third Wednesday in January 2011
... np.busday_offset('2011-01', 2, roll='forward', weekmask='Wed')
np.datetime64('2011-01-19')
>>> # 2012 Mother's Day in Canada and the U.S.
... np.busday_offset('2012-05', 1, roll='forward', weekmask='Sun')
np.datetime64('2012-05-13')
>>> # First business day on or after a date
... np.busday_offset('2011-03-20', 0, roll='forward')
np.datetime64('2011-03-21')
>>> np.busday_offset('2011-03-22', 0, roll='forward')
np.datetime64('2011-03-22')
>>> # First business day after a date
... np.busday_offset('2011-03-20', 1, roll='backward')
np.datetime64('2011-03-21')
>>> np.busday_offset('2011-03-22', 1, roll='backward')
np.datetime64('2011-03-23')