Skip to content

Commit 5cd994c

Browse files
Reworked documentation
Co-authored-by: André Correia <[email protected]>
1 parent 2518696 commit 5cd994c

File tree

1 file changed

+129
-0
lines changed

1 file changed

+129
-0
lines changed

pandas/core/resample.py

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,6 +1201,97 @@ def median(
12011201
):
12021202
return self._downsample("median", numeric_only=numeric_only, skipna=skipna)
12031203

1204+
@final
1205+
@doc(GroupBy.mean)
1206+
def mean(
1207+
self,
1208+
numeric_only: bool = False,
1209+
skipna: bool = True,
1210+
engine: Literal["cython", "numba"] | None = None,
1211+
engine_kwargs: dict[str, bool] | None = None,
1212+
):
1213+
return self._downsample(
1214+
"mean",
1215+
numeric_only=numeric_only,
1216+
skipna=skipna,
1217+
engine=engine,
1218+
engine_kwargs=engine_kwargs,
1219+
)
1220+
1221+
@final
1222+
@doc(GroupBy.min)
1223+
def min(
1224+
self,
1225+
numeric_only: bool = False,
1226+
min_count: int = -1,
1227+
skipna: bool = True,
1228+
engine: Literal["cython", "numba"] | None = None,
1229+
engine_kwargs: dict[str, bool] | None = None,
1230+
):
1231+
return self._downsample(
1232+
"min",
1233+
numeric_only=numeric_only,
1234+
min_count=min_count,
1235+
skipna=skipna,
1236+
engine=engine,
1237+
engine_kwargs=engine_kwargs,
1238+
)
1239+
1240+
@final
1241+
@doc(GroupBy.max)
1242+
def max(
1243+
self,
1244+
numeric_only: bool = False,
1245+
min_count: int = -1,
1246+
skipna: bool = True,
1247+
engine: Literal["cython", "numba"] | None = None,
1248+
engine_kwargs: dict[str, bool] | None = None,
1249+
):
1250+
return self._downsample(
1251+
"max",
1252+
numeric_only=numeric_only,
1253+
min_count=min_count,
1254+
skipna=skipna,
1255+
engine=engine,
1256+
engine_kwargs=engine_kwargs,
1257+
)
1258+
1259+
@final
1260+
@doc(GroupBy.sum)
1261+
def sum(
1262+
self,
1263+
numeric_only: bool = False,
1264+
min_count: int = 0,
1265+
skipna: bool = True,
1266+
engine: Literal["cython", "numba"] | None = None,
1267+
engine_kwargs: dict[str, bool] | None = None,
1268+
):
1269+
return self._downsample(
1270+
"sum",
1271+
numeric_only=numeric_only,
1272+
min_count=min_count,
1273+
skipna=skipna,
1274+
engine=engine,
1275+
engine_kwargs=engine_kwargs,
1276+
)
1277+
1278+
@final
1279+
@doc(GroupBy.prod)
1280+
def prod(self, numeric_only: bool = False, min_count: int = 0, skipna: bool = True):
1281+
return self._downsample(
1282+
"prod", numeric_only=numeric_only, min_count=min_count, skipna=skipna
1283+
)
1284+
1285+
@final
1286+
@doc(GroupBy.any)
1287+
def any(self, skipna: bool = True):
1288+
return self._downsample("any", skipna=skipna)
1289+
1290+
@final
1291+
@doc(GroupBy.all)
1292+
def all(self, skipna: bool = True):
1293+
return self._downsample("all", skipna=skipna)
1294+
12041295
@final
12051296
def mean(
12061297
self,
@@ -1351,6 +1442,44 @@ def var(
13511442
"""
13521443
return self._downsample("var", ddof=ddof, numeric_only=numeric_only)
13531444

1445+
@final
1446+
@doc(GroupBy.std)
1447+
def std(
1448+
self,
1449+
ddof: int = 1,
1450+
engine: Literal["cython", "numba"] | None = None,
1451+
engine_kwargs: dict[str, bool] | None = None,
1452+
numeric_only: bool = False,
1453+
skipna: bool = True,
1454+
):
1455+
return self._downsample(
1456+
"std",
1457+
ddof=ddof,
1458+
engine=engine,
1459+
engine_kwargs=engine_kwargs,
1460+
numeric_only=numeric_only,
1461+
skipna=skipna,
1462+
)
1463+
1464+
@final
1465+
@doc(GroupBy.var)
1466+
def var(
1467+
self,
1468+
ddof: int = 1,
1469+
engine: Literal["cython", "numba"] | None = None,
1470+
engine_kwargs: dict[str, bool] | None = None,
1471+
numeric_only: bool = False,
1472+
skipna: bool = True,
1473+
):
1474+
return self._downsample(
1475+
"var",
1476+
ddof=ddof,
1477+
engine=engine,
1478+
engine_kwargs=engine_kwargs,
1479+
numeric_only=numeric_only,
1480+
skipna=skipna,
1481+
)
1482+
13541483
@final
13551484
@doc(GroupBy.sem)
13561485
def sem(

0 commit comments

Comments
 (0)