Pandas: データの型をしっかり把握！「pandas.api.types.is_integer_dtype」の使い方

pandas.Index.is_integer は、Pandas データフレームのインデックスが すべて整数型かどうか を判断するメソッドです。

バージョン

このメソッドは Pandas 2.0.0 で非推奨となり、pandas.api.types.is_integer_dtype を使用するよう推奨されています。

機能

pandas.Index.is_integer は、インデックスの各要素に対して isinstance(element, int) を実行し、すべての要素が True であれば True を返し、そうでなければ False を返します。

例

import pandas as pd

# 整数型のインデックスを作成
index = pd.Index([1, 2, 3, 4])

# インデックスが整数型かどうかを確認
result = index.is_integer()
print(result)  # True

# 浮動小数点型のインデックスを作成
index = pd.Index([1.0, 2.0, 3.0, 4.0])

# インデックスが整数型かどうかを確認
result = index.is_integer()
print(result)  # False

非推奨理由

pandas.Index.is_integer は、インデックスのデータ型のみを検査し、要素の値を考慮していません。例えば、文字列型であっても "1" "2" "3" のように整数表現であれば True を返してしまいます。

一方、pandas.api.types.is_integer_dtype は、データ型だけでなく要素の値も考慮し、真の整数型かどうかを判断します。

推奨される方法

pandas.Index.is_integer を使用する代わりに、以下の方法でインデックスが整数型かどうかを確認することを推奨します。

pandas.api.types.is_integer_dtype を使用する
isinstance(element, int) をすべての要素に対して実行する

pandas.api.types.is_integer_dtype を使用する

import pandas as pd

# 整数型のインデックスを作成
index = pd.Index([1, 2, 3, 4])

# インデックスが整数型かどうかを確認
result = pd.api.types.is_integer_dtype(index)
print(result)  # True

# 浮動小数点型のインデックスを作成
index = pd.Index([1.0, 2.0, 3.0, 4.0])

# インデックスが整数型かどうかを確認
result = pd.api.types.is_integer_dtype(index)
print(result)  # False

isinstance(element, int) をすべての要素に対して実行する

import pandas as pd

# 整数型のインデックスを作成
index = pd.Index([1, 2, 3, 4])

# インデックスが整数型かどうかを確認
result = all(isinstance(element, int) for element in index)
print(result)  # True

# 浮動小数点型のインデックスを作成
index = pd.Index([1.0, 2.0, 3.0, 4.0])

# インデックスが整数型かどうかを確認
result = all(isinstance(element, int) for element in index)
print(result)  # False

非推奨方法

import pandas as pd

# 整数型のインデックスを作成
index = pd.Index([1, 2, 3, 4])

# インデックスが整数型かどうかを確認
result = index.is_integer()
print(result)  # True

# 文字列型のインデックスを作成
index = pd.Index(["1", "2", "3", "4"])

# インデックスが整数型かどうかを確認
result = index.is_integer()
print(result)  # True  ※ 誤判定

説明

上記のコード例では、以下の3つの方法でインデックスが整数型かどうかを確認しています。

pandas.api.types.is_integer_dtype: データ型と要素の値を考慮し、真の整数型かどうかを判断します。
isinstance(element, int): 各要素に対して isinstance を実行し、すべての要素が True であれば True を返します。
pandas.Index.is_integer: インデックスのデータ型のみを検査し、要素の値を考慮していないため、誤判定が生じる可能性があります。

推奨される方法

真の整数型かどうかを判断するには、pandas.api.types.is_integer_dtype または isinstance(element, int) を使用するようにしてください。

他のバージョンでは動作が異なる場合がありますので、ご注意ください。
上記のコード例は、Python 3.8.10 と Pandas 1.4.0 で動作確認しています。

pandas.Index.is_integer は、Pandas データフレームのインデックスが すべて整数型かどうか を判断するメソッドでしたが、Pandas 2.0.0 で非推奨 となり、代わりに pandas.api.types.is_integer_dtype を使用するよう推奨されています。

非推奨理由

代替方法

pandas.api.types.is_integer_dtype を使用する
すべての要素に対して isinstance(element, int) を実行する

詳細

コード例

import pandas as pd

# 整数型のインデックスを作成
index = pd.Index([1, 2, 3, 4])

# インデックスが整数型かどうかを確認
result = pd.api.types.is_integer_dtype(index)
print(result)  # True

# 浮動小数点型のインデックスを作成
index = pd.Index([1.0, 2.0, 3.0, 4.0])

# インデックスが整数型かどうかを確認
result = pd.api.types.is_integer_dtype(index)
print(result)  # False

説明

pandas.api.types.is_integer_dtype は、データ型と要素の値を両方考慮して真の整数型かどうかを判断します。

コード例

import pandas as pd

# 整数型のインデックスを作成
index = pd.Index([1, 2, 3, 4])

# インデックスが整数型かどうかを確認
result = all(isinstance(element, int) for element in index)
print(result)  # True

# 文字列型のインデックスを作成
index = pd.Index(["1", "2", "3", "4"])

# インデックスが整数型かどうかを確認
result = all(isinstance(element, int) for element in index)
print(result)  # False

説明

isinstance(element, int) は、各要素に対して isinstance 関数を実行し、その要素が int 型かどうかを判断します。すべての要素が int 型であれば True を返し、そうでなければ False を返します。

どちらの方法が適切？

状況によって使い分けることをお勧めします。

インデックスの各要素の詳細な判定が必要な場合: isinstance(element, int) を使用する
簡潔に記述したい場合: pandas.api.types.is_integer_dtype を使用する

他のバージョンでは動作が異なる場合がありますので、ご注意ください。
上記のコード例は、Python 3.8.10 と Pandas 1.4.0 で動作確認しています。