Merge pull request #86 from HydrologicEngineeringCenter/Delete-and-TimeZone

Delete and time zone

Author: oskarhurst

.github/workflows/test.yml

@@ -24,18 +24,20 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Install requests
-        run: pip install requests
+      # On all platforms install the PyPI tzdata distribution
+      # (stdlib zoneinfo will auto‐pick it up; the backport will too)
+      - name: Install tzdata (Python)
+        run: pip install tzdata
+
+      - name: Install runtime dependencies
+        run: |
+          pip install requests
+          pip install numpy
+          pip install pytest
 
       - name: add dll
         run: python3 src/hecdss/download_hecdss.py
 
-      - name: Install Packages
-        run: pip install pytest
-
-      - name: Install numpy
-        run: pip install numpy
-
       - name: Run tests
         run: pytest tests
 

src/hecdss/dateconverter.py

@@ -77,7 +77,6 @@
 ]
 class DateConverter:
 
-
     @staticmethod
     def dss_datetime_strings_from_datetime(dt:datetime):
         """ 
@@ -95,6 +94,22 @@ def dss_datetime_strings_from_datetime(dt:datetime):
 
         return dtstr[:9],dtstr[-8:]
 
+    @staticmethod
+    def datetime_from_dss_datetime_string(datestr: str):
+        """
+        convert DSS 24:00 style string to python datetime
+        25Aug2023 09:23:47 -> 2023-08-25 09:23:47
+        24Aug2023 24:00 -> 2023-08-25 00:00:00
+        25Aug2023 00:10 -> 2023-08-25 00:10:00
+        """
+        date_part, time_part = datestr.split()
+        dt = datetime.strptime(date_part, "%d%b%Y")
+        if time_part == "24:00":
+            dt += timedelta(days=1)
+            time_part = "00:00"
+        time_obj = datetime.strptime(time_part, "%H:%M").time()
+        return datetime.combine(dt.date(), time_obj)
+
     @staticmethod
     def date_time_from_julian_second(time_julian, seconds_julian):
         """"
@@ -142,6 +157,7 @@ def julian_array_from_date_times(date_times, time_granularity_seconds=60, start_
             raise ValueError("Time Series Times array was None. Something didn't work right in DSS.")
         start_date_base = start_date_base.replace(hour=0, minute=0, second=0, microsecond=0)-timedelta(days=1)
         return [int(((i-start_date_base).days*86400 + i.hour * 3600 + i.minute * 60 + i.second)/time_granularity_seconds) for i in date_times]
+
     @staticmethod
     def intervalString_to_sec(interval):
         if isinstance(interval, str):

src/hecdss/download_hecdss.py

@@ -36,7 +36,7 @@ def download_and_unzip(url, zip_file, destination_dir):
         print(f"Failed to download zip file. Status code: {response.status_code}")
 
 base_url = "https://www.hec.usace.army.mil/nexus/repository/maven-public/mil/army/usace/hec/hecdss/"
-version = "7-IU-6"
+version = "7-IU-10"
 
 destination_dir = Path(__file__).parent.joinpath("lib")
 zip_url = f"{base_url}{version}-win-x86_64/hecdss-{version}-win-x86_64.zip"

src/hecdss/hecdss.py

@@ -1,5 +1,6 @@
 """Docstring for public module."""
 from datetime import datetime, timedelta
+from zoneinfo import ZoneInfo
 
 import numpy as np
 
@@ -275,6 +276,8 @@ def _get_paired_data(self, pathname):
         unitsDependent2 = [""]
         typeIndependent2 = [""]
         typeDependent2 = [""]
+        timeZoneName = [""]
+        timeZoneNameLength = [""]
         status = self._native.hec_dss_pdRetrieve(pathname,
                                                  doubleOrdinates, numberOrdinates[0],
                                                  doubleValues, numberCurves[0] * numberOrdinates[0],
@@ -283,7 +286,8 @@ def _get_paired_data(self, pathname):
                                                  typeIndependent2, len(typeIndependent[0]) + 1,
                                                  unitsDependent2, len(unitsDependent[0]) + 1,
                                                  typeDependent2, len(typeDependent[0]) + 1,
-                                                 labels, labelsLength[0])
+                                                 labels, labelsLength[0],
+                                                 timeZoneName, len(timeZoneNameLength[0]) + 1)
 
         if status != 0:
             print(f"Error reading paired-data from '{pathname}'")
