polars.Series.list.gather#

Series.list.gather( indices: Series | list[int] | list[list[int]], *, null_on_oob: bool = False, ) → Series[source]#

Take sublists by multiple indices.

The indices may be defined in a single column, or by sublists in another column of dtype List.

Parameters:

indices: Indices to return per sublist
null_on_oob: Behavior if an index is out of bounds: True -> set as null False -> raise an error Note that defaulting to raising an error is much cheaper

Examples

>>> s = pl.Series("a", [[3, 2, 1], [], [1, 2]])
>>> s.list.gather([0, 2], null_on_oob=True)
shape: (3,)
Series: 'a' [list[i64]]
[
    [3, 1]
    [null, null]
    [1, null]
]