Skip to main content
`Ctrl`+`K`

# pandas.tseries.offsets.YearBegin.is_on_offset

YearBegin.is_on_offset(dt)

  Return boolean whether a timestamp intersects with this frequency.

  This method determines if a given timestamp aligns with the start of a custom business month, as defined by this offset. It accounts for custom rules, such as skipping weekends or other non-business days, and checks whether the provided datetime falls on a valid business day that marks the beginning of the custom business month.

  Parameters:
    dt datetime.datetime

      Timestamp to check intersections with frequency.

  See also

  `tseries.offsets.CustomBusinessMonthBegin`

    Represents the start of a custom business month.

  `tseries.offsets.CustomBusinessMonthEnd`

    Represents the end of a custom business month.

  Examples

      >>> ts = pd.Timestamp(2022, 1, 1)
      >>> freq = pd.offsets.Day(1)
      >>> freq.is_on_offset(ts)
      True

      >>> ts = pd.Timestamp(2022, 8, 6)
      >>> ts.day_name()
      'Saturday'
      >>> freq = pd.offsets.BusinessDay(1)
      >>> freq.is_on_offset(ts)
      False