add __str__ method to dss_type (#46)

* add __str__ method to dss_type

other houskeeping

* cleanup

* oops

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = hecdss
-version = 0.1.15
+version = 0.1.16
 author = Hydrologic Engineering Center
 author_email [email protected]
 description = Python wrapper for the HEC-DSS file database C library.

src/hecdss/cwms_utility.py

@@ -93,7 +93,7 @@ def pathname_to_cwms_tsid(path, dss_type="", duration="0", strict=False):
         return tsid
 
     @staticmethod
-    def cwms_ts_id_to_pathname(ts_id: str) -> str:
+    def cwms_ts_id_to_dss_path(ts_id: str) -> DssPath:
         """
         convert cwms time-series id to a dss path
         example input:
@@ -153,7 +153,7 @@ def _convert_dss_interval_to_cwms_interval(dss_interval: str):
 
 
     @staticmethod
-    def dss_data_type_from_cwms_tsid(cwms_tsid):
+    def dss_data_type_from_cwms_tsid(cwms_tsid) -> str:
         """
         takes an input id such as 'TULA.Flow.Inst.1Hour.0.Ccp-Rev'
         and returns the DSS DataType  'INST-VAL' in this example
@@ -178,4 +178,4 @@ def dss_data_type_from_cwms_tsid(cwms_tsid):
             dss_type = DssType.PER_MIN
         else:
             dss_type = ts_type  # default: use cwms type
-        return dss_type
+        return str(dss_type)

src/hecdss/dss_type.py

@@ -12,3 +12,5 @@ class DssType(Enum):
     PER_MIN = "PER-MIN"
     CONST = "CONST"
 
+    def __str__(self):
+        return self.value

tests/test_dss_type.py

@@ -0,0 +1,18 @@
+import unittest
+import os
+import sys
+
+sys.path.append(r'src')
+sys.path.append(os.path.dirname(__file__))
+from hecdss.dss_type import DssType
+
+
+class TestBasics(unittest.TestCase):
+
+
+    def test_to_string(self):
+        """ This is testing the __str__ method  in DssType """
+        t = DssType.PER_CUM
+        s = str(t)
+        assert s == "PER-CUM", f"actual:{s},  expected 'PER-CUM'"
+

tests/test_dsspath.py

@@ -52,7 +52,7 @@ def test_convert_cwms_tsid_to_dss_path(self):
         for row in self.example_data:
             tsid = row[0]
             expected_pathname = row[1]
-            pathname = CwmsUtility.cwms_ts_id_to_pathname(tsid)
+            pathname = CwmsUtility.cwms_ts_id_to_dss_path(tsid)
             expected_pathname_without_date = DssPath(str(expected_pathname)).path_without_date()
             if expected_pathname_without_date != pathname:
                 print(f"error converting to path. expected '{expected_pathname_without_date}', actual: '{pathname}'")