Python Pandas - 指定されたDateOffsetオブジェクトに適用された増分の数を返す方法

Pandasで指定されたDateOffsetオブジェクトに適用された増分（インクリメント）の回数を取得するには、offset.nプロパティを使用します。このプロパティは、DateOffsetオブジェクトに設定されている頻度の乗数（例：「5M」なら5）を整数値として返します。

DateOffsetの増分数を取得する手順

1. 必要なライブラリをインポートする

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

from pandas.tseries.frequencies import to_offset
import pandas as pd

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

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

timestamp = pd.Timestamp('2021-09-26 03:25:02.000045')

3. DateOffsetオブジェクトを作成する

次に、DateOffsetを作成します。ここでは「M」（月）頻度を使用して、月単位の増分を設定しています。「5M」は「5か月」という意味になります。

offset = to_offset("5M")

4. 更新後のタイムスタンプを表示する

タイムスタンプにDateOffsetを加算した結果を表示します。

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

5. 増分の回数を返す

offset.nプロパティを使って、DateOffsetオブジェクトに適用された増分の回数を取得します。

print("\nThe count of increments on the DateOffset object..\n", offset.n)

完全なコード例

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

from pandas.tseries.frequencies import to_offset
import pandas as pd

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

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

# DateOffsetを作成
# 「M」頻度を使用して月単位の増分を設定
offset = to_offset("5M")

# DateOffsetを表示
print("\nDateOffset...\n", offset)

# 更新後のタイムスタンプを表示
print("\nUpdated Timestamp...\n", timestamp + offset)

# 指定されたDateOffsetオブジェクトの増分の回数を返す
print("\nThe count of increments on the DateOffset object..\n", offset.n)

実行結果

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

Timestamp...
 2021-09-26 03:25:02.000045

DateOffset...
 <5 * MonthEnds>

Updated Timestamp...
 2022-01-31 03:25:02.000045

The count of increments on the DateOffset object..
 5

解説

実行結果からわかるように、「5M」で作成したDateOffsetオブジェクトに対してoffset.nを呼び出すと「5」が返されます。これは、DateOffsetが5か月分の増分を持っていることを示しています。

また、タイムスタンプ「2021-09-26」に5か月の増分を加算すると、月末日に基づくオフセット（MonthEnds）が適用され、「2022-01-31」という結果になっています。これは「M」頻度が各月の月末を基準として動作するためです。

ポイント： offset.nプロパティは、動的に生成されたオフセットの乗数を確認したい場合や、コード内でオフセットの規模を検証・デバッグしたい場合に便利です。