Deprecate is_object

Author: bang128

data.csv

@@ -0,0 +1,4 @@
+,,,1,2
+x,y,z,,
+1,3,5,,
+2,4,6,,

data.json

@@ -0,0 +1 @@
+"{\"schema\":{\"fields\":[{\"name\":\"index\",\"type\":\"integer\"},{\"name\":\"a\",\"type\":\"number\"},{\"name\":\"b\",\"type\":\"number\"}],\"primaryKey\":[\"index\"],\"pandas_version\":\"1.4.0\"},\"data\":[{\"index\":0,\"a\":{\"imag\":2.0,\"real\":1.0},\"b\":{\"imag\":6.0,\"real\":5.0}},{\"index\":1,\"a\":{\"imag\":4.0,\"real\":3.0},\"b\":{\"imag\":8.0,\"real\":7.0}}]}"

doc/source/user_guide/style.nbconvert.ipynb

@@ -637,6 +637,7 @@ Deprecations
 - :meth:`Index.is_floating` has been deprecated. Use :func:`pandas.api.types.is_float_dtype` instead (:issue:`50042`)
 - :meth:`Index.holds_integer` has been deprecated. Use :func:`pandas.api.types.infer_dtype` instead (:issue:`50243`)
 - :meth:`Index.is_categorical` has been deprecated. Use :func:`pandas.api.types.is_categorical_dtype` instead (:issue:`50042`)
+- :meth:`Index.is_object` has been deprecated. Use :func:`pandas.api.types.is_object_dtype` instead (:issue:`50042`)
 - :meth:`Index.is_interval` has been deprecated. Use :func:`pandas.api.types.is_intterval_dtype` instead (:issue:`50042`)
 -
 

doc/source/whatsnew/v2.0.0.rst

@@ -2258,7 +2258,7 @@ def is_boolean(self) -> bool:
         is_integer : Check if the Index only consists of integers (deprecated).
         is_floating : Check if the Index is a floating type (deprecated).
         is_numeric : Check if the Index only consists of numeric data.
-        is_object : Check if the Index is of the object dtype.
+        is_object : Check if the Index is of the object dtype. (deprecated)
         is_categorical : Check if the Index holds categorical data.
         is_interval : Check if the Index holds Interval objects (deprecated).
 
@@ -2302,7 +2302,7 @@ def is_integer(self) -> bool:
         is_boolean : Check if the Index only consists of booleans (deprecated).
         is_floating : Check if the Index is a floating type (deprecated).
         is_numeric : Check if the Index only consists of numeric data.
-        is_object : Check if the Index is of the object dtype.
+        is_object : Check if the Index is of the object dtype. (deprecated)
         is_categorical : Check if the Index holds categorical data (deprecated).
         is_interval : Check if the Index holds Interval objects (deprecated).
 
@@ -2350,7 +2350,7 @@ def is_floating(self) -> bool:
         is_boolean : Check if the Index only consists of booleans (deprecated).
         is_integer : Check if the Index only consists of integers (deprecated).
         is_numeric : Check if the Index only consists of numeric data.
-        is_object : Check if the Index is of the object dtype.
+        is_object : Check if the Index is of the object dtype. (deprecated)
         is_categorical : Check if the Index holds categorical data (deprecated).
         is_interval : Check if the Index holds Interval objects (deprecated).
 
@@ -2395,7 +2395,7 @@ def is_numeric(self) -> bool:
         is_boolean : Check if the Index only consists of booleans (deprecated).
         is_integer : Check if the Index only consists of integers (deprecated).
         is_floating : Check if the Index is a floating type (deprecated).
-        is_object : Check if the Index is of the object dtype.
+        is_object : Check if the Index is of the object dtype. (deprecated)
         is_categorical : Check if the Index holds categorical data (deprecated).
         is_interval : Check if the Index holds Interval objects (deprecated).
 
@@ -2427,6 +2427,8 @@ def is_numeric(self) -> bool:
     def is_object(self) -> bool:
         """
         Check if the Index is of the object dtype.
+        .. deprecated:: 2.0.0
+           Use `pandas.api.types.is_object_dtype` instead.
 
         Returns
         -------
@@ -2461,6 +2463,14 @@ def is_object(self) -> bool:
         >>> idx.is_object()
         False
         """
+
+        warnings.warn(
+            f"{type(self).__name__}.is_object is deprecated."
+            "Use pandas.api.types.is_object_dtype instead",
+            FutureWarning,
+            stacklevel=find_stack_level(),
+        )
+
         return is_object_dtype(self.dtype)
 
     @final
@@ -2483,7 +2493,7 @@ def is_categorical(self) -> bool:
         is_integer : Check if the Index only consists of integers (deprecated).
         is_floating : Check if the Index is a floating type (deprecated).
         is_numeric : Check if the Index only consists of numeric data.
-        is_object : Check if the Index is of the object dtype.
+        is_object : Check if the Index is of the object dtype. (deprecated)
         is_interval : Check if the Index holds Interval objects (deprecated).
 
         Examples
@@ -2536,7 +2546,7 @@ def is_interval(self) -> bool:
         is_integer : Check if the Index only consists of integers (deprecated).
         is_floating : Check if the Index is a floating type (deprecated).
         is_numeric : Check if the Index only consists of numeric data.
-        is_object : Check if the Index is of the object dtype.
+        is_object : Check if the Index is of the object dtype. (deprecated)
         is_categorical : Check if the Index holds categorical data (deprecated).
 
         Examples
@@ -5018,7 +5028,7 @@ def _is_memory_usage_qualified(self) -> bool:
         """
         Return a boolean if we need a qualified .info display.
         """
-        return self.is_object()
+        return is_object_dtype(self.dtype)
 
     def __contains__(self, key: Any) -> bool:
         """
@@ -5132,7 +5142,7 @@ def _can_hold_identifiers_and_holds_name(self, name) -> bool:
         https://github.com/pandas-dev/pandas/issues/19764
         """
         if (
-            self.is_object()
+            is_object_dtype(self.dtype)
             or is_string_dtype(self.dtype)
             or is_categorical_dtype(self.dtype)
         ):

pandas/core/indexes/base.py

@@ -829,6 +829,12 @@ def test_is_interval_is_deprecated(self, simple_index):
         with tm.assert_produces_warning(FutureWarning):
             idx.is_interval()
 
+    def test_is_object_is_deprecated(self, simple_index):
+        # GH50042
+        idx = simple_index
+        with tm.assert_produces_warning(FutureWarning):
+            idx.is_object()
+
 
 class NumericBase(Base):
     """

pandas/tests/indexes/common.py

@@ -13,6 +13,7 @@
 from pandas.core.dtypes.common import (
     is_float_dtype,
     is_integer_dtype,
+    is_object_dtype
 )
 
 import pandas as pd
@@ -618,7 +619,7 @@ def test_index_type_coercion(self, indexer):
 
             s2 = s.copy()
             indexer(s2)["0"] = 0
-            assert s2.index.is_object()
+            assert is_object_dtype(s2.index)
 
         for s in [Series(range(5), index=np.arange(5.0))]:
 
@@ -635,7 +636,7 @@ def test_index_type_coercion(self, indexer):
 
             s2 = s.copy()
             indexer(s2)["0"] = 0
-            assert s2.index.is_object()
+            assert is_object_dtype(s2.index)
 
 
 class TestMisc: