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

epa_pm_api_wrapper-0.3.4/CHANGELOG/0.3.3.md

@@ -0,0 +1,21 @@
+# 0.3.3 (2026-05-07)
+
+Two waste-meter bugs surfaced by round-trip testing against `wstest` after the 0.3.2 release.
+
+### Fixed
+
+- **`waste_data.add()`** — sent a bare `<wasteData>` request body, which the EPA rejects with HTTP 400. The endpoint requires records wrapped in `<wasteDataList>` (mirroring the `<meterData>` envelope used by `consumption_data.add`). 0.3.2 fixed the response parsing but the request shape was still broken upstream of it, so `waste_data.add()` never worked against the live API. The method now takes a `WasteDataList` and supports up to 120 records per call. The regression test additionally asserts the serialized request body uses `<wasteDataList>` as the root element so this can't regress silently.
+- **`meter.get()`** — `GET /meter/{id}` returns either `<meter>` (energy, water, etc.) or `<wasteMeter>` (trash, recycling, …) depending on the meter type, with disjoint child schemas. The method previously always parsed as `Meter`, so any waste-meter response raised `xsdata.exceptions.ParserError: Unknown property meter:dataEntryMethod`. It now dispatches via `_request_polymorphic` and returns `Meter | WasteMeter`; disambiguate with `isinstance`. Sync + async kept symmetric. The CLI's `get-meter` command prints the appropriate fields for each type.
+
+### Caller impact
+
+- **Breaking (signature only — runtime never worked):** `waste_data.add()` callers passing a single `WasteData` need to wrap it as `WasteDataList(waste_data=[record])`.
+- **Soft change:** `meter.get()` now returns `Meter | WasteMeter` instead of `Meter`. Callers that already only worked with energy meters keep working at runtime; type checkers will flag attribute access on the union and prompt for an `isinstance` narrow.
+
+### Known issues still open
+
+- **`property_use.use_details.revisions()`** raises `ParserError` because the response body is a polymorphic list of use-detail subtypes inside a `<response>` envelope. The wrapper has single-element polymorphic dispatch but no list equivalent yet. Tracked for a follow-up release.
+
+### Contributors
+
+[@harryw1](https://github.com/harryw1) (Harrison Weiss)

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.2 → 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.2
+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.2 → 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.2"
+version = "0.3.4"
 description = "Client wrapper for the EPA Portfolio Manager API."
 readme = "README.md"
 authors = [

{epa_pm_api_wrapper-0.3.2 → epa_pm_api_wrapper-0.3.4}/src/epa_pm_api_wrapper/cli.py

@@ -18,6 +18,7 @@ from rich.console import Console
 from rich.table import Table
 
 from epa_pm_api_wrapper.client import EpaPmClient
+from epa_pm_api_wrapper.models import WasteMeter
 
 # Load environment variables from .env file, allowing them to override existing env vars
 load_dotenv(override=True)
@@ -141,10 +142,15 @@ def get_meter(
         console.print("[bold green]Meter Details:[/bold green]")
         console.print(f"ID: {meter.id}")
         console.print(f"Name: {meter.name}")
-        console.print(f"Type: {meter.type_value}")
-        console.print(f"Unit: {meter.unit_of_measure}")
-        console.print(f"Metered: {meter.metered}")
-        console.print(f"In Use: {meter.in_use}")
+        if isinstance(meter, WasteMeter):
+            console.print(f"Type: {meter.type_value} (waste)")
+            console.print(f"Unit: {meter.unit_of_measure}")
+            console.print(f"In Use: {meter.in_use}")
+        else:
+            console.print(f"Type: {meter.type_value}")
+            console.print(f"Unit: {meter.unit_of_measure}")
+            console.print(f"Metered: {meter.metered}")
+            console.print(f"In Use: {meter.in_use}")
     except Exception as e:
         console.print(f"[bold red]Error:[/bold red] {e}")
 

{epa_pm_api_wrapper-0.3.2 → epa_pm_api_wrapper-0.3.4}/src/epa_pm_api_wrapper/resources/meter.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 
 from epa_pm_api_wrapper.models import (
     AdditionalIdentifier,
@@ -12,6 +12,7 @@ from epa_pm_api_wrapper.models import (
     IndividualMeter,
     Meter,
     Response,
+    WasteMeter,
 )
 
 from ._base import AsyncResource, Resource
@@ -118,9 +119,21 @@ class MeterResource(Resource):
         params = {"myAccessOnly": "true" if my_access_only else "false"} if my_access_only is not None else None
         return self._client._request("GET", f"property/{property_id}/meter/list", params=params, response_type=Response)
 
-    def get(self, meter_id: int) -> Meter:
-        """Get details for a specific meter."""
-        return self._client._request("GET", f"meter/{meter_id}", response_type=Meter)
+    def get(self, meter_id: int) -> Meter | WasteMeter:
+        """Get details for a specific meter (energy or waste).
+
+        The EPA returns either ``<meter>`` (energy/water/etc.) or
+        ``<wasteMeter>`` (trash, recycling, …) depending on the meter
+        type, with disjoint child schemas. The client auto-resolves to
+        the matching dataclass; use ``isinstance`` to disambiguate::
+
+            m = client.meter.get(meter_id)
+            if isinstance(m, WasteMeter):
+                ...
+            else:
+                ...  # energy meter — Meter
+        """
+        return cast(Meter | WasteMeter, self._client._request_polymorphic("GET", f"meter/{meter_id}"))
 
     def create(self, property_id: int, meter_data: Meter) -> Response:
         """Add a new meter under a property."""
@@ -242,8 +255,8 @@ class AsyncMeterResource(AsyncResource):
             "GET", f"property/{property_id}/meter/list", params=params, response_type=Response
         )
 
-    async def get(self, meter_id: int) -> Meter:
-        return await self._client._arequest("GET", f"meter/{meter_id}", response_type=Meter)
+    async def get(self, meter_id: int) -> Meter | WasteMeter:
+        return cast(Meter | WasteMeter, await self._client._arequest_polymorphic("GET", f"meter/{meter_id}"))
 
     async def create(self, property_id: int, meter_data: Meter) -> Response:
         return await self._client._arequest(

{epa_pm_api_wrapper-0.3.2 → 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.2 → epa_pm_api_wrapper-0.3.4}/src/epa_pm_api_wrapper/resources/waste_data.py

@@ -21,14 +21,17 @@ class WasteDataResource(Resource):
         params = {"page": page, "startDate": start_date, "endDate": end_date}
         return self._client._request("GET", f"meter/{meter_id}/wasteData", params=params, response_type=WasteDataList)
 
-    def add(self, meter_id: int, data: WasteData) -> WasteDataList:
-        """Add a waste data record to a meter.
-
-        Returns a ``<wasteDataList>`` echoing the created record with its
-        server-assigned ``id`` populated; callers can read
-        ``result.waste_data[0].id`` without a follow-up GET. The EPA
-        responds with this envelope (not the usual ``<response>``) even for
-        a single-record POST.
+    def add(self, meter_id: int, data: WasteDataList) -> WasteDataList:
+        """Add one or more waste data records to a meter (up to 120 per call).
+
+        The EPA requires the request body to be wrapped in ``<wasteDataList>``
+        (mirroring the ``<meterData>`` envelope used by consumption_data.add);
+        a bare ``<wasteData>`` element is rejected with HTTP 400. Callers
+        wrap a single record as ``WasteDataList(waste_data=[record])``.
+
+        Returns a ``<wasteDataList>`` echoing the created records with their
+        server-assigned ``id`` populated; read ``result.waste_data[i].id``
+        to track them without a follow-up GET.
         """
         return self._client._request("POST", f"meter/{meter_id}/wasteData", data=data, response_type=WasteDataList)
 
@@ -88,7 +91,7 @@ class AsyncWasteDataResource(AsyncResource):
             "GET", f"meter/{meter_id}/wasteData", params=params, response_type=WasteDataList
         )
 
-    async def add(self, meter_id: int, data: WasteData) -> WasteDataList:
+    async def add(self, meter_id: int, data: WasteDataList) -> WasteDataList:
         return await self._client._arequest(
             "POST", f"meter/{meter_id}/wasteData", data=data, response_type=WasteDataList
         )

{epa_pm_api_wrapper-0.3.2 → epa_pm_api_wrapper-0.3.4}/tests/test_client.py

@@ -249,6 +249,38 @@ def test_get_meter():
     assert meter.name == "Main Electric"
 
 
+@respx.mock
+def test_get_meter_resolves_waste_meter_polymorphically():
+    """Regression: GET /meter/{id} can return <wasteMeter>, not just <meter>.
+
+    Previously meter.get() always parsed as Meter, so any waste meter
+    response raised ParserError. The client now auto-resolves to the
+    matching dataclass.
+    """
+    from epa_pm_api_wrapper.models import Meter, WasteMeter
+
+    waste_xml = """<?xml version="1.0" encoding="UTF-8"?>
+<wasteMeter>
+    <id>456</id>
+    <name>Trash dumpster</name>
+    <type>Disposed - Batteries</type>
+    <unitOfMeasure>tons</unitOfMeasure>
+    <dataEntryMethod>regular</dataEntryMethod>
+    <firstBillDate>2024-01-01</firstBillDate>
+    <inUse>true</inUse>
+</wasteMeter>"""
+
+    respx.get(f"{BASE}/meter/456").mock(return_value=httpx.Response(200, content=waste_xml))
+
+    client = EpaPmClient("user", "pass")
+    meter = client.meter.get(456)
+
+    assert isinstance(meter, WasteMeter)
+    assert not isinstance(meter, Meter)
+    assert meter.id == 456
+    assert meter.name == "Trash dumpster"
+
+
 @respx.mock
 def test_list_meters_with_my_access_only():
     list_xml = """<?xml version="1.0" encoding="UTF-8"?>

{epa_pm_api_wrapper-0.3.2 → 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.2 → epa_pm_api_wrapper-0.3.4}/tests/test_resources/test_waste_data.py

@@ -63,14 +63,23 @@ def test_add_returns_waste_data_list_with_assigned_id():
     route = respx.post(f"{BASE}/meter/123/wasteData").mock(return_value=httpx.Response(201, content=add_xml))
 
     client = EpaPmClient("user", "pass")
-    payload = WasteData(
-        start_date=XmlDate(2013, 1, 1),
-        end_date=XmlDate(2013, 1, 31),
-        quantity=Decimal("50"),
+    payload = WasteDataList(
+        waste_data=[
+            WasteData(
+                start_date=XmlDate(2013, 1, 1),
+                end_date=XmlDate(2013, 1, 31),
+                quantity=Decimal("50"),
+            ),
+        ],
     )
     result = client.waste_data.add(123, payload)
 
     assert route.called
+    # Request must use <wasteDataList> as root, not bare <wasteData>
+    # (EPA rejects the bare form with HTTP 400). Mirrors consumption_data.add.
+    sent_body = route.calls[0].request.content.decode()
+    assert "<wasteDataList" in sent_body
+    assert "<wasteData" in sent_body
     assert isinstance(result, WasteDataList)
     assert result.waste_data is not None
     assert result.waste_data[0].id == 783569362

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

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