Make the MovingWindow constructor keyword-only

The `MovingWindow` constructor now takes all arguments as keyword-only
to avoid mistakes, such as confusing the `size` with the
`input_sampling_period`.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

RELEASE_NOTES.md

@@ -15,6 +15,8 @@
    actor = ConfigManagingActor(config_files=["config.toml"])
    ```
 
+* The `MovingWindow` now take all arguments as keyword-only to avoid mistakes.
+
 ## New Features
 
 - The `ConfigManagingActor` can now take multiple configuration files as input, allowing to override default configurations with custom configurations.

benchmarks/timeseries/periodic_feature_extractor.py

@@ -35,7 +35,9 @@ async def init_feature_extractor(
     # We only need the moving window to initialize the PeriodicFeatureExtractor class.
     lm_chan = Broadcast[Sample[Quantity]](name="lm_net_power")
     async with MovingWindow(
-        timedelta(seconds=1), lm_chan.new_receiver(), timedelta(seconds=1)
+        size=timedelta(seconds=1),
+        resampled_data_recv=lm_chan.new_receiver(),
+        input_sampling_period=timedelta(seconds=1),
     ) as moving_window:
         await lm_chan.new_sender().send(
             Sample(datetime.now(tz=timezone.utc), Quantity(0))

src/frequenz/sdk/timeseries/_moving_window.py

@@ -130,12 +130,12 @@ async def run() -> None:
 
     def __init__(  # pylint: disable=too-many-arguments
         self,
+        *,
         size: timedelta,
         resampled_data_recv: Receiver[Sample[Quantity]],
         input_sampling_period: timedelta,
         resampler_config: ResamplerConfig | None = None,
         align_to: datetime = UNIX_EPOCH,
-        *,
         name: str | None = None,
     ) -> None:
         """

tests/timeseries/test_moving_window.py

@@ -59,7 +59,11 @@ def init_moving_window(
     """
     lm_chan = Broadcast[Sample[Quantity]](name="lm_net_power")
     lm_tx = lm_chan.new_sender()
-    window = MovingWindow(size, lm_chan.new_receiver(), timedelta(seconds=1))
+    window = MovingWindow(
+        size=size,
+        resampled_data_recv=lm_chan.new_receiver(),
+        input_sampling_period=timedelta(seconds=1),
+    )
     return window, lm_tx
 
 

tests/timeseries/test_periodic_feature_extractor.py

@@ -60,7 +60,9 @@ async def init_feature_extractor_no_data(
     # We only need the moving window to initialize the PeriodicFeatureExtractor class.
     lm_chan = Broadcast[Sample[Quantity]](name="lm_net_power")
     moving_window = MovingWindow(
-        timedelta(seconds=1), lm_chan.new_receiver(), timedelta(seconds=1)
+        size=timedelta(seconds=1),
+        resampled_data_recv=lm_chan.new_receiver(),
+        input_sampling_period=timedelta(seconds=1),
     )
     async with moving_window:
         await lm_chan.new_sender().send(