Pandas: BYearEndオブジェクトの固定日付判定 - is_anchored属性

pandas.tseries.offsets.BYearEnd.is_anchored 解説

概要

BYearEnd オブジェクトは、年末を表す DateOffset オブジェクトです。例えば、BYearEnd(n=1) は、現在の日付から1年後の年末を表します。

is_anchored 属性は、BYearEnd オブジェクトが特定の日付に固定されているかどうかを示す bool 型の値を返します。

詳細

is_anchored 属性は、以下の条件を満たす場合に True を返します。

• BYearEnd オブジェクトが n=0 である。
• BYearEnd オブジェクトが normalize メソッドで正規化されている。

normalize メソッドは、BYearEnd オブジェクトを n=0 に設定し、day 属性を 31 に設定します。

例

import pandas as pd

# 2023年の年末を表す BYearEnd オブジェクトを作成
offset = pd.tseries.offsets.BYearEnd()

# is_anchored 属性は False を返す
print(offset.is_anchored)

# BYearEnd オブジェクトを正規化
offset = offset.normalize()

# is_anchored 属性は True を返す
print(offset.is_anchored)

この例では、is_anchored 属性は最初 False を返し、normalize メソッドで正規化された後は True を返します。

pandas.tseries.offsets.BYearEnd.is_anchored 属性は、BYearEnd オブジェクトが固定された日付に関連付けられているかどうかを示します。この属性は、BYearEnd オブジェクトが特定の日付範囲に適用されるかどうかを判断する際に役立ちます。

pandas.tseries.offsets.BYearEnd.is_anchored サンプルコード

サンプルコード1: is_anchored 属性の確認

import pandas as pd

# 2023年の年末を表す BYearEnd オブジェクトを作成
offset = pd.tseries.offsets.BYearEnd()

# is_anchored 属性は False を返す
print(offset.is_anchored)

# BYearEnd オブジェクトを正規化
offset = offset.normalize()

# is_anchored 属性は True を返す
print(offset.is_anchored)

サンプルコード2: is_anchored 属性を利用した日付範囲のフィルタリング

import pandas as pd

# データフレームを作成
df = pd.DataFrame({'Date': pd.to_datetime(['2022-12-31', '2023-01-01', '2023-02-01', '2023-12-31'])})

# 2023年の年末を含む日付のみを抽出
df = df[df['Date'].dt.is_anchored('BYearEnd')]

# 結果
print(df)

#   Date
# 0 2022-12-31
# 3 2023-12-31

サンプルコード3: is_anchored 属性を利用したオフセットの比較

import pandas as pd

# 2023年の年末を表す BYearEnd オブジェクトを作成
offset1 = pd.tseries.offsets.BYearEnd()

# 2024年の年末を表す BYearEnd オブジェクトを作成
offset2 = pd.tseries.offsets.BYearEnd(n=1)

# is_anchored 属性はどちらも True を返す
print(offset1.is_anchored)
print(offset2.is_anchored)

# オフセット同士を比較
print(offset1 == offset2)

# 結果
# True
# True
# False

サンプルコード4: is_anchored 属性を利用した日付の加算

import pandas as pd

# 2023年1月1日を表す Timestamp オブジェクトを作成
timestamp = pd.Timestamp('2023-01-01')

# 1年後の年末を表す Timestamp オブジェクトを作成
new_timestamp = timestamp + pd.tseries.offsets.BYearEnd()

# new_timestamp は 2023年の年末を表す
print(new_timestamp)

# 結果
# 2023-12-31 00:00:00

補足

• 上記のサンプルコードは、pandas ライブラリのバージョン 1.4.2 で動作確認しています。
• is_anchored 属性は、pandas ライブラリのバージョン 1.2.0 以降で利用可能です。

pandas.tseries.offsets.BYearEnd.is_anchored の代替方法

方法1: 比較演算子を使用する

import pandas as pd

# 2023年の年末を表す BYearEnd オブジェクトを作成
offset = pd.tseries.offsets.BYearEnd()

# 比較演算子を使用して、オフセットが固定された日付かどうかを確認
print(offset == pd.tseries.offsets.BYearEnd(n=0))

# 結果
# True

方法2: isinstance() 関数を使用する

import pandas as pd

# 2023年の年末を表す BYearEnd オブジェクトを作成
offset = pd.tseries.offsets.BYearEnd()

# isinstance() 関数を使用して、オフセットが BYearEnd オブジェクトかどうかを確認
print(isinstance(offset, pd.tseries.offsets.BYearEnd))

# 結果
# True

方法3: オブジェクトの属性を確認する

import pandas as pd

# 2023年の年末を表す BYearEnd オブジェクトを作成
offset = pd.tseries.offsets.BYearEnd()

# オブジェクトの属性を確認して、オフセットが固定された日付かどうかを確認
print(offset.n, offset.day)

# 結果
# 0 31

n 属性は、オフセットに適用される年数を示します。day 属性は、オフセットに適用される日を