Skip to content

Commit eb49322

Browse files
committed
Make the MovingWindow class public
The MovingWindow is now exported in the frequenz.sdk.timeseries package. The ResamplerConfig class is also now made public via the same package, as it is part of the MovingWindow's public interface. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent ac1ee42 commit eb49322

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

RELEASE_NOTES.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@
4040

4141
* `MovingWindow`
4242

43+
* The class is now publicly available in the `frequenz.sdk.timeseries` package.
44+
4345
* Accept the `size` parameter as `timedelta` instead of `int` (#269).
4446

4547
This change allows users to define the time span of the moving window more intuitively, representing the duration over which samples will be stored.
@@ -54,6 +56,8 @@
5456

5557
* `Resampler`
5658

59+
* The `ResamplerConfig` class is now publicly available in the `frequenz.sdk.timeseries` package.
60+
5761
* The `ResamplerConfig` now takes the resampling period as a `timedelta`. The configuration was renamed from `resampling_period_s` to `resampling_period` accordingly.
5862

5963
* The `SourceProperties` of the resampler now uses a `timedelta` for the input sampling period. The attribute was renamed from `sampling_period_s` to `sampling_period` accordingly.

src/frequenz/sdk/timeseries/__init__.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,13 @@
3636
"""
3737

3838
from ._base_types import UNIX_EPOCH, Sample, Sample3Phase
39-
40-
__all__ = ["Sample", "Sample3Phase", "UNIX_EPOCH"]
39+
from ._moving_window import MovingWindow
40+
from ._resampling import ResamplerConfig
41+
42+
__all__ = [
43+
"MovingWindow",
44+
"ResamplerConfig",
45+
"Sample",
46+
"Sample3Phase",
47+
"UNIX_EPOCH",
48+
]

0 commit comments

Comments
 (0)