Class ListAccessor (1.24.0)

Version 1.24.0

• 1.29.0 (latest)
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.1
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.1
• 0.19.2
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0

ListAccessor(
    data=None,
    index: vendored_pandas_typing.Axes | None = None,
    dtype: typing.Optional[
        bigframes.dtypes.DtypeString | bigframes.dtypes.Dtype
    ] = None,
    name: str | None = None,
    copy: typing.Optional[bool] = None,
    *,
    session: typing.Optional[bigframes.session.Session] = None
)

Accessor object for list data properties of the Series values.

Methods

__getitem__

__getitem__(key: typing.Union[int, slice]) -> bigframes.series.Series

Index or slice lists in the Series.

Examples:

>>> import bigframes.pandas as bpd
>>> import pyarrow as pa
>>> bpd.options.display.progress_bar = None
>>> s = bpd.Series(
...     [
...         [1, 2, 3],
...         [3],
...     ],
...     dtype=bpd.ArrowDtype(pa.list_(pa.int64())),
... )
>>> s.list[0]
0    1
1    3
dtype: Int64

Parameter
Name	Description
key	int slice Index or slice of indices to access from each list. For integer indices, only non-negative values are accepted. For slices, you must use a non-negative start, a non-negative end, and a step of 1.

Returns
Type	Description
bigframes.series.Series	The list at requested index.

len

len()

Compute the length of each list in the Series.

See Also:

- `StringMethods.len` : Compute the length of each element in the Series/Index.

Examples:

>>> import bigframes.pandas as bpd
>>> import pyarrow as pa
>>> bpd.options.display.progress_bar = None
>>> s = bpd.Series(
...     [
...         [1, 2, 3],
...         [3],
...     ],
...     dtype=bpd.ArrowDtype(pa.list_(pa.int64())),
... )
>>> s.list.len()
0    3
1    1
dtype: Int64

Returns
Type	Description
bigframes.series.Series	A Series or Index of integer values indicating the length of each element in the Series or Index.