124 lines
2.8 KiB
Python
124 lines
2.8 KiB
Python
|
"""Functions to determine if an object is a dataframe or series."""
|
||
|
|
|
||
|
|
# Authors: The scikit-learn developers
|
||
|
|
# SPDX-License-Identifier: BSD-3-Clause
|
||
|
|
|
||
|
|
import sys
|
||
|
|
|
||
|
|
|
||
|
|
def is_df_or_series(X):
|
||
|
|
"""Return True if the X is a dataframe or series.
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
----------
|
||
|
|
X : {array-like, dataframe}
|
||
|
|
The array-like or dataframe object to check.
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
bool
|
||
|
|
True if the X is a dataframe or series, False otherwise.
|
||
|
|
"""
|
||
|
|
return is_pandas_df_or_series(X) or is_polars_df_or_series(X) or is_pyarrow_data(X)
|
||
|
|
|
||
|
|
|
||
|
|
def is_pandas_df_or_series(X):
|
||
|
|
"""Return True if the X is a pandas dataframe or series.
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
----------
|
||
|
|
X : {array-like, dataframe}
|
||
|
|
The array-like or dataframe object to check.
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
bool
|
||
|
|
True if the X is a pandas dataframe or series, False otherwise.
|
||
|
|
"""
|
||
|
|
try:
|
||
|
|
pd = sys.modules["pandas"]
|
||
|
|
except KeyError:
|
||
|
|
return False
|
||
|
|
return isinstance(X, (pd.DataFrame, pd.Series))
|
||
|
|
|
||
|
|
|
||
|
|
def is_pandas_df(X):
|
||
|
|
"""Return True if the X is a pandas dataframe.
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
----------
|
||
|
|
X : {array-like, dataframe}
|
||
|
|
The array-like or dataframe object to check.
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
bool
|
||
|
|
True if the X is a pandas dataframe, False otherwise.
|
||
|
|
"""
|
||
|
|
try:
|
||
|
|
pd = sys.modules["pandas"]
|
||
|
|
except KeyError:
|
||
|
|
return False
|
||
|
|
return isinstance(X, pd.DataFrame)
|
||
|
|
|
||
|
|
|
||
|
|
def is_pyarrow_data(X):
|
||
|
|
"""Return True if the X is a pyarrow Table, RecordBatch, Array or ChunkedArray.
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
----------
|
||
|
|
X : {array-like, dataframe}
|
||
|
|
The array-like or dataframe object to check.
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
bool
|
||
|
|
True if the X is a pyarrow Table, RecordBatch, Array or ChunkedArray,
|
||
|
|
False otherwise.
|
||
|
|
"""
|
||
|
|
try:
|
||
|
|
pa = sys.modules["pyarrow"]
|
||
|
|
except KeyError:
|
||
|
|
return False
|
||
|
|
return isinstance(X, (pa.Table, pa.RecordBatch, pa.Array, pa.ChunkedArray))
|
||
|
|
|
||
|
|
|
||
|
|
def is_polars_df_or_series(X):
|
||
|
|
"""Return True if the X is a polars dataframe or series.
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
----------
|
||
|
|
X : {array-like, dataframe}
|
||
|
|
The array-like or dataframe object to check.
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
bool
|
||
|
|
True if the X is a polars dataframe or series, False otherwise.
|
||
|
|
"""
|
||
|
|
try:
|
||
|
|
pl = sys.modules["polars"]
|
||
|
|
except KeyError:
|
||
|
|
return False
|
||
|
|
return isinstance(X, (pl.DataFrame, pl.Series))
|
||
|
|
|
||
|
|
|
||
|
|
def is_polars_df(X):
|
||
|
|
"""Return True if the X is a polars dataframe.
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
----------
|
||
|
|
X : {array-like, dataframe}
|
||
|
|
The array-like or dataframe object to check.
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
bool
|
||
|
|
True if the X is a polarsdataframe, False otherwise.
|
||
|
|
"""
|
||
|
|
try:
|
||
|
|
pl = sys.modules["polars"]
|
||
|
|
except KeyError:
|
||
|
|
return False
|
||
|
|
return isinstance(X, pl.DataFrame)
|