dtoolkit.accessor.series.cols

dtoolkit.accessor.series.cols(s: Series, /, to_list: bool = False) → Hashable | None | list[Hashable | None]

An API to gather name and columns to one.

Parameters:

to_listbool, default False

If True, return a list type.

Returns:

Hashable, None or list of them

The name of the Series.

See also

pandas.Series.name

pandas.DataFrame.columns

dtoolkit.accessor.series.cols

dtoolkit.accessor.dataframe.cols

Examples

>>> import dtoolkit
>>> import pandas as pd

Get name.

>>> s = pd.Series(range(10), name="item")
>>> s.cols()
'item'
>>> s.cols(to_list=True)
['item']

Get columns.

>>> d = pd.DataFrame({"a": [1, 2], "b": [3, 4]})
>>> d.cols()
['a', 'b']