Skip to content

API: Added is_extension_array_dtype #24771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/source/api/general_utility_functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Dtype introspection
api.types.is_datetime64_ns_dtype
api.types.is_datetime64tz_dtype
api.types.is_extension_type
api.types.is_extension_array_dtype
api.types.is_float_dtype
api.types.is_int64_dtype
api.types.is_integer_dtype
Expand Down
10 changes: 5 additions & 5 deletions pandas/core/dtypes/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
is_categorical_dtype, is_complex, is_complex_dtype,
is_datetime64_any_dtype, is_datetime64_dtype, is_datetime64_ns_dtype,
is_datetime64tz_dtype, is_datetimetz, is_dict_like, is_dtype_equal,
is_extension_type, is_file_like, is_float, is_float_dtype, is_hashable,
is_int64_dtype, is_integer, is_integer_dtype, is_interval,
is_interval_dtype, is_iterator, is_list_like, is_named_tuple, is_number,
is_numeric_dtype, is_object_dtype, is_period, is_period_dtype, is_re,
is_re_compilable, is_scalar, is_signed_integer_dtype, is_sparse,
is_extension_array_dtype, is_extension_type, is_file_like, is_float,
is_float_dtype, is_hashable, is_int64_dtype, is_integer, is_integer_dtype,
is_interval, is_interval_dtype, is_iterator, is_list_like, is_named_tuple,
is_number, is_numeric_dtype, is_object_dtype, is_period, is_period_dtype,
is_re, is_re_compilable, is_scalar, is_signed_integer_dtype, is_sparse,
is_string_dtype, is_timedelta64_dtype, is_timedelta64_ns_dtype,
is_unsigned_integer_dtype, pandas_dtype)
24 changes: 23 additions & 1 deletion pandas/core/dtypes/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -1700,15 +1700,21 @@ def is_extension_type(arr):


def is_extension_array_dtype(arr_or_dtype):
"""Check if an object is a pandas extension array type.
"""
Check if an object is a pandas extension array type.

See the :ref:`Use Guide <extending.extension-types>` for more.

Parameters
----------
arr_or_dtype : object
For array-like input, the ``.dtype`` attribute will
be extracted.

Returns
-------
bool
Whether the `arr_or_dtype` is an extension array type.

Notes
-----
Expand All @@ -1718,9 +1724,25 @@ def is_extension_array_dtype(arr_or_dtype):
* Categorical
* Sparse
* Interval
* Period
* DatetimeArray
* TimedeltaArray

Third-party libraries may implement arrays or types satisfying
this interface as well.

Examples
--------
>>> from pandas.api.types import is_extension_array_dtype
>>> arr = pd.Categorical(['a', 'b'])
>>> is_extension_array_dtype(arr)
True
>>> is_extension_array_dtype(arr.dtype)
True

>>> arr = np.array(['a', 'b'])
>>> is_extension_array_dtype(arr.dtype)
False
"""
dtype = getattr(arr_or_dtype, 'dtype', arr_or_dtype)
return (isinstance(dtype, ExtensionDtype) or
Expand Down
3 changes: 2 additions & 1 deletion pandas/tests/api/test_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ class TestTypes(Base):
'is_dict_like', 'is_iterator', 'is_file_like',
'is_list_like', 'is_hashable', 'is_array_like',
'is_named_tuple',
'pandas_dtype', 'union_categoricals', 'infer_dtype']
'pandas_dtype', 'union_categoricals', 'infer_dtype',
'is_extension_array_dtype']
deprecated = ['is_period', 'is_datetimetz']
dtypes = ['CategoricalDtype', 'DatetimeTZDtype',
'PeriodDtype', 'IntervalDtype']
Expand Down