EPA-PM-API-Wrapper 0.3.3__tar.gz → 0.3.4__tar.gz

epa_pm_api_wrapper-0.3.4/CHANGELOG/0.3.4.md

@@ -0,0 +1,13 @@
+# 0.3.4 (2026-05-07)
+
+### Fixed
+
+- **`property_use.use_details.revisions()`** declared `response_type=Response`, but the EPA returns a `<useDetails>` envelope (not `<response>`) whose children are the concrete use-detail subtypes (`<totalGrossFloorArea>`, `<numberOfComputers>`, `<weeklyOperatingHours>`, …). xsdata's strict parser raised `ParserError: Unknown property response:totalGrossFloorArea` on every call, so callers could not paginate use-detail history at all. The method now declares `response_type=UseDetails` (the existing 122-field dataclass already covers every subtype) and returns it directly. Sync + async kept symmetric.
+
+### Caller impact
+
+- `revisions()` now returns a typed `UseDetails` instead of `Response`. Callers that branched on `Response.status` (which never returned successfully anyway) should switch to reading the typed lists, e.g. `result.total_gross_floor_area`, `result.number_of_computers`, etc. Symmetric with `add_revision()` which already takes a `UseDetails`.
+
+### Contributors
+
+[@harryw1](https://github.com/harryw1) (Harrison Weiss)

{epa_pm_api_wrapper-0.3.3 → epa_pm_api_wrapper-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: EPA-PM-API-Wrapper
-Version: 0.3.3
+Version: 0.3.4
 Summary: Client wrapper for the EPA Portfolio Manager API.
 Project-URL: bugs, https://github.com/harryw1/EPA-PM-API-Wrapper/issues
 Project-URL: changelog, https://github.com/harryw1/EPA-PM-API-Wrapper/releases

{epa_pm_api_wrapper-0.3.3 → epa_pm_api_wrapper-0.3.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "EPA-PM-API-Wrapper"
-version = "0.3.3"
+version = "0.3.4"
 description = "Client wrapper for the EPA Portfolio Manager API."
 readme = "README.md"
 authors = [

{epa_pm_api_wrapper-0.3.3 → epa_pm_api_wrapper-0.3.4}/src/epa_pm_api_wrapper/resources/property_use.py

@@ -45,13 +45,19 @@ class UseDetailsResource(Resource):
         property_use_id: int,
         current_as_of_start: str | None = None,
         current_as_of_end: str | None = None,
-    ) -> Response:
-        """List historical revisions of use details for a property use within a date window."""
+    ) -> UseDetails:
+        """List historical revisions of use details for a property use within a date window.
+
+        The EPA returns a ``<useDetails>`` envelope (not ``<response>``)
+        whose children are the concrete use-detail subtypes
+        (``<totalGrossFloorArea>``, ``<weeklyOperatingHours>``, …). Each
+        is exposed as a typed list on the returned :class:`UseDetails`.
+        """
         return self._client._request(
             "GET",
             f"propertyUse/{property_use_id}/useDetailsRevisions",
             params={"currentAsOfStart": current_as_of_start, "currentAsOfEnd": current_as_of_end},
-            response_type=Response,
+            response_type=UseDetails,
         )
 
     def get(self, use_details_id: int) -> UseAttributeBase:
@@ -181,12 +187,12 @@ class AsyncUseDetailsResource(AsyncResource):
         property_use_id: int,
         current_as_of_start: str | None = None,
         current_as_of_end: str | None = None,
-    ) -> Response:
+    ) -> UseDetails:
         return await self._client._arequest(
             "GET",
             f"propertyUse/{property_use_id}/useDetailsRevisions",
             params={"currentAsOfStart": current_as_of_start, "currentAsOfEnd": current_as_of_end},
-            response_type=Response,
+            response_type=UseDetails,
         )
 
     async def get(self, use_details_id: int) -> UseAttributeBase:

{epa_pm_api_wrapper-0.3.3 → epa_pm_api_wrapper-0.3.4}/tests/test_resources/test_property_use_subresources.py

@@ -53,21 +53,41 @@ def test_use_details_add_revision():
 
 
 @respx.mock
-def test_use_details_revisions_with_date_window():
-    list_xml = """<?xml version="1.0"?><response status="Ok"><links/></response>"""
+def test_use_details_revisions_parses_useDetails_envelope():
+    """Regression: GET /propertyUse/{id}/useDetailsRevisions returns
+    <useDetails> (not <response>) with polymorphic use-detail children.
+
+    Body shape captured from the EPA's published useDetailsRevisions/get
+    docs. Asserts query params forward correctly and the typed children
+    are populated on the returned UseDetails.
+    """
+    list_xml = """<?xml version="1.0" encoding="UTF-8"?>
+<useDetails>
+    <totalGrossFloorArea units="Square Feet" id="24373669" currentAsOf="2004-01-01" temporary="false" default="N/A">
+        <value>12440</value>
+    </totalGrossFloorArea>
+    <numberOfComputers id="24371777" currentAsOf="2004-01-01" temporary="false" default="No">
+        <value>20</value>
+    </numberOfComputers>
+</useDetails>"""
 
     route = respx.get(f"{BASE}/propertyUse/13255076/useDetailsRevisions").mock(
         return_value=httpx.Response(200, content=list_xml)
     )
 
     client = EpaPmClient("user", "pass")
-    client.property_use.use_details.revisions(
+    result = client.property_use.use_details.revisions(
         13255076, current_as_of_start="2024-01-01", current_as_of_end="2024-12-31"
     )
 
     params = route.calls[0].request.url.params
     assert params.get("currentAsOfStart") == "2024-01-01"
     assert params.get("currentAsOfEnd") == "2024-12-31"
+    assert isinstance(result, UseDetails)
+    assert len(result.total_gross_floor_area) == 1
+    assert result.total_gross_floor_area[0].id == 24373669
+    assert len(result.number_of_computers) == 1
+    assert result.number_of_computers[0].id == 24371777
 
 
 @respx.mock

{epa_pm_api_wrapper-0.3.3 → epa_pm_api_wrapper-0.3.4}/uv.lock

@@ -149,7 +149,7 @@ wheels = [
 
 [[package]]
 name = "epa-pm-api-wrapper"
-version = "0.3.3"
+version = "0.3.4"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },