pandas.api.typing.DataFrameGroupBy#

class pandas.api.typing.DataFrameGroupBy( obj, keys=None, level=None, grouper=None, exclusions=None, selection=None, as_index=True, sort=True, group_keys=True, observed=True, dropna=True, )[source]#

Groupby object for a DataFrame.

Returned by DataFrame.groupby. Selecting a single column returns a SeriesGroupBy. This is not meant to be instantiated directly.

See GroupBy for the available methods and Group by: split-apply-combine for the user guide.

See also

pandas.DataFrame.groupby: Group DataFrame using a mapper or by a Series of columns.
pandas.api.typing.SeriesGroupBy: Groupby object for a Series.

Examples

>>> df = pd.DataFrame({"key": ["a", "a", "b"], "val": [1, 2, 3]})
>>> df.groupby("key").sum()
     val
key
a      3
b      3