sketched out DataSource.get_contiguous_time_periods() #223

Author: JackKelly

nowcasting_dataset/data_sources/data_source.py

@@ -136,6 +136,7 @@ def datetime_index(self) -> pd.DatetimeIndex:
         # of a list of datetimes (e.g. for DatetimeDataSource).
         raise NotImplementedError()
 
+    # TODO: Remove this function (and any tests) after get_contiguous_time_periods() is implemented.
     def get_t0_datetimes(self) -> pd.DatetimeIndex:
         """Get all the valid t0 datetimes.
 
@@ -158,6 +159,22 @@ def get_t0_datetimes(self) -> pd.DatetimeIndex:
             max_gap=self.sample_period_dur,
         )
 
+    def get_contiguous_time_periods(self) -> pd.DataFrame:
+        """Get all the time periods for which this DataSource has contiguous data.
+
+        Optionally filter out any time periods which don't make sense for this DataSource,
+        e.g. remove nighttime.
+
+        Returns:
+          pd.DataFrame where each row represents a single time period.  The pd.DataFrame
+          has two columns: `start_dt` and `end_dt` (where 'dt' is short for 'datetime').
+        """
+
+        # TODO:
+        # Modify nd_time.get_start_datetimes so that it returns the segment boundaries
+        # as a pd.DataFrame?
+        raise NotImplementedError()
+
     def _get_time_slice(self, t0_dt: pd.Timestamp):
         """Get a single timestep of data.  Must be overridden."""
         raise NotImplementedError()