pgw-api 1.2.1__tar.gz → 1.4.0__tar.gz

{pgw_api-1.2.1 → pgw_api-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pgw-api
-Version: 1.2.1
+Version: 1.4.0
 Summary: Python API client for Philadelphia Gas Works (PGW)
 Author: zackwag
 License: MIT
@@ -29,6 +29,7 @@ import asyncio
 import aiohttp
 from pgw_api import PGWApiClient
 
+
 async def main():
     client = PGWApiClient("your-email@example.com", "your-password")
 
@@ -40,6 +41,7 @@ async def main():
             if entry.period_start and entry.period_end:
                 print(f"  Period: {entry.period_start} to {entry.period_end}")
 
+
 asyncio.run(main())
 ```
 

{pgw_api-1.2.1 → pgw_api-1.4.0}/README.md

@@ -15,6 +15,7 @@ import asyncio
 import aiohttp
 from pgw_api import PGWApiClient
 
+
 async def main():
     client = PGWApiClient("your-email@example.com", "your-password")
 
@@ -26,6 +27,7 @@ async def main():
             if entry.period_start and entry.period_end:
                 print(f"  Period: {entry.period_start} to {entry.period_end}")
 
+
 asyncio.run(main())
 ```
 

{pgw_api-1.2.1 → pgw_api-1.4.0}/pgw_api/client.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import json
 import re
-from datetime import date
+from datetime import date, datetime
 
 import aiohttp
 
@@ -33,18 +33,14 @@ class PGWApiClient:
         self._username = username
         self._password = password
 
-    async def async_get_usage(
-        self, session: aiohttp.ClientSession
-    ) -> list[GasUsage]:
+    async def async_get_usage(self, session: aiohttp.ClientSession) -> list[GasUsage]:
         """Authenticate and fetch gas usage data from PGW."""
         await self._establish_session(session)
         await self._authenticate(session)
         csrf_token = await self._get_csrf_token(session)
         return await self._load_gas_usage(session, csrf_token)
 
-    async def async_get_billing(
-        self, session: aiohttp.ClientSession
-    ) -> BillingSummary:
+    async def async_get_billing(self, session: aiohttp.ClientSession) -> BillingSummary:
         """Authenticate and fetch billing summary from PGW."""
         await self._establish_session(session)
         await self._authenticate(session)
@@ -84,9 +80,7 @@ class PGWApiClient:
         usage = await self._load_gas_usage(session, csrf_token)
         return usage, billing
 
-    async def async_validate_credentials(
-        self, session: aiohttp.ClientSession
-    ) -> bool:
+    async def async_validate_credentials(self, session: aiohttp.ClientSession) -> bool:
         """Validate credentials without fetching usage data."""
         await self._establish_session(session)
         await self._authenticate(session)
@@ -97,9 +91,7 @@ class PGWApiClient:
         try:
             async with session.get(LOGIN_URL, allow_redirects=True) as resp:
                 if resp.status != 200:
-                    raise PGWConnectionError(
-                        f"Login page returned status {resp.status}"
-                    )
+                    raise PGWConnectionError(f"Login page returned status {resp.status}")
                 await resp.text()
         except aiohttp.ClientError as err:
             raise PGWConnectionError(f"Failed to connect to PGW: {err}") from err
@@ -114,26 +106,18 @@ class PGWApiClient:
         headers = {**_HEADERS, "Referer": LOGIN_URL}
 
         try:
-            async with session.post(
-                VALIDATE_LOGIN_URL, json=payload, headers=headers
-            ) as resp:
+            async with session.post(VALIDATE_LOGIN_URL, json=payload, headers=headers) as resp:
                 if resp.status != 200:
-                    raise PGWAuthError(
-                        f"Login endpoint returned status {resp.status}"
-                    )
+                    raise PGWAuthError(f"Login endpoint returned status {resp.status}")
                 body = await resp.text()
         except aiohttp.ClientError as err:
-            raise PGWConnectionError(
-                f"Failed during authentication: {err}"
-            ) from err
+            raise PGWConnectionError(f"Failed during authentication: {err}") from err
 
         try:
             data = json.loads(body)
             inner = json.loads(data["d"])
         except (json.JSONDecodeError, KeyError) as err:
-            raise PGWConnectionError(
-                "Unexpected response from login endpoint"
-            ) from err
+            raise PGWConnectionError("Unexpected response from login endpoint") from err
 
         if isinstance(inner, dict) and "dtException" in inner:
             msg = inner["dtException"][0].get("MessageInformation", "Unknown error")
@@ -144,9 +128,7 @@ class PGWApiClient:
 
         first = inner[0]
         if isinstance(first, dict) and first.get("STATUS") == 0:
-            raise PGWAuthError(
-                first.get("Message", "Invalid username or password")
-            )
+            raise PGWAuthError(first.get("Message", "Invalid username or password"))
 
     async def _get_csrf_token(self, session: aiohttp.ClientSession) -> str:
         """Navigate to the usage page and extract the CSRF token."""
@@ -154,18 +136,12 @@ class PGWApiClient:
             async with session.get(DASHBOARD_URL, allow_redirects=True) as resp:
                 await resp.text()
 
-            async with session.get(
-                USAGE_URL, params={"type": "GU"}, allow_redirects=True
-            ) as resp:
+            async with session.get(USAGE_URL, params={"type": "GU"}, allow_redirects=True) as resp:
                 if resp.status != 200:
-                    raise PGWConnectionError(
-                        f"Usage page returned status {resp.status}"
-                    )
+                    raise PGWConnectionError(f"Usage page returned status {resp.status}")
                 html = await resp.text()
         except aiohttp.ClientError as err:
-            raise PGWConnectionError(
-                f"Failed to fetch usage page: {err}"
-            ) from err
+            raise PGWConnectionError(f"Failed to fetch usage page: {err}") from err
 
         match = re.search(r'id="hdnCSRFToken"[^>]*value="([^"]+)"', html)
         if not match:
@@ -173,31 +149,21 @@ class PGWApiClient:
 
         return match.group(1)
 
-    async def _load_billing(
-        self, session: aiohttp.ClientSession
-    ) -> BillingSummary:
+    async def _load_billing(self, session: aiohttp.ClientSession) -> BillingSummary:
         """Fetch billing summary from the BillDashboard page."""
         try:
             async with session.get(DASHBOARD_URL, allow_redirects=True) as resp:
                 await resp.text()
 
-            async with session.get(
-                BILL_DASHBOARD_URL, allow_redirects=True
-            ) as resp:
+            async with session.get(BILL_DASHBOARD_URL, allow_redirects=True) as resp:
                 if resp.status != 200:
-                    raise PGWConnectionError(
-                        f"BillDashboard returned status {resp.status}"
-                    )
+                    raise PGWConnectionError(f"BillDashboard returned status {resp.status}")
                 html = await resp.text()
         except aiohttp.ClientError as err:
-            raise PGWConnectionError(
-                f"Failed to fetch billing data: {err}"
-            ) from err
+            raise PGWConnectionError(f"Failed to fetch billing data: {err}") from err
 
         def field(name: str, default: str = "0") -> str:
-            match = re.search(
-                rf'id="{name}"[^>]*value="([^"]*)"', html
-            )
+            match = re.search(rf'id="{name}"[^>]*value="([^"]*)"', html)
             return match.group(1) if match else default
 
         current_bill = _parse_dollar(field("hdnTotalBillOFCurrentMonth"))
@@ -206,12 +172,8 @@ class PGWApiClient:
         previous_bill = _parse_dollar(field("hdnTotalBillOFPreviousMonth"))
         previous_usage = _parse_float(field("hdnGasUsageOFPreviousMonth"))
         previous_days = _parse_int(field("hdnnumOfDaysPreviousMonth"))
-        prev_year_bill = _parse_dollar(
-            field("hdnTotalBillOFPreviousYearPreviousMonth")
-        )
-        prev_year_usage = _parse_float(
-            field("hdnGasUsageOFPreviousYearPreviousMonth")
-        )
+        prev_year_bill = _parse_dollar(field("hdnTotalBillOFPreviousYearPreviousMonth"))
+        prev_year_usage = _parse_float(field("hdnGasUsageOFPreviousYearPreviousMonth"))
         balance = _parse_dollar(field("hdnPrevAmount"))
 
         # Parse period from billing comparison JSON
@@ -271,26 +233,18 @@ class PGWApiClient:
         }
 
         try:
