pywebpush 2.4.0__tar.gz → 2.5.0__tar.gz

{pywebpush-2.4.0 → pywebpush-2.5.0}/CHANGELOG.md

@@ -1,5 +1,10 @@
 # I am terrible at keeping this up-to-date.
 
+## 2.5.0
+
+- Add common `status_code` and `retry_after` accessors to `WebPushException`
+  for synchronous and asynchronous responses.
+
 ## 2.3.0 (2026-02-09)
 
 - Cleanup from @Rotzbua

{pywebpush-2.4.0 → pywebpush-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pywebpush
-Version: 2.4.0
+Version: 2.5.0
 Summary: WebPush publication library
 Author-email: JR Conlin <src+webpusher@jrconlin.com>
 License-Expression: MPL-2.0
@@ -132,6 +132,11 @@ try:
     )
 except WebPushException as ex:
     print("I'm sorry, Dave, but I can't do that: {}", repr(ex))
+    # status_code works with both webpush() and webpush_async().
+    if ex.status_code in (429, 503):
+        print("Push service requested a retry after:", ex.retry_after)
+        # retry_after is either a delay in seconds or an HTTP date:
+        # https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Retry-After
     # Mozilla returns additional information in the body of the response.
     if ex.response is not None and ex.response.json():
         extra = ex.response.json()

{pywebpush-2.4.0 → pywebpush-2.5.0}/README.md

@@ -104,6 +104,11 @@ try:
     )
 except WebPushException as ex:
     print("I'm sorry, Dave, but I can't do that: {}", repr(ex))
+    # status_code works with both webpush() and webpush_async().
+    if ex.status_code in (429, 503):
+        print("Push service requested a retry after:", ex.retry_after)
+        # retry_after is either a delay in seconds or an HTTP date:
+        # https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Retry-After
     # Mozilla returns additional information in the body of the response.
     if ex.response is not None and ex.response.json():
         extra = ex.response.json()

{pywebpush-2.4.0 → pywebpush-2.5.0}/README.rst

@@ -219,11 +219,11 @@ If you’re not really into coding your own solution, there’s also a
 
 This uses two files:
 
-- the *data* file, which contains the message to send, in whatever form
-  you like.
-- the *subscription info* file, which contains the subscription
-  information as JSON encoded data. This is usually returned by the Push
-  ``subscribe`` method and looks something like:
+-  the *data* file, which contains the message to send, in whatever form
+   you like.
+-  the *subscription info* file, which contains the subscription
+   information as JSON encoded data. This is usually returned by the
+   Push ``subscribe`` method and looks something like:
 
 .. code:: json
 

{pywebpush-2.4.0 → pywebpush-2.5.0}/pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pywebpush"
-version = "2.4.0"
+version = "2.5.0"
 # PYTHON_VER
 requires-python = ">= 3.10"
 license = "MPL-2.0"

{pywebpush-2.4.0 → pywebpush-2.5.0}/pywebpush/__init__.py

@@ -25,7 +25,11 @@ from requests import Response
 class WebPushException(Exception):
     """Web Push failure.
 
-    This may contain the requests.Response
+    This may contain a requests.Response or aiohttp.ClientResponse.
+
+    ``status_code`` and ``retry_after`` provide a common interface for
+    inspecting either response type without discarding the original
+    ``response`` object.
 
     """
 
@@ -44,6 +48,26 @@ class WebPushException(Exception):
                 extra = f", Response {self.response}"
         return f"WebPushException: {self.message}{extra}"
 
+    @property
+    def status_code(self) -> int | None:
+        """Return the HTTP status for synchronous or asynchronous responses."""
+        if self.response is None:
+            return None
+        return getattr(
+            self.response,
+            "status_code",
+            getattr(self.response, "status", None),
+        )
+
+    @property
+    def retry_after(self) -> str | None:
+        """Return the provider's Retry-After header, when present.
+
+        The value can be either a delay in seconds or an HTTP date. See
+        https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Retry-After
+        """
+        return getattr(self.response, "headers", {}).get("Retry-After", None)
+
 
 class NoData(Exception):
     """Message contained No Data, no encoding required."""

{pywebpush-2.4.0 → pywebpush-2.5.0}/pywebpush/tests/test_webpush.py

@@ -563,6 +563,8 @@ class WebpushExceptionTestCase(unittest.TestCase):
 
         exp = WebPushException("foo")
         assert f"{exp}" == "WebPushException: foo"
+        assert exp.status_code is None
+        assert exp.retry_after is None
         # Really should try to load the response to verify, but this mock
         # covers what we need.
         response = Mock(spec=Response)
@@ -577,9 +579,20 @@ class WebpushExceptionTestCase(unittest.TestCase):
         response.json.return_value = json.loads(response.text)
         response.status_code = 401
         response.reason = "Unauthorized"
+        response.headers = {"Retry-After": "120"}
         exp = WebPushException("foo", response)
         assert f"{exp}" == "WebPushException: foo, Response {}".format(response.text)
         assert f"{exp.response}", "<Response [401]>"
         assert cast(requests.Response, exp.response).json().get("errno") == 109
+        assert exp.status_code == 401
+        assert exp.retry_after == "120"
+
+        async_response = Mock(spec=["status", "headers", "text"])
+        async_response.status = 503
+        async_response.headers = {"Retry-After": "Wed, 21 Oct 2015 07:28:00 GMT"}
+        exp = WebPushException("async failure", async_response)
+        assert exp.status_code == 503
+        assert exp.retry_after == "Wed, 21 Oct 2015 07:28:00 GMT"
+
         exp = WebPushException("foo", [1, 2, 3])
         assert f"{exp}" == "WebPushException: foo, Response [1, 2, 3]"

{pywebpush-2.4.0 → pywebpush-2.5.0}/pywebpush.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pywebpush
-Version: 2.4.0
+Version: 2.5.0
 Summary: WebPush publication library
 Author-email: JR Conlin <src+webpusher@jrconlin.com>
 License-Expression: MPL-2.0
@@ -132,6 +132,11 @@ try:
     )
 except WebPushException as ex:
     print("I'm sorry, Dave, but I can't do that: {}", repr(ex))
+    # status_code works with both webpush() and webpush_async().
+    if ex.status_code in (429, 503):
+        print("Push service requested a retry after:", ex.retry_after)
+        # retry_after is either a delay in seconds or an HTTP date:
+        # https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Retry-After
     # Mozilla returns additional information in the body of the response.
     if ex.response is not None and ex.response.json():
         extra = ex.response.json()