polars.DataFrame.sum#

DataFrame.sum( *, axis: Literal[0] = None, null_strategy: NullStrategy = 'ignore', ) → Self[source]#

DataFrame.sum(*, axis: Literal[1], null_strategy: NullStrategy = 'ignore') → Series

DataFrame.sum(*, axis: int, null_strategy: NullStrategy = 'ignore') → Self | Series

Aggregate the columns of this DataFrame to their sum value.

Parameters:

axis: Either 0 (vertical) or 1 (horizontal).

Deprecated since version 0.19.14: This argument will be removed in a future version. This method will only support vertical aggregation, as if axis were set to 0. To perform horizontal aggregation, use sum_horizontal().
null_strategy{‘ignore’, ‘propagate’}: This argument is only used if axis == 1.

Deprecated since version 0.19.14: This argument will be removed in a future version.

Examples

>>> df = pl.DataFrame(
...     {
...         "foo": [1, 2, 3],
...         "bar": [6, 7, 8],
...         "ham": ["a", "b", "c"],
...     }
... )
>>> df.sum()
shape: (1, 3)
┌─────┬─────┬──────┐
│ foo ┆ bar ┆ ham  │
│ --- ┆ --- ┆ ---  │
│ i64 ┆ i64 ┆ str  │
╞═════╪═════╪══════╡
│ 6   ┆ 21  ┆ null │
└─────┴─────┴──────┘