Python Pandas - 指定されたCustomBusinessDayオフセットオブジェクトに適用された頻度を文字列として取得する方法

指定されたCustomBusinessDayオフセットオブジェクトに適用されている頻度（frequency）を文字列として取得するには、CustomBusinessDay.freqstrプロパティを使用します。このプロパティは、オフセットオブジェクトが持つ頻度情報を、読みやすい文字列形式で返してくれます。

必要なライブラリのインポート

まず、必要なライブラリをインポートします。

import pandas as pd

タイムスタンプオブジェクトの作成

Pandasでタイムスタンプオブジェクトを設定します。

timestamp = pd.Timestamp('2021-12-31 08:35:10')

CustomBusinessDayオフセットの作成

CustomBusinessDayは、祝日などを除外したカスタム営業日を表すDateOffsetのサブクラスです。ここでは、営業日を「月・火・水・金」に限定し、2営業日分のオフセットを作成します。

cbdOffset = pd.tseries.offsets.CustomBusinessDay(n = 2, weekmask = 'Mon Tue Wed Fri')

n=2は2営業日先へ進むことを意味し、weekmaskパラメータで有効な営業日を指定しています。この例では木曜日が営業日から除外されている点に注目してください。

タイムスタンプへのオフセット適用

タイムスタンプにオフセットを加算し、更新されたタイムスタンプを表示します。

print("\nUpdated Timestamp...\n", timestamp + cbdOffset)

freqstrプロパティによる頻度の取得

指定されたCustomBusinessDayオフセットオブジェクトに適用された頻度を、文字列として返します。

print("\nFrequency applied on the given CustomBusinessDay Offset object...\n", cbdOffset.freqstr)

完全なコード例

以下に、ここまでの手順をまとめたコード全体を示します。

import pandas as pd

# Pandasでタイムスタンプオブジェクトを設定
timestamp = pd.Timestamp('2021-12-31 08:35:10')

# タイムスタンプを表示
print("Timestamp...\n", timestamp)

# CustomBusinessDayオフセットを作成
# CustomBusinessDayは、祝日を除外したカスタム営業日を表すDateOffsetのサブクラス
# weekmaskで有効な営業日を指定
cbdOffset = pd.tseries.offsets.CustomBusinessDay(n = 2, weekmask = 'Mon Tue Wed Fri')

# CustomBusinessDayオフセットを表示
print("\nCustomBusinessDay Offset...\n", cbdOffset)

# タイムスタンプにオフセットを加算し、更新されたタイムスタンプを表示
print("\nUpdated Timestamp...\n", timestamp + cbdOffset)

# 指定されたCustomBusinessDayオフセットオブジェクトに適用された頻度を文字列として返す
print("\nFrequency applied on the given CustomBusinessDay Offset object...\n", cbdOffset.freqstr)

出力結果

上記のコードを実行すると、次のような出力が得られます。

Timestamp...
 2021-12-31 08:35:10

CustomBusinessDay Offset...
 <2 * CustomBusinessDays>

Updated Timestamp...
 2022-01-04 08:35:10

Frequency applied on the given CustomBusinessDay Offset object...
 2C

出力結果の解説

元のタイムスタンプは2021年12月31日（金）でした。weekmaskにより木曜日が営業日に含まれていないため、2営業日後の日付は2022年1月4日（火）となります。また、freqstrプロパティが出力する「2C」は、「2つのカスタム営業日（Custom Business Days）」という頻度を表す文字列です。このように、freqstrを使えばオフセットオブジェクトの頻度設定をひと目で確認できます。