Ringbuffer: Moved files into a package (#329)

Signed-off-by: Mathias L. Baumann <[email protected]>

Author: mathias-baumann-frequenz

benchmarks/timeseries/ringbuffer_serialization.py

@@ -13,9 +13,8 @@
 
 import numpy as np
 
-import frequenz.sdk.timeseries._ringbuffer_serialization as io
+import frequenz.sdk.timeseries._ringbuffer as rb
 from frequenz.sdk.timeseries import Sample
-from frequenz.sdk.timeseries._ringbuffer import OrderedRingBuffer
 
 FILE_NAME = "ringbuffer.pkl"
 FIVE_MINUTES = timedelta(minutes=5)
@@ -38,7 +37,7 @@ def delete_files_with_prefix(prefix: str) -> None:
 
 
 def benchmark_serialization(
-    ringbuffer: OrderedRingBuffer[Any], iterations: int
+    ringbuffer: rb.OrderedRingBuffer[Any], iterations: int
 ) -> float:
     """Benchmark the given buffer `iteration` times.
 
@@ -49,8 +48,8 @@ def benchmark_serialization(
     total = 0.0
     for _ in range(iterations):
         start = time.time()
-        io.dump(ringbuffer, FILE_NAME)
-        io.load(FILE_NAME)
+        rb.dump(ringbuffer, FILE_NAME)
+        rb.load(FILE_NAME)
         end = time.time()
         total += end - start
         delete_files_with_prefix(FILE_NAME)
@@ -60,7 +59,7 @@ def benchmark_serialization(
 
 def main() -> None:
     """Run Benchmark."""
-    ringbuffer = OrderedRingBuffer(
+    ringbuffer = rb.OrderedRingBuffer(
         np.arange(0, SIZE, dtype=np.float64), timedelta(minutes=5)
     )
 

src/frequenz/sdk/timeseries/_ringbuffer/__init__.py

@@ -0,0 +1,9 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Ringbuffer implementation & utilties."""
+
+from .buffer import Gap, OrderedRingBuffer
+from .serialization import dump, load
+
+__all__ = ["OrderedRingBuffer", "Gap", "load", "dump"]

…c/frequenz/sdk/timeseries/_ringbuffer.py …enz/sdk/timeseries/_ringbuffer/buffer.pysrc/frequenz/sdk/timeseries/_ringbuffer.py renamed to src/frequenz/sdk/timeseries/_ringbuffer/buffer.py src/frequenz/sdk/timeseries/_ringbuffer.py renamed to src/frequenz/sdk/timeseries/_ringbuffer/buffer.py

@@ -14,7 +14,7 @@
 import numpy as np
 import numpy.typing as npt
 
-from . import Sample
+from .. import Sample
 
 FloatArray = TypeVar("FloatArray", List[float], npt.NDArray[np.float64])
 

…/timeseries/_ringbuffer_serialization.py …/timeseries/_ringbuffer/serialization.pysrc/frequenz/sdk/timeseries/_ringbuffer_serialization.py renamed to src/frequenz/sdk/timeseries/_ringbuffer/serialization.py src/frequenz/sdk/timeseries/_ringbuffer_serialization.py renamed to src/frequenz/sdk/timeseries/_ringbuffer/serialization.py

@@ -9,7 +9,7 @@
 import pickle
 from os.path import exists
 
-from ._ringbuffer import FloatArray, OrderedRingBuffer
+from .buffer import FloatArray, OrderedRingBuffer
 
 # Version of the latest file dumping/loading format
 FILE_FORMAT_VERSION: int = 1

tests/timeseries/test_ringbuffer_serialization.py

@@ -12,16 +12,15 @@
 import numpy as np
 import pytest
 
-import frequenz.sdk.timeseries._ringbuffer_serialization as io
+import frequenz.sdk.timeseries._ringbuffer as rb
 from frequenz.sdk.timeseries import Sample
-from frequenz.sdk.timeseries._ringbuffer import OrderedRingBuffer
 
 FIVE_MINUTES = timedelta(minutes=5)
 _29_DAYS = 60 * 24 * 29
 ONE_MINUTE = timedelta(minutes=1)
 
 
-def load_dump_test(dumped: OrderedRingBuffer[Any], path: str) -> None:
+def load_dump_test(dumped: rb.OrderedRingBuffer[Any], path: str) -> None:
     """Test ordered ring buffer."""
     size = dumped.maxlen
 
@@ -43,11 +42,11 @@ def load_dump_test(dumped: OrderedRingBuffer[Any], path: str) -> None:
             )
         )
 
-    io.dump(dumped, path)
+    rb.dump(dumped, path)
 
     # Load old data
     # pylint: disable=protected-access
-    loaded = io.load(path)
+    loaded = rb.load(path)
     assert loaded is not None
 
     np.testing.assert_equal(dumped[:], loaded[:])
@@ -73,7 +72,7 @@ def test_load_dump_short(tmp_path_factory: pytest.TempPathFactory) -> None:
     tmpdir = tmp_path_factory.mktemp("load_dump")
 
     load_dump_test(
-        OrderedRingBuffer(
+        rb.OrderedRingBuffer(
             [0.0] * int(24 * FIVE_MINUTES.total_seconds()),
             FIVE_MINUTES,
             datetime(2, 2, 2, tzinfo=timezone.utc),
@@ -82,7 +81,7 @@ def test_load_dump_short(tmp_path_factory: pytest.TempPathFactory) -> None:
     )
 
     load_dump_test(
-        OrderedRingBuffer(
+        rb.OrderedRingBuffer(
             np.empty(shape=(24 * int(FIVE_MINUTES.total_seconds()),), dtype=np.float64),
             FIVE_MINUTES,
             datetime(2, 2, 2, tzinfo=timezone.utc),
@@ -96,7 +95,7 @@ def test_load_dump(tmp_path_factory: pytest.TempPathFactory) -> None:
     tmpdir = tmp_path_factory.mktemp("load_dump")
 
     load_dump_test(
-        OrderedRingBuffer(
+        rb.OrderedRingBuffer(
             [0.0] * _29_DAYS,
             ONE_MINUTE,
             datetime(2, 2, 2, tzinfo=timezone.utc),
@@ -105,7 +104,7 @@ def test_load_dump(tmp_path_factory: pytest.TempPathFactory) -> None:
     )
 
     load_dump_test(
-        OrderedRingBuffer(
+        rb.OrderedRingBuffer(
             np.empty(shape=(_29_DAYS,), dtype=np.float64),
             ONE_MINUTE,
             datetime(2, 2, 2, tzinfo=timezone.utc),