Hide the resampling module and Source/Sink from timeseries

We are not convinced about the current implementation using a callback
(Sink), so we don't want to expose this just yet.

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

Author: llucax

examples/resampling.py

@@ -17,8 +17,8 @@
     DataSourcingActor,
 )
 from frequenz.sdk.microgrid.component import ComponentCategory, ComponentMetricId
-from frequenz.sdk.timeseries import Sample, Sink, Source
-from frequenz.sdk.timeseries.resampling import Resampler
+from frequenz.sdk.timeseries import Sample
+from frequenz.sdk.timeseries._resampling import Resampler, Sink, Source
 
 HOST = "microgrid.sandbox.api.frequenz.io"
 PORT = 61060

src/frequenz/sdk/actor/_resampling.py

@@ -14,7 +14,7 @@
 from frequenz.sdk.util.asyncio import cancel_and_await
 
 from ..timeseries import Sample
-from ..timeseries.resampling import (
+from ..timeseries._resampling import (
     Resampler,
     ResamplingError,
     ResamplingFunction,

src/frequenz/sdk/timeseries/__init__.py

@@ -6,29 +6,10 @@
 
 A timeseries is a stream (normally an async iterator) of
 [`Sample`][frequenz.sdk.timeseries.Sample]s.
-
-Timeseries can be consumed from
-[`Source`][frequenz.sdk.timeseries.Source]s and new timeseries can be
-generated by sending samples to
-a [`Sink`][frequenz.sdk.timeseries.Sink]
-
-In general timeseries `Source`s don't necessarily come at periodic
-intervals. To normalize timeseries to produce `Sample`s at regular
-periodic intervals,
-a [`Resampler`][frequenz.sdk.timeseries.resampling.Resampler] can be used.
-
-A `Resampler` uses
-a [`ResamplingFunction`][frequenz.sdk.timeseries.resampling.ResamplingFunction]
-to produce a new sample from samples received in the past. If there are no
-samples coming to a resampled timeseries for a while, eventually the
-`Resampler` will produce `Sample`s with `None` as value, meaning there is no
-way to produce meaningful samples with the available data.
 """
 
-from ._base_types import Sample, Sink, Source
+from ._base_types import Sample
 
 __all__ = [
     "Sample",
-    "Sink",
-    "Source",
 ]

src/frequenz/sdk/timeseries/_base_types.py

@@ -5,7 +5,7 @@
 
 from dataclasses import dataclass
 from datetime import datetime
-from typing import AsyncIterator, Callable, Coroutine, Optional
+from typing import Optional
 
 
 @dataclass(frozen=True)
@@ -19,27 +19,3 @@ class Sample:
 
     timestamp: datetime
     value: Optional[float] = None
-
-
-Source = AsyncIterator[Sample]
-"""A source for a timeseries.
-
-A timeseries can be received sample by sample in a streaming way
-using a source.
-"""
-
-Sink = Callable[[Sample], Coroutine[None, None, None]]
-"""A sink for a timeseries.
-
-A new timeseries can be generated by sending samples to a sink.
-
-This should be an `async` callable, for example:
-
-``` python
-async some_sink(Sample) -> None:
-    ...
-```
-
-Args:
-    sample (Sample): A sample to be sent out.
-"""

src/frequenz/sdk/timeseries/resampling.py renamed to src/frequenz/sdk/timeseries/_resampling.py

@@ -10,16 +10,40 @@
 import math
 from collections import deque
 from datetime import datetime, timedelta
-from typing import Callable, Sequence
+from typing import AsyncIterator, Callable, Coroutine, Sequence
 
 from frequenz.channels.util import Timer
 
 from ..util.asyncio import cancel_and_await
-from . import Sample, Sink, Source
+from . import Sample
 
 _logger = logging.Logger(__name__)
 
 
+Source = AsyncIterator[Sample]
+"""A source for a timeseries.
+
+A timeseries can be received sample by sample in a streaming way
+using a source.
+"""
+
+Sink = Callable[[Sample], Coroutine[None, None, None]]
+"""A sink for a timeseries.
+
+A new timeseries can be generated by sending samples to a sink.
+
+This should be an `async` callable, for example:
+
+``` python
+async some_sink(Sample) -> None:
+    ...
+```
+
+Args:
+    sample (Sample): A sample to be sent out.
+"""
+
+
 ResamplingFunction = Callable[[Sequence[Sample], float], float]
 """Resampling function type.
 

tests/timeseries/test_resampling.py

@@ -14,11 +14,13 @@
 import time_machine
 from frequenz.channels import Broadcast
 
-from frequenz.sdk.timeseries import Sample, Sink, Source
-from frequenz.sdk.timeseries.resampling import (
+from frequenz.sdk.timeseries import Sample
+from frequenz.sdk.timeseries._resampling import (
     Resampler,
     ResamplingError,
     ResamplingFunction,
+    Sink,
+    Source,
     SourceStoppedError,
 )