-            async with session.post(
-                LOAD_GAS_URL, json=payload, headers=headers
-            ) as resp:
+            async with session.post(LOAD_GAS_URL, json=payload, headers=headers) as resp:
                 if resp.status != 200:
-                    raise PGWConnectionError(
-                        f"LoadGasUsage returned status {resp.status}"
-                    )
+                    raise PGWConnectionError(f"LoadGasUsage returned status {resp.status}")
                 body = await resp.text()
         except aiohttp.ClientError as err:
-            raise PGWConnectionError(
-                f"Failed to fetch gas usage: {err}"
-            ) from err
+            raise PGWConnectionError(f"Failed to fetch gas usage: {err}") from err
 
         try:
             data = json.loads(body)
             inner = json.loads(data["d"])
         except (json.JSONDecodeError, KeyError) as err:
-            raise PGWConnectionError(
-                "Unexpected response from LoadGasUsage"
-            ) from err
+            raise PGWConnectionError("Unexpected response from LoadGasUsage") from err
 
         if isinstance(inner, dict) and "dtException" in inner:
             msg = inner["dtException"][0].get("MessageInformation", "Unknown error")
@@ -356,26 +310,18 @@ class PGWApiClient:
         }
 
         try:
-            async with session.post(
-                LOAD_GAS_URL, json=payload, headers=headers
-            ) as resp:
+            async with session.post(LOAD_GAS_URL, json=payload, headers=headers) as resp:
                 if resp.status != 200:
