Skip to content

DOC: Add GL08 for pandas.intervalIndex.left #58687

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 3 commits into from
May 12, 2024
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: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DataFrame.min RT03" \
-i "pandas.DataFrame.plot PR02,SA01" \
-i "pandas.Grouper PR02" \
-i "pandas.IntervalIndex.left GL08" \
-i "pandas.MultiIndex PR01" \
-i "pandas.MultiIndex.append PR07,SA01" \
-i "pandas.MultiIndex.copy PR07,RT03,SA01" \
Expand Down
33 changes: 33 additions & 0 deletions pandas/core/indexes/interval.py
Original file line number Diff line number Diff line change
Expand Up @@ -842,6 +842,39 @@ def _is_comparable_dtype(self, dtype: DtypeObj) -> bool:

@cache_readonly
def left(self) -> Index:
"""
Return left bounds of the intervals in the IntervalIndex.

The left bounds of each interval in the IntervalIndex are
returned as an Index. The datatype of the left bounds is the
same as the datatype of the endpoints of the intervals.

Returns
-------
Index
An Index containing the left bounds of the intervals.

See Also
--------
IntervalIndex.right : Return the right bounds of the intervals
in the IntervalIndex.
IntervalIndex.mid : Return the mid-point of the intervals in
the IntervalIndex.
IntervalIndex.length : Return the length of the intervals in
the IntervalIndex.

Examples
--------
>>> iv_idx = pd.IntervalIndex.from_arrays([1, 2, 3], [4, 5, 6], closed="right")
>>> iv_idx.left
Index([1, 2, 3], dtype='int64')

>>> iv_idx = pd.IntervalIndex.from_tuples(
... [(1, 4), (2, 5), (3, 6)], closed="left"
... )
>>> iv_idx.left
Index([1, 2, 3], dtype='int64')
"""
return Index(self._data.left, copy=False)

@cache_readonly
Expand Down
Loading