Pass the whole ResamplerConfig to the ResamplingFunction

Instead of only passing the resampling period, we pass the whole
ResamplerConfig so the resampling function has more information on how
the resampling is being done to make better decisions.

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

Author: llucax

benchmarks/timeseries/resampling.py

@@ -12,7 +12,7 @@
 
 
 def nop(  # pylint: disable=unused-argument
-    samples: Sequence[Sample], resampling_period_s: float
+    samples: Sequence[Sample], resampler_config: ResamplerConfig
 ) -> float:
     """Return 0.0."""
     return 0.0

src/frequenz/sdk/timeseries/_resampling.py

@@ -71,7 +71,7 @@
 """
 
 
-ResamplingFunction = Callable[[Sequence[Sample], float], float]
+ResamplingFunction = Callable[[Sequence[Sample], "ResamplerConfig"], float]
 """Resampling function type.
 
 A resampling function produces a new sample based on a list of pre-existing
@@ -86,23 +86,23 @@
 timestamp in the input data).
 
 Args:
-    input_samples (Sequence[Sample]): the sequence of pre-existing samples.
-    resampling_period_s (float): the period in seconds (i.e. how ofter a new sample is
-        produced.
+    input_samples (Sequence[Sample]): The sequence of pre-existing samples.
+    resampler_config (ResamplerConfig): The configuration of the resampling
+        calling this function.
 
 Returns:
     new_sample (float): The value of new sample produced after the resampling.
 """
 
 
 # pylint: disable=unused-argument
-def average(samples: Sequence[Sample], resampling_period_s: float) -> float:
+def average(samples: Sequence[Sample], resampler_config: ResamplerConfig) -> float:
     """Calculate average of all the provided values.
 
     Args:
         samples: The samples to apply the average to. It must be non-empty.
-        resampling_period_s: The time it passes between resampled data is
-            produced (in seconds).
+        resampler_config: The configuration of the resampler calling this
+            function.
 
     Returns:
         The average of all `samples` values.