Python Pandas入門：CustomBusinessDayオブジェクトのrule_codeプロパティでルールコードを取得する方法

指定したCustomBusinessDayオブジェクトに適用されているルールコードを取得するには、PandasのCustomBusinessDay.rule_codeプロパティを使用します。この記事では、実際のコード例とともにその使い方をわかりやすく解説します。

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

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

import pandas as pd

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

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

timestamp = pd.Timestamp('2021-10-22 03:10:35')

3. CustomBusinessDayオフセットの作成

次に、CustomBusinessDayオフセットを作成します。CustomBusinessDayは、祝日などを除外した「カスタム営業日」を表すDateOffsetのサブクラスです。weekmaskパラメータを使うことで、有効な営業日となる曜日（ここでは月・火・水・金）を自由に指定できます。

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

4. オフセットの適用とルールコードの取得

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

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

続いて、指定したCustomBusinessDayオフセットに適用された頻度のルールコードを返します。

print("\nThe rule code of the CustomBusinessDay object..\n", cbdOffset.rule_code)

完全なコード例

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

import pandas as pd

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

# タイムスタンプを表示
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)

# 指定したCustomBusinessDayオフセットに適用された頻度のルールコードを返す
print("\nThe rule code of the CustomBusinessDay object..\n", cbdOffset.rule_code)

実行結果

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

Timestamp...
 2021-10-22 03:10:35

CustomBusinessDay Offset...
 <2 * CustomBusinessDays>

Updated Timestamp...
 2021-10-26 03:10:35

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

The rule code of the CustomBusinessDay object..
 C

ポイント解説

この例では、n=2により2営業日分のオフセットが適用され、元のタイムスタンプ（2021年10月22日・金曜日）から木曜日を除外した営業日カレンダーに基づいて、2021年10月26日（火曜日）へと移動しています。また、freqstrは頻度を文字列（この場合は「2C」）として返し、rule_codeはその基本となるルールコード（「C」）を返します。営業日ベースの日付計算を行う際に、これらのプロパティは頻度の確認やデバッグに役立ちます。