Skip to main content
`Ctrl`+`K`

# pandas.tseries.offsets.CustomBusinessMonthBegin

class pandas.tseries.offsets.CustomBusinessMonthBegin

  DateOffset subclass representing custom business month(s).

  Increments between beginning of month dates.

  Parameters:
    n int, default 1

      The number of months represented.

    normalize bool, default False

      Normalize start dates to midnight before generating date range.

    weekmask str, Default ‘Mon Tue Wed Thu Fri’

      Weekmask of valid business days, passed to `numpy.busdaycalendar`.

    holidays list

      List/array of dates to exclude from the set of valid business days, passed to `numpy.busdaycalendar`.

    calendar np.busdaycalendar

      Calendar to integrate.

    offset timedelta, default timedelta(0)

      Time offset to apply.

  See also

  `DateOffset`

    Standard kind of date increment.

  Examples

  In the example below we use the default parameters.

      >>> ts = pd.Timestamp(2022, 8, 5)
      >>> ts + pd.offsets.CustomBusinessMonthBegin()
      Timestamp('2022-09-01 00:00:00')

  Custom business month start can be specified by `weekmask` parameter. To convert the returned datetime object to its string representation the function strftime() is used in the next example.

      >>> import datetime as dt
      >>> freq = pd.offsets.CustomBusinessMonthBegin(weekmask="Wed Thu")
      >>> pd.date_range(dt.datetime(2022, 7, 10), dt.datetime(2022, 12, 18),
      ...               freq=freq).strftime('%a %d %b %Y %H:%M')
      Index(['Wed 03 Aug 2022 00:00', 'Thu 01 Sep 2022 00:00',
             'Wed 05 Oct 2022 00:00', 'Wed 02 Nov 2022 00:00',
             'Thu 01 Dec 2022 00:00'],
             dtype='object')

  Using NumPy business day calendar you can define custom holidays.

      >>> import datetime as dt
      >>> bdc = np.busdaycalendar(holidays=['2022-08-01', '2022-09-30',
      ...                                   '2022-10-31', '2022-11-01'])
      >>> freq = pd.offsets.CustomBusinessMonthBegin(calendar=bdc)
      >>> pd.date_range(dt.datetime(2022, 7, 10), dt.datetime(2022, 11, 10), freq=freq)
      DatetimeIndex(['2022-08-02', '2022-09-01', '2022-10-03', '2022-11-02'],
                     dtype='datetime64[ns]', freq='CBMS')

  Attributes

  `base` | Returns a copy of the calling offset object with n=1 and all other attributes equal.
  `calendar` | Return the calendar used for business day calculations.
  `cbday_roll` | Define default roll function to be called in apply method.
  `freqstr` | Return a string representing the frequency.
  `holidays` | Return the holidays used for custom business day calculations.
  `kwds` | Return a dict of extra parameters for the offset.
  `m_offset` | Return a MonthBegin or MonthEnd offset.
  `month_roll` | Define default roll function to be called in apply method.
  `n` | Return the count of the number of periods.
  `name` | Return a string representing the base frequency.
  `nanos` | Returns an integer of the total number of nanoseconds for fixed frequencies.
  `normalize` | Return boolean whether the frequency can align with midnight.
  `offset` | Alias for self._offset.
  `rule_code` | Return a string representing the base frequency.
  `weekmask` | Return the weekmask used for custom business day calculations.

  Methods

  `copy`() | Return a copy of the frequency.
  `is_month_end`(ts) | Return boolean whether a timestamp occurs on the month end.
  `is_month_start`(ts) | Return boolean whether a timestamp occurs on the month start.
  `is_on_offset`(dt) | Return boolean whether a timestamp intersects with this frequency.
  `is_quarter_end`(ts) | Return boolean whether a timestamp occurs on the quarter end.
  `is_quarter_start`(ts) | Return boolean whether a timestamp occurs on the quarter start.
  `is_year_end`(ts) | Return boolean whether a timestamp occurs on the year end.
  `is_year_start`(ts) | Return boolean whether a timestamp occurs on the year start.
  `rollback`(dt) | Roll provided date backward to next offset only if not on offset.
  `rollforward`(dt) | Roll provided date forward to next offset only if not on offset.