-                    raise PGWConnectionError(
-                        f"LoadGasUsage (daily) returned status {resp.status}"
-                    )
+                    raise PGWConnectionError(f"LoadGasUsage (daily) returned status {resp.status}")
                 body = await resp.text()
         except aiohttp.ClientError as err:
-            raise PGWConnectionError(
-                f"Failed to fetch daily gas usage: {err}"
-            ) from err
+            raise PGWConnectionError(f"Failed to fetch daily gas usage: {err}") from err
 
         try:
             data = json.loads(body)
             inner = json.loads(data["d"])
         except (json.JSONDecodeError, KeyError) as err:
-            raise PGWConnectionError(
-                "Unexpected response from LoadGasUsage (daily)"
-            ) from err
+            raise PGWConnectionError("Unexpected response from LoadGasUsage (daily)") from err
 
         if isinstance(inner, dict) and "dtException" in inner:
             msg = inner["dtException"][0].get("MessageInformation", "Unknown error")
@@ -406,7 +352,6 @@ class PGWApiClient:
         usage_date: date,
     ) -> list[HourlyGasUsage]:
         """Call LoadGasUsage in daily mode with hourlyType to get hourly data."""
-        from datetime import datetime
 
         payload = {
             "Type": "C",
@@ -429,26 +374,18 @@ class PGWApiClient:
         }
 
         try:
-            async with session.post(
-                LOAD_GAS_URL, json=payload, headers=headers
-            ) as resp:
+            async with session.post(LOAD_GAS_URL, json=payload, headers=headers) as resp:
                 if resp.status != 200:
-                    raise PGWConnectionError(
-                        f"LoadGasUsage (hourly) returned status {resp.status}"
-                    )
+                    raise PGWConnectionError(f"LoadGasUsage (hourly) returned status {resp.status}")
                 body = await resp.text()
         except aiohttp.ClientError as err:
-            raise PGWConnectionError(
-                f"Failed to fetch hourly gas usage: {err}"
-            ) from err
+            raise PGWConnectionError(f"Failed to fetch hourly gas usage: {err}") from err
 
         try:
             data = json.loads(body)
             inner = json.loads(data["d"])
         except (json.JSONDecodeError, KeyError) as err:
-            raise PGWConnectionError(
-                "Unexpected response from LoadGasUsage (hourly)"
-            ) from err
+            raise PGWConnectionError("Unexpected response from LoadGasUsage (hourly)") from err
 
         if isinstance(inner, dict) and "dtException" in inner:
             msg = inner["dtException"][0].get("MessageInformation", "Unknown error")