@@ -300,6 +304,7 @@ def _get_paired_data(self, pathname):
         pd.type_dependent = typeDependent2[0]
         pd.units_independent = unitsIndependent2[0]
         pd.units_dependent = unitsDependent2[0]
+        pd.time_zone_name = timeZoneName[0]
         pd.id = pathname
         pd.location_info = self._get_location_info(pathname)
 
@@ -392,6 +397,7 @@ def _get_timeseries(self, pathname, startDateTime, endDateTime, trim):
         units = [""]
         bufferLength = 40
         dataType = [""]
+        timeZoneName = [""]
 
         status = self._native.hec_dss_tsRetrieve(
             pathname,
@@ -411,6 +417,8 @@ def _get_timeseries(self, pathname, startDateTime, endDateTime, trim):
             bufferLength,
             dataType,
             bufferLength,
+            timeZoneName,
+            bufferLength
         )
 
         # print("units = "+units[0])
@@ -453,8 +461,11 @@ def _get_timeseries(self, pathname, startDateTime, endDateTime, trim):
         start_date = [] if len(new_times) == 0 else new_times[0]
         time_granularity_seconds = timeGranularitySeconds[0]
         julian_base_date = julianBaseDate[0]
+        timeZoneName = timeZoneName[0]
+        if(timeZoneName):
+            new_times = [i.replace(tzinfo=ZoneInfo(timeZoneName)) for i in new_times]
         location_info = self._get_location_info(pathname)
-        ts = ts.create(values=values, times=new_times, quality=quality, units=units, data_type=data_type, start_date=start_date, time_granularity_seconds=time_granularity_seconds, julian_base_date=julian_base_date, path=pathname, location_info=location_info)
+        ts = ts.create(values=values, times=new_times, quality=quality, units=units, data_type=data_type, start_date=start_date, time_granularity_seconds=time_granularity_seconds, julian_base_date=julian_base_date, time_zone_name=timeZoneName, path=pathname, location_info=location_info)
         return ts
 
     def _get_location_info(self, pathname: str):
@@ -544,6 +555,8 @@ def put(self, container) -> int:
                 False,
                 ts.units,
                 ts.data_type,
+                ts.time_zone_name,
+                0
             )
             self._catalog = None
         elif type(container) is IrregularTimeSeries:
@@ -567,6 +580,8 @@ def put(self, container) -> int:
                 False,
                 its.units,
                 its.data_type,
+                its.time_zone_name,
+                1
             )
             self._catalog = None
         elif type(container) is PairedData:
@@ -600,6 +615,91 @@ def put(self, container) -> int:
 
         return status
 
