Rename time bound properties in ring buffer

Signed-off-by: cwasicki <[email protected]>

Author: cwasicki

src/frequenz/sdk/timeseries/_moving_window.py

@@ -323,9 +323,9 @@ def __getitem__(self, key: SupportsIndex | datetime | slice) -> float | ArrayLik
                     key = slice(slice(key.start, key.stop).indices(self.__len__()))
             elif isinstance(key.start, datetime) or isinstance(key.stop, datetime):
                 if key.start is None:
-                    key = slice(self._buffer.time_bound_oldest, key.stop)
+                    key = slice(self._buffer.oldest_timestamp, key.stop)
                 if key.stop is None:
-                    key = slice(key.start, self._buffer.time_bound_newest)
+                    key = slice(key.start, self._buffer.newest_timestamp)
 
             _logger.debug("Returning slice for [%s:%s].", key.start, key.stop)
 

src/frequenz/sdk/timeseries/_periodic_feature_extractor.py

@@ -172,11 +172,11 @@ def _timestamp_to_rel_index(self, timestamp: datetime) -> int:
 
         # distance between the input ts and the ts of oldest known samples (in samples)
         dist_to_oldest = int(
-            (timestamp - self._buffer.time_bound_oldest) / self._sampling_period
+            (timestamp - self._buffer.oldest_timestamp) / self._sampling_period
         )
 
         _logger.debug("Shifting ts: %s", timestamp)
-        _logger.debug("Oldest timestamp in buffer: %s", self._buffer.time_bound_oldest)
+        _logger.debug("Oldest timestamp in buffer: %s", self._buffer.oldest_timestamp)
         _logger.debug("Distance to the oldest sample: %i", dist_to_oldest)
 
         return dist_to_oldest
@@ -274,7 +274,7 @@ def _get_relative_positions(
 
         # check if the newest time bound, i.e. the sample that is currently written,
         # is inside the interval
-        rb_current_position = self._buffer.time_bound_newest
+        rb_current_position = self._buffer.newest_timestamp
         rel_next_position = (
             self._timestamp_to_rel_index(rb_current_position) + 1
         ) % self._period
@@ -338,7 +338,7 @@ def _get_buffer_bounds(
 
         # get the start and end position inside the ringbuffer
         end_pos = (
-            self._timestamp_to_rel_index(self._buffer.time_bound_newest) + 1
+            self._timestamp_to_rel_index(self._buffer.newest_timestamp) + 1
         ) - dist_to_start
 
         # Note that these check is working since we are using the positions
@@ -355,7 +355,7 @@ def _get_buffer_bounds(
 
         # add the offset to the oldest sample in the ringbuffer and wrap around
         # to get the start and end positions in the ringbuffer
-        rb_offset = self._buffer.datetime_to_index(self._buffer.time_bound_oldest)
+        rb_offset = self._buffer.datetime_to_index(self._buffer.oldest_timestamp)
         start_pos = self._buffer.wrap(end_pos + self._period + rb_offset)
         end_pos = self._buffer.wrap(end_pos + rb_offset)
 

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

@@ -156,19 +156,19 @@ def update(self, sample: Sample[QuantityT]) -> None:
         self._update_gaps(timestamp, prev_newest, sample.value is None)
 
     @property
-    def time_bound_oldest(self) -> datetime:
+    def oldest_timestamp(self) -> datetime:
         """
-        Return the time bounds of the ring buffer.
+        The timestamp of the oldest sample of the ring buffer.
 
         Returns:
             The timestamp of the oldest sample of the ring buffer.
         """
         return self._datetime_oldest
 
     @property
-    def time_bound_newest(self) -> datetime:
+    def newest_timestamp(self) -> datetime:
         """
-        Return the time bounds of the ring buffer.
+        The timestamp of the newest sample of the ring buffer.
 
         Returns:
             The timestamp of the newest sample of the ring buffer.