@@ -474,20 +411,24 @@ class PGWApiClient:
 
 
 def _parse_datetime(dt_str: str | None) -> datetime | None:
-    """Parse a datetime string from the portal (various formats)."""
+    """Parse a datetime string from the portal (various formats).
+
+    Returns a naive datetime deliberately: the portal reports these in its
+    own local time with no timezone offset in the source string, so there is
+    no correct tzinfo to attach without guessing.
+    """
     if not dt_str:
         return None
-    from datetime import datetime
 
     for fmt in ("%m/%d/%Y %I:%M:%S %p", "%m/%d/%Y %H:%M:%S", "%m/%d/%y %I:%M:%S %p", "%m/%d/%y"):
         try:
-            return datetime.strptime(dt_str, fmt)
+            return datetime.strptime(dt_str, fmt)  # noqa: DTZ007 - naive by design, see docstring
         except ValueError:
             continue
 
     parsed_date = _parse_date(dt_str)
     if parsed_date:
-        return datetime(parsed_date.year, parsed_date.month, parsed_date.day)
+        return datetime(parsed_date.year, parsed_date.month, parsed_date.day)  # noqa: DTZ001 - naive by design, see docstring
     return None
 
 

{pgw_api-1.2.1 → pgw_api-1.4.0}/pgw_api/models.py

@@ -5,7 +5,6 @@ from __future__ import annotations
 from dataclasses import dataclass
 from datetime import date, datetime
 
-
 CCF_TO_CF = 100.0
 
 

{pgw_api-1.2.1 → pgw_api-1.4.0}/pgw_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pgw-api
-Version: 1.2.1
+Version: 1.4.0
 Summary: Python API client for Philadelphia Gas Works (PGW)
 Author: zackwag
 License: MIT
@@ -29,6 +29,7 @@ import asyncio
 import aiohttp
 from pgw_api import PGWApiClient
 
+
 async def main():
     client = PGWApiClient("your-email@example.com", "your-password")
 
@@ -40,6 +41,7 @@ async def main():
             if entry.period_start and entry.period_end:
                 print(f"  Period: {entry.period_start} to {entry.period_end}")
 
