feat(python!): Default to raising on out-of-bounds indices in all get/gather operations

[ritchie46]

Closes #15240

The default behavior was inconsistent between get and gather operations in various places. Now all such operations will raise by default.

Pass null_on_oob=True to restore previous behavior.

Example

Before:

>>> s = pl.Series([[0, 1, 2], [0]])
>>> s.list.get(1)
shape: (2,)
Series: '' [i64]
[
        1
        null
]

After:

>>> s.list.get(1)
Traceback (most recent call last):
...
polars.exceptions.ComputeError: get index is out of bounds

Use instead:

>>> s.list.get(1, null_on_oob=True)
shape: (2,)
Series: '' [i64]
[
        1
        null
]

[stinodego]

Thanks! Could you also add null_on_oob to Expr/Series.get/gather? Or keep the issue open for post-1.0.0?

At least the behavior is consistent now so we're set for 1.0.0 👍

[ritchie46]

Adding the functionality can be done later. Is very low priority AFAIC.

[ritchie46]

Added a feature request.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.39%. Comparing base (0f1eb18) to head (34b82fe).

❗ Current head 34b82fe differs from pull request most recent head 885f781

Please upload reports for the commit 885f781 to get more accurate results.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #16841      +/-   ##
==========================================
- Coverage   81.40%   81.39%   -0.02%     
==========================================
  Files        1425     1425              
  Lines      187627   187627              
  Branches     2702     2702              
==========================================
- Hits       152738   152717      -21     
- Misses      34393    34414      +21     
  Partials      496      496              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.