+    def delete(self, pathname: str, allrecords: bool = False, startdatetime=None, enddatetime=None) -> int:
+        """deletes a record from the DSS file
+        Args:
+            pathname (str): dss pathname, if only the pathname is provided, delete only the record with this pathname
+            allRecords (bool): if True, delete all records with this pathname that have different dates
+            startdatetime (datetime): start date for query, if only start date is provided, delete all records at or after this date
+            enddatetime (datetime): end date for the query, if only end date is provided, delete all records at or before this date
+        Returns:
+            int: status of zero when successful. Non zero for errors.
+        """
+        rt = self.get_record_type(pathname)
+        delete_path = DssPath(pathname)
+        if (rt == RecordType.RegularTimeSeries or rt == RecordType.IrregularTimeSeries) and allrecords:
+            for i in self.get_catalog().uncondensed_paths:
+                uncondensed_path = DssPath(i)
+                if uncondensed_path.path_without_date().__eq__(delete_path.path_without_date()):
+                    status = self._native.hec_dss_delete(i)
+                    if status == 0:
+                        self._catalog = None
+        elif rt == RecordType.RegularTimeSeries and (startdatetime or enddatetime):
+            newStartDateTime, newEndDateTime = self._get_date_time_range(pathname, 1)
+            if startdatetime:
+                newStartDateTime = startdatetime
+            if enddatetime:
+                newEndDateTime = enddatetime
+
+            interval_seconds=DateConverter.intervalString_to_sec(delete_path.E)
+
+            firstMinutes = DateConverter.julian_array_from_date_times([newStartDateTime])[0]
+            firstSeconds, firstJulian = [firstMinutes % 1440 * 60], [firstMinutes // 1440]
+
+            lastMinutes = DateConverter.julian_array_from_date_times([newEndDateTime])[0]
+            lastSeconds, lastJulian = [lastMinutes % 1440 * 60], [lastMinutes // 1440]
+
+            number_periods = self._native.hec_dss_numberPeriods(
+                interval_seconds,
+                firstJulian[0],
+                firstSeconds[0],
+                lastJulian[0],
+                lastSeconds[0],
+            )
+
+            RTS = RegularTimeSeries()
+            RTS.values = [DSS_UNDEFINED_VALUE]*number_periods
+            RTS.times = [newStartDateTime, newEndDateTime]
+            RTS.start_date = startdatetime
+            RTS.id = pathname
+
+            startDate, startTime = DateConverter.dss_datetime_strings_from_datetime(RTS.times[0])
+
+            status = self._native.hec_dss_tsStoreRegular(
+                RTS.id,
+                startDate,
+                startTime,
+                RTS.values,
+                RTS.quality,
+                False,
+                RTS.units,
+                RTS.data_type,
+                RTS.time_zone_name,
+                3
+            )
+            self._catalog = None
+        elif rt == RecordType.IrregularTimeSeries and (startdatetime or enddatetime):
+            newStartDateTime, newEndDateTime = self._get_date_time_range(pathname, 1)
+            if startdatetime:
+                newStartDateTime = startdatetime
+            if enddatetime:
+                newEndDateTime = enddatetime
+
+            IRTS = IrregularTimeSeries()
+            IRTS.values = [DSS_UNDEFINED_VALUE, DSS_UNDEFINED_VALUE]
+            IRTS.times = [newStartDateTime, newEndDateTime]
+            IRTS.start_date = startdatetime
+            IRTS.id = pathname
+
+            dss.put(IRTS)
+        else:
+            status = self._native.hec_dss_delete(pathname)
+            if status == 0:
+                self._catalog = None
+            else:
+                print(f"Error deleting record from '{pathname}', Record does not exist or timeseries path must be uncondensed")
+        return status
+
     def get_catalog(self) -> Catalog:
         """gets the DSS Catalog of all items in the DSS file
 

src/hecdss/irregular_timeseries.py

@@ -21,6 +21,7 @@ def __init__(self):
         self.start_date = ""
         self.time_granularity_seconds = 1
         self.julian_base_date = 0
+        self.time_zone_name = ""
         self.id = ""
         self.location_info = None
 
@@ -85,7 +86,7 @@ def print_to_console(self):
         for time, value in zip(self.times, self.values):
             print(f"Time: {time}, Value: {value}")
     @staticmethod
-    def create(values, times, quality=[], units="", data_type="", interval=0, start_date="", time_granularity_seconds=1, julian_base_date=None, path=None, location_info=None):
+    def create(values, times, quality=[], units="", data_type="", interval=0, start_date="", time_granularity_seconds=1, julian_base_date=None, time_zone_name="", path=None, location_info=None):
         """
          Retrieve the value at a specific date in the time-series.
 
@@ -107,6 +108,7 @@ def create(values, times, quality=[], units="", data_type="", interval=0, start_
         irts.julian_base_date = 0
         if julian_base_date is None and len(times):
             irts.julian_base_date = (times[0]-datetime(1900, 1, 1)).days
+        irts.time_zone_name = time_zone_name
         irts.id = path
         irts.location_info = location_info
         return irts