Revert inclusive default change of IntervalDtype (#47367)

Author: phofl

doc/source/reference/arrays.rst

@@ -304,6 +304,7 @@ Properties
    :toctree: api/
 
    Interval.inclusive
+   Interval.closed
    Interval.closed_left
    Interval.closed_right
    Interval.is_empty

pandas/_libs/interval.pyi

@@ -65,6 +65,8 @@ class Interval(IntervalMixin, Generic[_OrderableT]):
     def right(self: Interval[_OrderableT]) -> _OrderableT: ...
     @property
     def inclusive(self) -> IntervalClosedType: ...
+    @property
+    def closed(self) -> IntervalClosedType: ...
     mid: _MidDescriptor
     length: _LengthDescriptor
     def __init__(

pandas/_libs/interval.pyx

@@ -9,6 +9,8 @@ from cpython.datetime cimport (
     import_datetime,
 )
 
+from pandas.util._exceptions import find_stack_level
+
 import_datetime()
 
 cimport cython
@@ -229,7 +231,7 @@ def _warning_interval(inclusive: str | None = None, closed: None | lib.NoDefault
             stacklevel=2,
         )
         if closed is None:
-            inclusive = "both"
+            inclusive = "right"
         elif closed in ("both", "neither", "left", "right"):
             inclusive = closed
         else:
@@ -364,7 +366,7 @@ cdef class Interval(IntervalMixin):
         inclusive, closed = _warning_interval(inclusive, closed)
 
         if inclusive is None:
-            inclusive = "both"
+            inclusive = "right"
 
         if inclusive not in VALID_CLOSED:
             raise ValueError(f"invalid option for 'inclusive': {inclusive}")
@@ -379,6 +381,21 @@ cdef class Interval(IntervalMixin):
         self.right = right
         self.inclusive = inclusive
 
+    @property
+    def closed(self):
+        """
+        Whether the interval is closed on the left-side, right-side, both or
+        neither.
+
+        .. deprecated:: 1.5.0
+        """
+        warnings.warn(
+            "Attribute `closed` is deprecated in favor of `inclusive`.",
+            FutureWarning,
+            stacklevel=find_stack_level(),
+        )
+        return self.inclusive
+
     def _validate_endpoint(self, endpoint):
         # GH 23013
         if not (is_integer_object(endpoint) or is_float_object(endpoint) or

pandas/_libs/intervaltree.pxi.in

@@ -69,7 +69,7 @@ cdef class IntervalTree(IntervalMixin):
         inclusive, closed = _warning_interval(inclusive, closed)
 
         if inclusive is None:
-            inclusive = "both"
+            inclusive = "right"
 
         if inclusive not in ['left', 'right', 'both', 'neither']:
             raise ValueError("invalid option for 'inclusive': %s" % inclusive)

pandas/core/arrays/arrow/_arrow_utils.py

@@ -6,9 +6,8 @@
 import numpy as np
 import pyarrow
 
-from pandas._libs import lib
-from pandas._libs.interval import _warning_interval
 from pandas.errors import PerformanceWarning
+from pandas.util._decorators import deprecate_kwarg
 from pandas.util._exceptions import find_stack_level
 
 from pandas.core.arrays.interval import VALID_CLOSED
@@ -105,15 +104,10 @@ def to_pandas_dtype(self):
 
 
 class ArrowIntervalType(pyarrow.ExtensionType):
-    def __init__(
-        self,
-        subtype,
-        inclusive: str | None = None,
-        closed: None | lib.NoDefault = lib.no_default,
-    ) -> None:
+    @deprecate_kwarg(old_arg_name="closed", new_arg_name="inclusive")
+    def __init__(self, subtype, inclusive: str) -> None:
         # attributes need to be set first before calling
         # super init (as that calls serialize)
-        inclusive, closed = _warning_interval(inclusive, closed)
         assert inclusive in VALID_CLOSED
         self._closed = inclusive
         if not isinstance(subtype, pyarrow.DataType):
@@ -131,6 +125,15 @@ def subtype(self):
     def inclusive(self):
         return self._closed
 
+    @property
+    def closed(self):
+        warnings.warn(
+            "Attribute `closed` is deprecated in favor of `inclusive`.",
+            FutureWarning,
+            stacklevel=find_stack_level(),
+        )
+        return self._closed
+
     def __arrow_ext_serialize__(self):
         metadata = {"subtype": str(self.subtype), "inclusive": self.inclusive}
         return json.dumps(metadata).encode()

pandas/core/arrays/interval.py

@@ -15,6 +15,7 @@
     cast,
     overload,
 )
+import warnings
 
 import numpy as np
 
@@ -25,7 +26,6 @@
     VALID_CLOSED,
     Interval,
     IntervalMixin,
-    _warning_interval,
     intervals_to_interval_bounds,
 )
 from pandas._libs.missing import NA
@@ -43,8 +43,10 @@
 from pandas.errors import IntCastingNaNError
 from pandas.util._decorators import (
     Appender,
+    deprecate_kwarg,
     deprecate_nonkeyword_arguments,
 )
+from pandas.util._exceptions import find_stack_level
 
 from pandas.core.dtypes.cast import LossySetitemError
 from pandas.core.dtypes.common import (
@@ -220,16 +222,15 @@ def ndim(self) -> Literal[1]:
     # ---------------------------------------------------------------------
     # Constructors
 
+    @deprecate_kwarg(old_arg_name="closed", new_arg_name="inclusive")
     def __new__(
         cls: type[IntervalArrayT],
         data,
         inclusive: str | None = None,
-        closed: None | lib.NoDefault = lib.no_default,
         dtype: Dtype | None = None,
         copy: bool = False,
         verify_integrity: bool = True,
     ):
-        inclusive, closed = _warning_interval(inclusive, closed)
 
         data = extract_array(data, extract_numpy=True)
 
@@ -267,24 +268,22 @@ def __new__(
         )
 
     @classmethod
+    @deprecate_kwarg(old_arg_name="closed", new_arg_name="inclusive")
     def _simple_new(
         cls: type[IntervalArrayT],
         left,
         right,
         inclusive=None,
-        closed: None | lib.NoDefault = lib.no_default,
         copy: bool = False,
         dtype: Dtype | None = None,
         verify_integrity: bool = True,
     ) -> IntervalArrayT:
         result = IntervalMixin.__new__(cls)
 
-        inclusive, closed = _warning_interval(inclusive, closed)
-
         if inclusive is None and isinstance(dtype, IntervalDtype):
             inclusive = dtype.inclusive
 
-        inclusive = inclusive or "both"
+        inclusive = inclusive or "right"
 
         left = ensure_index(left, copy=copy)
         right = ensure_index(right, copy=copy)
@@ -424,13 +423,17 @@ def _from_factorized(
             ),
         }
     )
