Python | Pandas tseries.offsets.BusinessDay.name

The BusinessDay class in the tseries.offsets module of the Pandas library represents a custom frequency for business days. It provides a way to increment or decrement a date by a specified number of business days.

The name attribute of the BusinessDay class returns a string that represents the name of the offset. The default value of the name attribute is "B".

Usage:

from pandas.tseries.offsets import BusinessDay

bd = BusinessDay()

print(bd.name)  # "B"

If a custom name is specified when creating a BusinessDay instance, it will be returned by the name attribute:

bd = BusinessDay(name="MY_BUSINESS_DAY")

print(bd.name)  # "MY_BUSINESS_DAY"

The name attribute is useful when working with date offsets in Pandas. It provides a way to access the name of the offset, which can be used in various operations that involve date offsets.

For example, to create a custom date range using a BusinessDay offset with a specific name, you can use the date_range function in Pandas:

import pandas as pd

bd = BusinessDay(name="WORK_DAYS")

start_date = pd.to_datetime("2022-01-01")
end_date = pd.to_datetime("2022-01-15")

dates = pd.date_range(start_date, end_date, freq=bd)

print(dates)

This will output the following dates, which exclude weekends:

DatetimeIndex(['2022-01-03', '2022-01-04', '2022-01-05', '2022-01-06',
               '2022-01-07', '2022-01-10', '2022-01-11', '2022-01-12',
               '2022-01-13', '2022-01-14'],
              dtype='datetime64[ns]', freq='WORK_DAYS')

In this example, the date_range function uses the WORK_DAYS offset, which is defined as a BusinessDay instance with a custom name. The resulting DatetimeIndex contains only business days, excluding weekends, between the specified start and end dates.

In summary, the name attribute of the BusinessDay class in Pandas provides a way to access the name of a custom business day offset. It can be used for various operations that involve date offsets, such as creating custom date ranges.