pandas.tseries.offsets.CustomBusinessDay#

class pandas.tseries.offsets.CustomBusinessDay#

DateOffset 子类,表示可能 n 个自定义工作日。

在 CustomBusinessDay 中,我们可以使用自定义周掩码、假期和日历。

Parameters:
nint, 默认值 1

表示的天数。

normalizebool,默认 False

在生成日期范围之前将开始/结束日期规范化到午夜。

weekmaskstr,默认值为 ‘Mon Tue Wed Thu Fri’

有效的业务日周掩码,传递给 numpy.busdaycalendar

holidayslist

要从有效业务日集中排除的日期列表/数组,传递给 numpy.busdaycalendar

日历np.busdaycalendar

要集成的日历。

offsettimedelta, default timedelta(0)

要应用的日期偏移量。

Examples

在下面的示例中,默认参数给出下一个工作日。

>>> ts = pd.Timestamp(2022, 8, 5, 16)
>>> ts + pd.offsets.CustomBusinessDay()
Timestamp('2022-08-08 16:00:00')

可以通过 weekmask 参数指定工作日。为了将返回的 datetime 对象转换为其字符串表示形式,下一个示例使用了 strftime() 函数。

>>> import datetime as dt
>>> freq = pd.offsets.CustomBusinessDay(weekmask="Mon Wed Fri")
>>> pd.date_range(dt.datetime(2022, 12, 10), dt.datetime(2022, 12, 21),
...               freq=freq).strftime('%a %d %b %Y %H:%M')
Index(['Mon 12 Dec 2022 00:00', 'Wed 14 Dec 2022 00:00',
       'Fri 16 Dec 2022 00:00', 'Mon 19 Dec 2022 00:00',
       'Wed 21 Dec 2022 00:00'],
       dtype='object')

使用 NumPy 的 business day calendar,您可以定义自定义假期。

>>> import datetime as dt
>>> bdc = np.busdaycalendar(holidays=['2022-12-12', '2022-12-14'])
>>> freq = pd.offsets.CustomBusinessDay(calendar=bdc)
>>> pd.date_range(dt.datetime(2022, 12, 10), dt.datetime(2022, 12, 25), freq=freq)
DatetimeIndex(['2022-12-13', '2022-12-15', '2022-12-16', '2022-12-19',
               '2022-12-20', '2022-12-21', '2022-12-22', '2022-12-23'],
               dtype='datetime64[ns]', freq='C')

如果您想将结果偏移 n 天,可以使用 offset 参数。

>>> pd.Timestamp(2022, 8, 5, 16) + pd.offsets.CustomBusinessDay(1)
Timestamp('2022-08-08 16:00:00')
>>> import datetime as dt
>>> ts = pd.Timestamp(2022, 8, 5, 16)
>>> ts + pd.offsets.CustomBusinessDay(1, offset=dt.timedelta(days=1))
Timestamp('2022-08-09 16:00:00')

Attributes

base

返回调用偏移量对象的副本,其中 n=1 且所有其他属性都相同。

calendar

freqstr

返回表示频率的字符串。

holidays

kwds

返回偏移量的额外参数字典。

n

name

返回表示基本频率的字符串。

nanos

normalize

offset

Alias for self._offset.

rule_code

weekmask

Methods

copy ()

返回频率的副本。

is_anchored ()

(已弃用) 返回频率是否为单位频率 (n=1) 的布尔值.

is_month_end (ts)

如果时间戳发生在月份结束时,则返回布尔值。

is_month_start (ts)

如果时间戳发生在月份开始时,则返回布尔值。

is_on_offset (dt)

如果时间戳与此频率相交,则返回布尔值。

is_quarter_end (ts)

如果时间戳发生在季度结束时,则返回布尔值。

is_quarter_start (ts)

如果时间戳发生在季度开始时,则返回布尔值。

is_year_end (ts)

如果时间戳发生在年份结束时,则返回布尔值。

is_year_start (ts)

如果时间戳发生在年份开始时,则返回布尔值。

rollback (dt)

如果提供的日期不在偏移量上,则将其向后滚动到下一个偏移量。

rollforward (dt)

如果提供的日期不在偏移量上,则将其向前滚动到下一个偏移量。