+    @deprecate_kwarg(old_arg_name="closed", new_arg_name="inclusive")
     def from_breaks(
         cls: type[IntervalArrayT],
         breaks,
-        inclusive="both",
+        inclusive: IntervalClosedType | None = None,
         copy: bool = False,
         dtype: Dtype | None = None,
     ) -> IntervalArrayT:
+        if inclusive is None:
+            inclusive = "right"
+
         breaks = _maybe_convert_platform_interval(breaks)
 
         return cls.from_arrays(
@@ -501,14 +504,19 @@ def from_breaks(
             ),
         }
     )
+    @deprecate_kwarg(old_arg_name="closed", new_arg_name="inclusive")
     def from_arrays(
         cls: type[IntervalArrayT],
         left,
         right,
-        inclusive="both",
+        inclusive: IntervalClosedType | None = None,
         copy: bool = False,
         dtype: Dtype | None = None,
     ) -> IntervalArrayT:
+
+        if inclusive is None:
+            inclusive = "right"
+
         left = _maybe_convert_platform_interval(left)
         right = _maybe_convert_platform_interval(right)
 
@@ -570,13 +578,17 @@ def from_arrays(
             ),
         }
     )
+    @deprecate_kwarg(old_arg_name="closed", new_arg_name="inclusive")
     def from_tuples(
         cls: type[IntervalArrayT],
         data,
-        inclusive="both",
+        inclusive=None,
         copy: bool = False,
         dtype: Dtype | None = None,
     ) -> IntervalArrayT:
+        if inclusive is None:
+            inclusive = "right"
+
         if len(data):
             left, right = [], []
         else:
@@ -1355,6 +1367,19 @@ def inclusive(self) -> IntervalClosedType:
         """
         return self.dtype.inclusive
 
+    @property
+    def closed(self) -> IntervalClosedType:
+        """
+        Whether the intervals are closed on the left-side, right-side, both or
+        neither.
+        """
+        warnings.warn(
+            "Attribute `closed` is deprecated in favor of `inclusive`.",
+            FutureWarning,
+            stacklevel=find_stack_level(),
+        )
+        return self.dtype.inclusive
+
     _interval_shared_docs["set_closed"] = textwrap.dedent(
         """
         Return an %(klass)s identical to the current one, but closed on the
@@ -1395,6 +1420,7 @@ def inclusive(self) -> IntervalClosedType:
             ),
         }
     )
+    @deprecate_kwarg(old_arg_name="closed", new_arg_name="inclusive")
     def set_closed(
         self: IntervalArrayT, inclusive: IntervalClosedType
     ) -> IntervalArrayT:

pandas/core/dtypes/dtypes.py

@@ -10,6 +10,7 @@
     MutableMapping,
     cast,
 )
+import warnings
 
 import numpy as np
 import pytz
@@ -40,6 +41,7 @@
     npt,
     type_t,
 )
+from pandas.util._exceptions import find_stack_level
 
 from pandas.core.dtypes.base import (
     ExtensionDtype,
@@ -1176,6 +1178,15 @@ def _can_hold_na(self) -> bool:
     def inclusive(self):
         return self._closed
 
+    @property
+    def closed(self):
+        warnings.warn(
+            "Attribute `closed` is deprecated in favor of `inclusive`.",
+            FutureWarning,
+            stacklevel=find_stack_level(),
+        )
+        return self._closed
+
     @property
     def subtype(self):
         """