pandas.tseries.offsets.CustomBusinessMonthBegin.is_year_endの使い方とサンプルコード

pandas.tseries.offsets.CustomBusinessMonthBegin.is_year_end は、pandas ライブラリでカスタムビジネス月始オフセットの日付が年末かどうかを判定する関数です。

詳細

• CustomBusinessMonthBegin は、カスタムビジネス月始オフセットを表すクラスです。
• is_year_end は、このクラスのメソッドで、引数として渡された日付が年末かどうかを判定します。
• 末年とは、12月31日を指します。

引数

• dt : 日付を表す pandas.Timestamp 型または datetime.datetime 型のオブジェクト

返値

• dt が年末であれば True 、そうでなければ False

例

import pandas as pd

# カスタムビジネス月始オフセットを作成
offset = pd.tseries.offsets.CustomBusinessMonthBegin(weekmask="Mon Tue Wed Thu Fri")

# 2024年12月31日のオフセットを取得
dt = pd.Timestamp("2024-12-31") + offset

# 末年かどうかを確認
is_year_end = dt.is_year_end()

print(is_year_end)  # True

補足

• CustomBusinessMonthBegin オフセットは、月末ではなく月初に基づいています。
• 祝日などの非営業日は考慮されません。

pandas.tseries.offsets.CustomBusinessMonthBegin.is_year_end サンプルコード

サンプルコード1: 祝日を含む年末判定

import pandas as pd

# 祝日を設定
holidays = ["2024-12-25"]

# カスタムビジネス月始オフセットを作成
offset = pd.tseries.offsets.CustomBusinessMonthBegin(weekmask="Mon Tue Wed Thu Fri", holidays=holidays)

# 2024年12月31日のオフセットを取得
dt = pd.Timestamp("2024-12-31") + offset

# 末年かどうかを確認
is_year_end = dt.is_year_end()

print(is_year_end)  # False

• 祝日 2024-12-25 は非営業日として考慮されます。
• そのため、2024-12-31 は年末ではなく、False が返されます。

サンプルコード2: 異なるweekmaskによる年末判定

import pandas as pd

# 異なるweekmaskを設定
weekmasks = ["Mon Tue Wed Thu Fri", "Mon Tue Wed Thu"]

for weekmask in weekmasks:
    # カスタムビジネス月始オフセットを作成
    offset = pd.tseries.offsets.CustomBusinessMonthBegin(weekmask=weekmask)

    # 2024年12月31日のオフセットを取得
    dt = pd.Timestamp("2024-12-31") + offset

    # 末年かどうかを確認
    is_year_end = dt.is_year_end()

    print(f"weekmask: {weekmask}, is_year_end: {is_year_end}")

出力例

weekmask: Mon Tue Wed Thu Fri, is_year_end: True
weekmask: Mon Tue Wed Thu, is_year_end: False

解説

• 1つ目の weekmask ("Mon Tue Wed Thu Fri") では、金曜日が月末となるため、2024-12-31 は年末と判定されます。

サンプルコード3: 過去の日付に対する年末判定

import pandas as pd

# 過去の日付を設定
dt = pd.Timestamp("2023-12-31")

# カスタムビジネス月始オフセットを作成
offset = pd.tseries.offsets.CustomBusinessMonthBegin()

# 末年かどうかを確認
is_year_end = dt.is_year_end()

print(is_year_end)  # True

解説

• 過去の日付であっても、is_year_end は正しく判定されます。

pandas.tseries.offsets.CustomBusinessMonthBegin.is_year_end の代替方法

方法1: 手動で判定

def is_year_end(dt, weekmask="Mon Tue Wed Thu Fri"):
    """
    引数として渡された日付が年末かどうかを判定します。

    Args:
        dt: 日付を表す `pandas.Timestamp` 型または `datetime.datetime` 型のオブジェクト
        weekmask: 週マスクを表す文字列

    Returns:
        dtが年末であれば True、そうでなければ False
    """

    # 月末を取得
    month_end = dt.replace(day=1) + pd.offsets.MonthEnd()

    # 月末が金曜日かどうかを確認
    is_friday = month_end.weekday() == 4

    # 月末が金曜日であれば、年末と判定
    return is_friday

# 例
dt = pd.Timestamp("2024-12-31")
weekmask = "Mon Tue Wed Thu Fri"

is_year_end = is_year_end(dt, weekmask)

print(is_year_end)  # True

解説

• この方法は、手動で月末を取得し、それが金曜日かどうかを確認することで年末を判定します。

方法2: pandas のその他の機能を使用

def is_year_end(dt):
    """
    引数として渡された日付が年末かどうかを判定します。

    Args:
        dt: 日付を表す `pandas.Timestamp` 型または `datetime.datetime` 型のオブジェクト

    Returns:
        dtが年末であれば True、そうでなければ False
    """

    # 月末を取得
    month_end = dt.replace(day=1) + pd.offsets.MonthEnd()

    # 月末と翌月の1日の差分を計算
    diff = month_end - (month_end + pd.offsets.Day())

    # 差分が1日であれば、年末と判定
    return diff == pd.Timedelta(days=1)

# 例
dt = pd.Timestamp("2024-12-31")

is_year_end = is_year_end(dt)

print(is_year_end)  # True

解説

• この方法は、月末と翌月の1日の差分を計算することで年末を判定します。

方法3: 外部ライブラリを使用

from dateutil.relativedelta import relativedelta

def is_year_end(dt):
    """
    引数として渡された日付が年末かどうかを判定します。

    Args:
        dt: 日付を表す `pandas.Timestamp` 型または `datetime.datetime` 型のオブジェクト

    Returns:
        dtが年末であれば True、そうでなければ False
    """

    # 翌年1月1日を取得
    next_year_jan_1 = dt + relativedelta(years=1, months=1, day=1)

    # 差分を計算
    diff = next_year_jan_1 - dt

    # 差分が1日であれば、年末と判定
    return diff == pd.Timedelta(days=1)

# 例
dt = pd.Timestamp("2024-12-31")

is_year_end = is_year_end(dt)

print(is_year_end)  # True

解説

• この方法は、dateutil ライブラリの relativedelta 関数を使用して、翌年1月1日を取得し、差分を計算することで年末を判定します。

• 処理速度