+
 asyncio.run(main())
 ```
 

{pgw_api-1.2.1 → pgw_api-1.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pgw-api"
-version = "1.2.1"
+version = "1.4.0"
 description = "Python API client for Philadelphia Gas Works (PGW)"
 readme = "README.md"
 license = {text = "MIT"}
@@ -25,3 +25,14 @@ asyncio_mode = "auto"
 
 [tool.setuptools.packages.find]
 include = ["pgw_api*"]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint.per-file-ignores]
+# These construct naive datetimes to match _parse_datetime's deliberately
+# naive output (the portal's timestamps carry no timezone offset) -- see
+# the docstring on _parse_datetime in pgw_api/client.py.
+"tests/test_client.py" = ["DTZ001"]
+"tests/test_models.py" = ["DTZ001"]
+"tests/test_parsing.py" = ["DTZ001"]

{pgw_api-1.2.1 → pgw_api-1.4.0}/tests/test_billing.py

@@ -7,8 +7,7 @@ import pytest
 
 from pgw_api.client import PGWApiClient
 from pgw_api.models import BillingSummary
-from tests.conftest import make_response, make_login_success, make_webmethod_response
-
+from tests.conftest import make_login_success, make_response
 
 BILLING_HTML = """
 <input type="hidden" id="hdnTotalBillOFCurrentMonth" value="$120.50" />
@@ -47,12 +46,14 @@ def _setup_session(responses):
 class TestBillingParsing:
     @pytest.mark.asyncio
     async def test_parses_all_fields(self):
-        session = _setup_session([
-            make_response(),                           # GET login page
-            make_response(text=make_login_success()),  # POST validateLogin
-            make_response(),                           # GET Dashboard
-            make_response(text=BILLING_HTML),           # GET BillDashboard
-        ])
+        session = _setup_session(
+            [
+                make_response(),  # GET login page
+                make_response(text=make_login_success()),  # POST validateLogin
+                make_response(),  # GET Dashboard
+                make_response(text=BILLING_HTML),  # GET BillDashboard
+            ]
+        )
 
         client = PGWApiClient("user", "pass")
         billing = await client.async_get_billing(session)
@@ -72,12 +73,14 @@ class TestBillingParsing:
     @pytest.mark.asyncio
     async def test_missing_fields_default_to_zero(self):
         html = "<html><body>no hidden fields here</body></html>"
-        session = _setup_session([
-            make_response(),
-            make_response(text=make_login_success()),
-            make_response(),
-            make_response(text=html),
-        ])
+        session = _setup_session(
+            [
+                make_response(),
+                make_response(text=make_login_success()),
+                make_response(),
+                make_response(text=html),
+            ]
+        )
 
         client = PGWApiClient("user", "pass")
         billing = await client.async_get_billing(session)
@@ -91,12 +94,14 @@ class TestBillingParsing:
     @pytest.mark.asyncio
     async def test_malformed_period_json(self):
         html = '<input type="hidden" id="hdnbillComparisionOFCurrentMonth" value="not json" />'
-        session = _setup_session([
-            make_response(),
-            make_response(text=make_login_success()),
-            make_response(),
-            make_response(text=html),
-        ])
+        session = _setup_session(
+            [
+                make_response(),
+                make_response(text=make_login_success()),
+                make_response(),
+                make_response(text=html),
+            ]
+        )
 
         client = PGWApiClient("user", "pass")
         billing = await client.async_get_billing(session)
@@ -107,32 +112,56 @@ class TestBillingParsing:
 class TestBillingSummaryModel:
     def test_current_usage_cf(self):
         b = BillingSummary(
-            current_bill=100, current_usage_ccf=50, current_period_days=30,
-            previous_bill=80, previous_usage_ccf=40, previous_period_days=30,
-            previous_year_bill=90, previous_year_usage_ccf=45, balance_due=100,
+            current_bill=100,
+            current_usage_ccf=50,
+            current_period_days=30,
+            previous_bill=80,
+            previous_usage_ccf=40,
+            previous_period_days=30,
+            previous_year_bill=90,
+            previous_year_usage_ccf=45,
+            balance_due=100,
         )
         assert b.current_usage_cf == 5000.0
 
     def test_previous_usage_cf(self):
         b = BillingSummary(
-            current_bill=100, current_usage_ccf=50, current_period_days=30,
-            previous_bill=80, previous_usage_ccf=40, previous_period_days=30,
-            previous_year_bill=90, previous_year_usage_ccf=45, balance_due=100,
+            current_bill=100,
+            current_usage_ccf=50,
+            current_period_days=30,
+            previous_bill=80,
+            previous_usage_ccf=40,
+            previous_period_days=30,
+            previous_year_bill=90,
+            previous_year_usage_ccf=45,
+            balance_due=100,
         )
         assert b.previous_usage_cf == 4000.0
 
     def test_current_rate(self):
         b = BillingSummary(
-            current_bill=200, current_usage_ccf=100, current_period_days=30,
-            previous_bill=80, previous_usage_ccf=40, previous_period_days=30,
-            previous_year_bill=90, previous_year_usage_ccf=45, balance_due=200,
+            current_bill=200,
+            current_usage_ccf=100,
+            current_period_days=30,
+            previous_bill=80,
+            previous_usage_ccf=40,
+            previous_period_days=30,
+            previous_year_bill=90,
+            previous_year_usage_ccf=45,
+            balance_due=200,
         )
         assert b.current_rate == 2.0
 
     def test_current_rate_zero_usage(self):
         b = BillingSummary(
-            current_bill=0, current_usage_ccf=0, current_period_days=0,
-            previous_bill=0, previous_usage_ccf=0, previous_period_days=0,
-            previous_year_bill=0, previous_year_usage_ccf=0, balance_due=0,
+            current_bill=0,
+            current_usage_ccf=0,
+            current_period_days=0,
+            previous_bill=0,
+            previous_usage_ccf=0,
+            previous_period_days=0,
+            previous_year_bill=0,
+            previous_year_usage_ccf=0,
+            balance_due=0,
         )
         assert b.current_rate is None