Python Pandas CustomBusinessHour – 指定したタイムスタンプがオフセット上にあるかどうかを確認する方法

指定したタイムスタンプがカスタム営業時間のオフセット上にあるかどうかを確認するには、Pandasの CustomBusinessHour.is_on_offset() メソッドを使用します。確認したいタイムスタンプを引数として渡すだけで、オフセット上にある場合は True、そうでない場合は False が返されます。

CustomBusinessHourとは

CustomBusinessHour は、Pandasの日付オフセットクラスである DateOffset のサブクラスです。標準的な営業時間（デフォルトは9:00〜17:00）ではなく、独自に定義した営業時間を扱いたい場合に便利です。start パラメータで開始時刻、end パラメータで終了時刻をそれぞれ24時間形式で指定します。

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

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

import pandas as pd

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

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

timestamp = pd.Timestamp('2021-11-14 05:20:30')

CustomBusinessHourオフセットの作成

次に、CustomBusinessHourオフセットを作成します。ここでは、営業開始時刻を「09:30」、終了時刻を「18:30」に設定しています。

cbhOffset = pd.tseries.offsets.CustomBusinessHour(start="09:30", end = "18:30")

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

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

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

is_on_offset()でタイムスタンプを確認する

指定したタイムスタンプがオフセット上にあるかどうかを確認します。

offset = cbhOffset.is_on_offset(pd.Timestamp('2021-11-20 05:20:30'))

結果を表示します。

print("\nCheck if the given timestamp is on offset or not...\n", offset)

完全なコード例

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

import pandas as pd

# Pandasでタイムスタンプオブジェクトを設定
timestamp = pd.Timestamp('2021-11-14 05:20:30')

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

# CustomBusinessHourオフセットを作成
# CustomBusinessHourはDateOffsetのサブクラスです
# 「start」はカスタム営業時間の開始時刻（24時間形式）
# 「end」はカスタム営業時間の終了時刻（24時間形式）
cbhOffset = pd.tseries.offsets.CustomBusinessHour(start="09:30", end = "18:30")

# CustomBusinessHourオフセットを表示
print("\nCustomBusinessHour Offset...\n", cbhOffset)

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

# 指定したタイムスタンプがオフセット上にあるかどうかを確認
offset = cbhOffset.is_on_offset(pd.Timestamp('2021-11-20 05:20:30'))

# 結果を表示
print("\nCheck if the given timestamp is on offset or not...\n", offset)

実行結果

このコードを実行すると、以下の出力が得られます。

Timestamp...
 2021-11-14 05:20:30

CustomBusinessHour Offset...
 <CustomBusinessHour: CBH=09:30-18:30>

Updated Timestamp...
 2021-11-15 10:30:00

Check if the given timestamp is on offset or not...
 False

結果の解説

出力を見ると、元のタイムスタンプ「2021-11-14 05:20:30」は日曜日であり、カスタム営業時間（09:30〜18:30）外の時刻です。そのため、オフセットを加算すると、翌営業日にあたる月曜日の「2021-11-15 10:30:00」へと移動します。また、is_on_offset() のチェック対象である「2021-11-20 05:20:30」も土曜日かつ営業時間外のため、結果は False となっています。このように、is_on_offset() を使えば、ある時点が定義済みの営業時間内に含まれるかどうかを簡単に判定できます。