Fix Watershed class: persist instance state and parse JSON

dataretrieval/streamstats.py

@@ -136,26 +136,47 @@ def get_watershed(
         # use Fiona to return a shape object
         pass
 
+    data = json.loads(r.text)
+
     if format == "object":
-        # return a python object
-        pass
+        return data
 
-    data = json.loads(r.text)
     return Watershed.from_streamstats_json(data)
 
 
 class Watershed:
-    """Class to extract information from the streamstats JSON object."""
+    """Class to extract information from the streamstats JSON object.
 
-    @classmethod
-    def from_streamstats_json(cls, streamstats_json):
-        """Method that creates a Watershed object from a streamstats JSON."""
-        cls.watershed_point = streamstats_json["featurecollection"][0]["feature"]
-        cls.watershed_polygon = streamstats_json["featurecollection"][1]["feature"]
-        cls.parameters = streamstats_json["parameters"]
-        cls._workspaceID = streamstats_json["workspaceID"]
-        return cls
+    Attributes
+    ----------
+    watershed_point : dict
+        GeoJSON feature for the watershed pour point.
+    watershed_polygon : dict
+        GeoJSON feature for the delineated watershed polygon.
+    parameters : list
+        Watershed parameters returned by StreamStats.
+    workspace_id : str
+        StreamStats workspace identifier for the watershed.
+    """
 
     def __init__(self, rcode, xlocation, ylocation):
-        """Init method that calls the :obj:`from_streamstats_json` method."""
-        get_watershed(rcode, xlocation, ylocation)
+        """Delineate a watershed and populate the instance from the response."""
+        data = get_watershed(rcode, xlocation, ylocation, format="object")
+        self._populate_from_json(data)
+
+    @classmethod
+    def from_streamstats_json(cls, streamstats_json):
+        """Construct a :obj:`Watershed` from a StreamStats JSON response."""
+        instance = cls.__new__(cls)
+        instance._populate_from_json(streamstats_json)
+        return instance
+
+    def _populate_from_json(self, streamstats_json):
+        self.watershed_point = streamstats_json["featurecollection"][0]["feature"]
+        self.watershed_polygon = streamstats_json["featurecollection"][1]["feature"]
+        self.parameters = streamstats_json["parameters"]
+        self.workspace_id = streamstats_json["workspaceID"]
+
+    @property
+    def _workspaceID(self):
+        return self.workspace_id

tests/streamstats_test.py

@@ -0,0 +1,69 @@
+"""Tests for the streamstats module."""
+
+import json
+
+from dataretrieval.streamstats import Watershed, get_watershed
+
+SAMPLE_JSON = {
+    "featurecollection": [
+        {"name": "globalwatershedpoint", "feature": {"type": "Feature", "id": "pt-1"}},
+        {"name": "globalwatershed", "feature": {"type": "Feature", "id": "poly-1"}},
+    ],
+    "parameters": [{"code": "DRNAREA", "value": 41.2}],
+    "workspaceID": "NY20240101000000000",
+}
+
+
+def test_from_streamstats_json_returns_instance():
+    """Watershed.from_streamstats_json must return an instance, not the class."""
+    w = Watershed.from_streamstats_json(SAMPLE_JSON)
+    assert isinstance(w, Watershed)
+
+
+def test_from_streamstats_json_does_not_mutate_class():
+    """Two watersheds must not share state via class-level attributes."""
+    other_json = {
+        "featurecollection": [
+            {"feature": {"id": "pt-2"}},
+            {"feature": {"id": "poly-2"}},
+        ],
+        "parameters": [{"code": "OTHER", "value": 1.0}],
+        "workspaceID": "VT20240101000000000",
+    }
+    w1 = Watershed.from_streamstats_json(SAMPLE_JSON)
+    w2 = Watershed.from_streamstats_json(other_json)
+
+    assert w1.workspace_id == "NY20240101000000000"
+    assert w2.workspace_id == "VT20240101000000000"
+    assert w1.parameters[0]["code"] == "DRNAREA"
+    assert w2.parameters[0]["code"] == "OTHER"
+    assert w1.watershed_point["id"] == "pt-1"
+    assert w2.watershed_point["id"] == "pt-2"
+
+
+def test_get_watershed_object_returns_dict(requests_mock):
+    """get_watershed(format='object') must return parsed JSON, not None."""
+    url = "https://streamstats.usgs.gov/streamstatsservices/watershed.geojson"
+    requests_mock.get(url, text=json.dumps(SAMPLE_JSON))
+
+    result = get_watershed("NY", -74.524, 43.939, format="object")
+    assert isinstance(result, dict)
+    assert result["workspaceID"] == "NY20240101000000000"
+
+
+def test_watershed_init_populates_instance(requests_mock):
+    """Watershed(...) must populate the instance (regression: previously discarded)."""
+    url = "https://streamstats.usgs.gov/streamstatsservices/watershed.geojson"
+    requests_mock.get(url, text=json.dumps(SAMPLE_JSON))
+
+    w = Watershed("NY", -74.524, 43.939)
+    assert w.workspace_id == "NY20240101000000000"
+    assert w.parameters[0]["code"] == "DRNAREA"
+    assert w.watershed_point["id"] == "pt-1"
+    assert w.watershed_polygon["id"] == "poly-1"
+
+
+def test_workspace_id_back_compat_alias():
+    """Legacy `_workspaceID` attribute should still resolve."""
+    w = Watershed.from_streamstats_json(SAMPLE_JSON)
+    assert w._workspaceID == w.workspace_id == "NY20240101000000000"