Spec-Zone.ru › NumPy 1.14

numpy.busday_offset

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

Сначала дата корректируется, чтобы она попадала на допустимый день в соответствии с правилом roll, затем к заданным датам применяются смещения, подсчитанные в допустимые дни.

Новая версия 1.7.0.

Параметры:

dates : массив datetime64[D]

Массив дат для обработки.

offsets : массив int

Массив смещений, который транслируется с dates.

roll : {‘raise’, ‘nat’, ‘forward’, ‘following’, ‘backward’, ‘preceding’, ‘modifiedfollowing’, ‘modifiedpreceding’}, необязательно

Как обрабатывать даты, которые не попадают на допустимый день. По умолчанию — ‘raise’.

  • ‘raise’ означает, что для недействительного дня будет возбуждено исключение.
  • ‘nat’ означает, что для недействительного дня будет возвращено значение NaT (not-a-time).
  • ‘forward’ и ‘following’ означают, что будет взят первый допустимый день, расположенный позже во времени.
  • ‘backward’ и ‘preceding’ означают, что будет взят первый допустимый день, расположенный раньше во времени.
  • ‘modifiedfollowing’ означает, что будет взят первый допустимый день, расположенный позже во времени, если он не пересекает границу месяца, в противном случае будет взят первый допустимый день, расположенный раньше во времени.
  • ‘modifiedpreceding’ означает, что будет взят первый допустимый день, расположенный раньше во времени, если он не пересекает границу месяца, в противном случае будет взят первый допустимый день, расположенный позже во времени.

weekmask : str или массив bool, необязательно

Массив из семи элементов, указывающий, какие из понедельника по воскресенье являются допустимыми днями. Может быть задан в виде списка или массива длиной 7, например, [1, 1, 1, 1, 1, 0, 0]; строкой длиной 7, например, ‘1111100’; или строкой типа «Пн Вт Ср Чт Пт», состоящей из трехбуквенных сокращений для дней недели, необязательно разделенных пробелами. Допустимые сокращения: Пн Вт Ср Чт Пт Сб Вс

holidays : массив datetime64[D], необязательно

Массив дат, которые следует считать недействительными датами. Они могут быть заданы в любом порядке, и даты NaT (not-a-time) игнорируются. Этот список сохраняется в нормализованной форме, подходящей для быстрых расчётов допустимых дней.

busdaycal : busdaycalendar, необязательно

Объект busdaycalendar, который задаёт допустимые дни. Если этот параметр предоставлен, weekmask и holidays использовать нельзя.

out : массив datetime64[D], необязательно

Если предоставлен, этот массив заполняется результатом.

Возвращает:

out : массив datetime64[D]

Массив с формой, полученной от трансляции dates и offsets, содержащий даты со применёнными смещениями.

См. также

busdaycalendar
Объект, который определяет настраиваемый набор допустимых дней.
is_busday
Возвращает булевый массив, указывающий допустимые дни.
busday_count
Подсчитывает количество допустимых дней в полуоткрытом интервале дат.

Примеры

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

© 2005–2019 NumPy Developers
Licensed under the 3-clause BSD License.
https://docs.scipy.org/doc/numpy-1.14.5/reference/generated/numpy.busday_offset.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API