dtoolkit.accessor.dataframe.cols

dtoolkit.accessor.dataframe.cols(df: DataFrame, /, to_list: bool = False) → list[Hashable]

An API to gather name and columns to one.

Parameters:

to_listbool, default False

This option doesn’t work, and it’s used to fit dtoolkit.accessor.series.cols() arguments.

Returns:

list of Hashable

The column names.

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'

Get columns.

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