pywebpush 2.3.0__tar.gz → 2.5.0__tar.gz

{pywebpush-2.3.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.3.0 → pywebpush-2.5.0}/MANIFEST.in

@@ -3,3 +3,5 @@ include *.txt
 include setup.*
 include LICENSE
 recursive-include pywebpush *.py
+global-exclude */__pycache__/*
+global-exclude *.pyc

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

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: pywebpush
-Version: 2.3.0
+Version: 2.5.0
 Summary: WebPush publication library
 Author-email: JR Conlin <src+webpusher@jrconlin.com>
-License: MPL-2.0
+License-Expression: MPL-2.0
 Project-URL: Homepage, https://github.com/web-push-libs/pywebpush
 Keywords: webpush,vapid,notification
 Classifier: Topic :: Internet :: WWW/HTTP
@@ -14,11 +14,13 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp
-Requires-Dist: cryptography>=2.6.1
+Requires-Dist: cryptography>=47.0.0
 Requires-Dist: http-ece>=1.1.0
 Requires-Dist: requests>=2.21.0
 Requires-Dist: py-vapid>=1.7.0
 Provides-Extra: dev
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: mock; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
@@ -130,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.3.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.3.0 → pywebpush-2.5.0}/pyproject.toml

@@ -9,9 +9,10 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pywebpush"
-version = "2.3.0"
+version = "2.5.0"
+# PYTHON_VER
 requires-python = ">= 3.10"
-license = { text = "MPL-2.0" }
+license = "MPL-2.0"
 authors = [{ name = "JR Conlin", email = "src+webpusher@jrconlin.com" }]
 description = "WebPush publication library"
 readme = "README.md"
@@ -22,13 +23,20 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
 ]
-dynamic = ["dependencies"]
+dependencies = [
+    "aiohttp",
+    "cryptography>=47.0.0",
+    "http-ece>=1.1.0",
+    "requests>=2.21.0",
+    "py-vapid>=1.7.0",
+]
+
 
 [project.urls]
 Homepage = "https://github.com/web-push-libs/pywebpush"
 
 [project.optional-dependencies]
-dev = ["black", "mock", "pytest"]
+dev = ["isort", "bandit", "black", "mock", "pytest"]
 
 # create the `pywebpush` helper using `python -m pip install --editable .`
 [project.scripts]
@@ -39,3 +47,29 @@ dependencies = { file = "requirements.txt" }
 
 [tool.setuptools.packages.find]
 include = ["pywebpush*"]
+
+[tool.isort]
+profile = "black"
+skip_gitignore = true
+
+[tool.bandit]
+# skips asserts
+# B101: https://bandit.readthedocs.io/en/latest/plugins/b101_assert_used.html#
+# skip false detect of hardcoded sql
+# B608:https://bandit.readthedocs.io/en/latest/plugins/B608_hardcoded_sql_expressions.html#
+skips = ["B101", "B608"]
+
+[tool.mypy]
+disable_error_code = "attr-defined"
+disallow_untyped_calls = false
+follow_imports = "normal"
+ignore_missing_imports = true
+pretty = true
+show_error_codes = true
+strict_optional = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_ignores = true
+warn_unreachable = true
+check_untyped_defs = true

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

@@ -2,27 +2,22 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-import asyncio
 import base64
 import json
+import logging
 import os
 import time
-import logging
 from copy import deepcopy
-from typing import cast, Union, Dict
-
-try:
-    from urlparse import urlparse
-except ImportError:  # pragma nocover
-    from urllib.parse import urlparse
+from types import ModuleType
+from typing import Mapping, cast
+from urllib.parse import urlparse
 
 import aiohttp
 import http_ece
 import requests
 from cryptography.hazmat.backends import default_backend
-from cryptography.hazmat.primitives.asymmetric import ec
 from cryptography.hazmat.primitives import serialization
-from functools import partial
+from cryptography.hazmat.primitives.asymmetric import ec
 from py_vapid import Vapid, Vapid01
 from requests import Response
 
@@ -30,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.
 
     """
 
@@ -49,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."""
@@ -80,7 +99,9 @@ class CaseInsensitiveDict(dict):
         except KeyError:
             return default
 
-    def update(self, data) -> None:
+    # Skip mypy check on the following because the declaration is too
+    # abstract
+    def update(self, data: dict) -> None:  # type: ignore
         for key in data:
             self.__setitem__(key, data[key])
 
@@ -120,22 +141,20 @@ class WebPusher:
 
     """
 
-    subscription_info = {}
-    valid_encodings = [
+    subscription_info: Mapping = {}
+    valid_encodings: list[str] = [
         # "aesgcm128",  # this is draft-0, but DO NOT USE.
         "aesgcm",  # draft-httpbis-encryption-encoding-01
         "aes128gcm",  # RFC8188 Standard encoding
     ]
-    verbose = False
+    verbose: bool = False
+    mod_or_session: ModuleType | requests.Session
 
-    # Note: the type declarations are not valid under python 3.8,
     def __init__(
         self,
-        subscription_info: Dict[
-            str, Union[Union[str, bytes], Dict[str, Union[str, bytes]]]
-        ],
-        requests_session: Union[None, requests.Session] = None,
-        aiohttp_session: Union[None, aiohttp.client.ClientSession] = None,
+        subscription_info: Mapping,
+        requests_session: None | requests.Session = None,
+        aiohttp_session: None | aiohttp.client.ClientSession = None,
         verbose: bool = False,
     ) -> None:
         """Initialize using the info provided by the client PushSubscription
@@ -144,22 +163,16 @@ class WebPusher:
 
         :param subscription_info: a dict containing the subscription_info from
             the client.
-        :type subscription_info: dict
-
         :param requests_session: a requests.Session object to optimize requests
             to the same client.
-        :type requests_session: requests.Session
-
         :param verbose: provide verbose feedback
-        :type verbose: bool
-
         """
 
         self.verbose = verbose
         if requests_session is None:
-            self.requests_method = requests
+            self.mod_or_session = requests
         else:
-            self.requests_method = requests_session
+            self.mod_or_session = requests_session
 
         self.aiohttp_session = aiohttp_session
 
@@ -168,8 +181,8 @@ class WebPusher:
         self.subscription_info = deepcopy(subscription_info)
         self.auth_key = self.receiver_key = None
         if "keys" in subscription_info:
-            keys: Dict[str, Union[str, bytes]] = cast(
-                Dict[str, Union[str, bytes]], self.subscription_info["keys"]
+            keys: dict[str, str | bytes] = cast(
+                dict[str, str | bytes], self.subscription_info["keys"]
             )
             for k in ["p256dh", "auth"]:
                 if keys.get(k) is None:
@@ -202,7 +215,6 @@ class WebPusher:
         :param data: A serialized block of byte data (String, JSON, bit array,
             etc.) Make sure that whatever you send, your client knows how
             to understand it.
-        :type data: str
         :param content_encoding: The content_encoding type to use to encrypt
             the data. Defaults to RFC8188 "aes128gcm". The previous draft-01 is
             "aesgcm", however this format is now deprecated.
@@ -217,7 +229,7 @@ class WebPusher:
         if not self.auth_key or not self.receiver_key:
             raise WebPushException("No keys specified in subscription info")
         self.verb("Encoding data...")
-        salt = None
+        salt: bytes | None = None
         if content_encoding not in self.valid_encodings:
             raise WebPushException(
                 "Invalid content encoding specified. "
@@ -226,7 +238,7 @@ class WebPusher:
         if content_encoding == "aesgcm":
             self.verb("Generating salt for aesgcm...")
             salt = os.urandom(16)
-            logging.debug(f"Salt: {salt}")
+            logging.debug(f"Salt: {salt!r}")
         # The server key is an ephemeral ECDH key used only for this
         # transaction
         server_key = ec.generate_private_key(ec.SECP256R1(), default_backend())
@@ -235,8 +247,6 @@ class WebPusher:
             format=serialization.PublicFormat.UncompressedPoint,
         )
 
-        if isinstance(data, str):
-            data = bytes(data.encode("utf8"))
         if content_encoding == "aes128gcm":
             self.verb("Encrypting to aes128gcm...")
             encrypted = http_ece.encrypt(
@@ -266,20 +276,17 @@ class WebPusher:
                 reply["salt"] = base64.urlsafe_b64encode(salt).strip(b"=")
         return reply
 
-    def as_curl(self, endpoint: str, encoded_data: bytes, headers: Dict[str, str]) -> str:
+    def as_curl(
+        self, endpoint: str, encoded_data: bytes, headers: dict[str, str]
+    ) -> str:
         """Return the send as a curl command.
 
         Useful for debugging. This will write out the encoded data to a local
         file named `encrypted.data`
 
         :param endpoint: Push service endpoint URL
-        :type endpoint: basestring
         :param encoded_data: byte array of encoded data
-        :type encoded_data: bytearray
         :param headers: Additional headers for the send
-        :type headers: dict
-        :returns string
-
         """
         header_list = [
             f'-H "{key.lower()}: {val}" \\ \n' for key, val in headers.items()
@@ -291,17 +298,15 @@ class WebPusher:
             data = "--data-binary @encrypted.data"
         if "content-length" not in headers:
             self.verb("Generating content-length header...")
-            header_list.append(
-                f'-H "content-length: {len(encoded_data)}" \\ \n'
-            )
+            header_list.append(f'-H "content-length: {len(encoded_data)}" \\ \n')
         return """curl -vX POST {url} \\\n{headers}{data}""".format(
             url=endpoint, headers="".join(header_list), data=data
         )
 
     def _prepare_send_data(
         self,
-        data: Union[None, bytes] = None,
-        headers: Union[None, Dict[str, str]] = None,
+        data: None | bytes = None,
+        headers: None | dict[str, str] = None,
         ttl: int = 0,
         content_encoding: str = "aes128gcm",
     ) -> dict:
@@ -310,19 +315,18 @@ class WebPusher:
         :param data: A serialized block of data (see encode() ).
         :type data: str
         :param headers: A dictionary containing any additional HTTP headers.
-        :type headers: dict
         :param ttl: The Time To Live in seconds for this message if the
             recipient is not online. (Defaults to "0", which discards the
             message immediately if the recipient is unavailable.)
-        :type ttl: int
         :param content_encoding: ECE content encoding (defaults to "aes128gcm")
-        :type content_encoding: str
         """
         # Encode the data.
         if headers is None:
             headers = dict()
         encoded = CaseInsensitiveDict()
         headers = CaseInsensitiveDict(headers)
+        if isinstance(data, str):
+            data = data.encode()
         if data:
             encoded = self.encode(data, content_encoding)
             if "crypto_key" in encoded:
@@ -361,7 +365,7 @@ class WebPusher:
 
         return {"endpoint": endpoint, "data": encoded_data, "headers": headers}
 
-    def send(self, *args, **kwargs) -> Union[Response, str]:
+    def send(self, *args, **kwargs) -> Response | str:
         """Encode and send the data to the Push Service"""
         timeout = kwargs.pop("timeout", 10000)
         curl = kwargs.pop("curl", False)
@@ -374,7 +378,7 @@ class WebPusher:
             headers = params["headers"]
             return self.as_curl(endpoint, encoded_data=encoded_data, headers=headers)
 
-        resp = self.requests_method.post(
+        resp = self.mod_or_session.post(
             endpoint,
             timeout=timeout,
             **params,
@@ -383,11 +387,11 @@ class WebPusher:
             "\nResponse:\n\tcode: {}\n\tbody: {}\n\theaders: {}",
             resp.status_code,
             resp.text or "Empty",
-            resp.headers or "None"
+            resp.headers or "None",
         )
         return resp
 
-    async def send_async(self, *args, **kwargs) -> Union[aiohttp.ClientResponse, str]:
+    async def send_async(self, *args, **kwargs) -> aiohttp.ClientResponse | str:
         timeout = kwargs.pop("timeout", 10000)
         curl = kwargs.pop("curl", False)
 
@@ -414,22 +418,20 @@ class WebPusher:
 
 
 def webpush(
-    subscription_info: Dict[
-        str, Union[Union[str, bytes], Dict[str, Union[str, bytes]]]
-    ],
-    data: Union[None, str] = None,
-    vapid_private_key: Union[None, Vapid, str] = None,
-    vapid_claims: Union[None, Dict[str, Union[str, int]]] = None,
+    subscription_info: Mapping,
+    data: None | str = None,
+    vapid_private_key: None | Vapid | str = None,
+    vapid_claims: None | dict[str, str | int] = None,
     content_encoding: str = "aes128gcm",
     curl: bool = False,
-    timeout: Union[None, float] = None,
+    timeout: None | float = None,
     ttl: int = 0,
     verbose: bool = False,
-    headers: Union[None, Dict[str, Union[str, int, float]]] = None,
-    requests_session: Union[None, requests.Session] = None,
-) -> Union[str, requests.Response]:
+    headers: None | dict[str, str | int | float] = None,
+    requests_session: None | requests.Session = None,
+) -> str | requests.Response:
     """
-        One call solution to endcode and send `data` to the endpoint
+        One call solution to encode and send `data` to the endpoint
         contained in `subscription_info` using optional VAPID auth headers.
 
         in example:
@@ -453,28 +455,17 @@ def webpush(
         `WebPushException`.
 
     :param subscription_info: Provided by the client call
-    :type subscription_info: dict
     :param data: Serialized data to send
-    :type data: str
     :param vapid_private_key: Vapid instance or path to vapid private key PEM \
                               or encoded str
     :type vapid_private_key: Union[Vapid, str]
     :param vapid_claims: Dictionary of claims ('sub' required)
-    :type vapid_claims: dict
     :param content_encoding: Optional content type string
-    :type content_encoding: str
     :param curl: Return as "curl" string instead of sending
-    :type curl: bool
     :param timeout: POST requests timeout
-    :type timeout: float
     :param ttl: Time To Live
-    :type ttl: int
     :param verbose: Provide verbose feedback
-    :type verbose: bool
-    :return requests.Response or string
     :param headers: Dictionary of extra HTTP headers to include
-    :type headers: dict
-
     """
     if headers is None:
         headers = dict()
@@ -498,7 +489,9 @@ def webpush(
             # encryption lives for 12 hours
             vapid_claims["exp"] = int(time.time()) + (12 * 60 * 60)
             if verbose:
-                logging.info("Setting VAPID expry to {}...".format(vapid_claims["exp"]))
+                logging.info(
+                    "Setting VAPID expiry to {}...".format(vapid_claims["exp"])
+                )
         if not vapid_private_key:
             raise WebPushException("VAPID dict missing 'private_key'")
         if isinstance(vapid_private_key, Vapid01):
@@ -544,23 +537,21 @@ def webpush(
 
 
 async def webpush_async(
-    subscription_info: Dict[
-        str, Union[Union[str, bytes], Dict[str, Union[str, bytes]]]
-    ],
-    data: Union[None, str] = None,
-    vapid_private_key: Union[None, Vapid, str] = None,
-    vapid_claims: Union[None, Dict[str, Union[str, int]]] = None,
+    subscription_info: dict[str, str | bytes | dict[str, str | bytes]],
+    data: None | str = None,
+    vapid_private_key: None | Vapid | str = None,
+    vapid_claims: None | dict[str, str | int] = None,
     content_encoding: str = "aes128gcm",
     curl: bool = False,
-    timeout: Union[None, float] = None,
+    timeout: None | float = None,
     ttl: int = 0,
     verbose: bool = False,
-    headers: Union[None, Dict[str, Union[str, int, float]]] = None,
-    aiohttp_session: Union[None, aiohttp.ClientSession] = None,
-) -> Union[str, aiohttp.ClientResponse]:
+    headers: None | dict[str, str | int | float] = None,
+    aiohttp_session: None | aiohttp.ClientSession = None,
+) -> str | aiohttp.ClientResponse:
     """
-        Async version of webpush function. One call solution to encode and send 
-        `data` to the endpoint contained in `subscription_info` using optional 
+        Async version of webpush function. One call solution to encode and send
+        `data` to the endpoint contained in `subscription_info` using optional
         VAPID auth headers.
 
         Example:
@@ -588,30 +579,18 @@ async def webpush_async(
         `WebPushException`.
 
     :param subscription_info: Provided by the client call
-    :type subscription_info: dict
     :param data: Serialized data to send
-    :type data: str
     :param vapid_private_key: Vapid instance or path to vapid private key PEM \
                               or encoded str
     :type vapid_private_key: Union[Vapid, str]
     :param vapid_claims: Dictionary of claims ('sub' required)
-    :type vapid_claims: dict
     :param content_encoding: Optional content type string
-    :type content_encoding: str
     :param curl: Return as "curl" string instead of sending
-    :type curl: bool
     :param timeout: POST requests timeout
-    :type timeout: float
     :param ttl: Time To Live
-    :type ttl: int
     :param verbose: Provide verbose feedback
-    :type verbose: bool
     :param headers: Dictionary of extra HTTP headers to include
-    :type headers: dict
     :param aiohttp_session: Optional aiohttp ClientSession for connection reuse
-    :type aiohttp_session: aiohttp.ClientSession
-    :return aiohttp.ClientResponse or string
-
     """
     if headers is None:
         headers = dict()

{pywebpush-2.3.0 → pywebpush-2.5.0}/pywebpush/__main__.py

@@ -1,12 +1,11 @@
 import argparse
-import os
 import json
 import logging
-import math
+import os
 
 from requests import JSONDecodeError
 
-from pywebpush import webpush, WebPushException
+from pywebpush import WebPushException, webpush
 
 
 def get_config():
@@ -20,7 +19,8 @@ def get_config():
         "--wns",
         help="Include WNS cache header based on TTL",
         default=False,
-        action="store_true")
+        action="store_true",
+    )
     parser.add_argument(
         "--curl",
         help="Don't send, display as curl command",
@@ -75,9 +75,7 @@ def get_config():
                 try:
                     args.claims = json.loads(r.read())
                 except JSONDecodeError as e:
-                    raise WebPushException(
-                        f"Could not read the VAPID claims file {e}"
-                    )
+                    raise WebPushException(f"Could not read the VAPID claims file {e}")
     except Exception as ex:
         logging.error(f"Couldn't read input {ex}.")
         raise ex

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

@@ -1,23 +1,23 @@
 import base64
 import json
 import os
-import unittest
 import time
-from typing import cast, Union, Dict
-from unittest.mock import patch, Mock, AsyncMock
+import unittest
+from typing import cast
+from unittest.mock import AsyncMock, Mock, patch
 
 import http_ece
 import py_vapid
 import requests
-from cryptography.hazmat.primitives.asymmetric import ec
-from cryptography.hazmat.primitives import serialization
 from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives import serialization
+from cryptography.hazmat.primitives.asymmetric import ec
 
 from pywebpush import (
-    WebPusher,
+    CaseInsensitiveDict,
     NoData,
+    WebPusher,
     WebPushException,
-    CaseInsensitiveDict,
     webpush,
     webpush_async,
 )
@@ -53,16 +53,16 @@ class WebpushTestUtils(unittest.TestCase):
 
     def test_init(self):
         # use static values so we know what to look for in the reply
-        subscription_info = {
-            "endpoint": "https://example.com/",
-            "keys": {
-                "p256dh": (
+        subscription_info = dict(
+            endpoint="https://example.com/",
+            keys=dict(
+                p256dh=(
                     "BOrnIslXrUow2VAzKCUAE4sIbK00daEZCswOcf8m3T"
                     "F8V82B-OpOg5JbmYLg44kRcvQC1E2gMJshsUYA-_zMPR8"
                 ),
-                "auth": "k8JV6sjdbhAi1n3_LDBLvA",
-            },
-        }
+                auth="k8JV6sjdbhAi1n3_LDBLvA",
+            ),
+        )
         rk_decode = (
             b'\x04\xea\xe7"\xc9W\xadJ0\xd9P3(%\x00\x13\x8b'
             b"\x08l\xad4u\xa1\x19\n\xcc\x0eq\xff&\xdd1"
@@ -192,7 +192,7 @@ class WebpushTestUtils(unittest.TestCase):
         subscription_info = self._gen_subscription_info()
         data = "Mary had a little lamb"
         vapid_key = py_vapid.Vapid.from_string(self.vapid_key)
-        claims: Dict[str, Union[str, int]] = dict(
+        claims: dict[str, str | int] = dict(
             sub="mailto:ops@example.com", aud="https://example.com"
         )
         webpush(
@@ -211,7 +211,7 @@ class WebpushTestUtils(unittest.TestCase):
         subscription_info = self._gen_subscription_info()
         data = "Mary had a little lamb"
         vapid_key = py_vapid.Vapid.from_string(self.vapid_key)
-        claims = dict(
+        claims: dict[str, str | int] = dict(
             sub="mailto:ops@example.com",
             aud="https://example.com",
             exp=int(time.time() - 48600),
@@ -456,7 +456,7 @@ class WebPusherAsyncTestCase(WebpushTestUtils, unittest.IsolatedAsyncioTestCase)
         subscription_info = self._gen_subscription_info()
         data = "Mary had a little lamb"
         vapid_key = py_vapid.Vapid.from_string(self.vapid_key)
-        claims: Dict[str, Union[str, int]] = dict(
+        claims: dict[str, str | int] = dict(
             sub="mailto:ops@example.com", aud="https://example.com"
         )
         await webpush_async(
@@ -477,7 +477,7 @@ class WebPusherAsyncTestCase(WebpushTestUtils, unittest.IsolatedAsyncioTestCase)
         subscription_info = self._gen_subscription_info()
         data = "Mary had a little lamb"
         vapid_key = py_vapid.Vapid.from_string(self.vapid_key)
-        claims = dict(
+        claims: dict[str, str | int] = dict(
             sub="mailto:ops@example.com",
             aud="https://example.com",
             exp=int(time.time() - 48600),
@@ -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,11 +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}" == "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.3.0 → pywebpush-2.5.0}/pywebpush.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: pywebpush
-Version: 2.3.0
+Version: 2.5.0
 Summary: WebPush publication library
 Author-email: JR Conlin <src+webpusher@jrconlin.com>
-License: MPL-2.0
+License-Expression: MPL-2.0
 Project-URL: Homepage, https://github.com/web-push-libs/pywebpush
 Keywords: webpush,vapid,notification
 Classifier: Topic :: Internet :: WWW/HTTP
@@ -14,11 +14,13 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp
-Requires-Dist: cryptography>=2.6.1
+Requires-Dist: cryptography>=47.0.0
 Requires-Dist: http-ece>=1.1.0
 Requires-Dist: requests>=2.21.0
 Requires-Dist: py-vapid>=1.7.0
 Provides-Extra: dev
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: mock; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
@@ -130,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.3.0 → pywebpush-2.5.0}/pywebpush.egg-info/SOURCES.txt

@@ -5,14 +5,11 @@ MANIFEST.in
 README.md
 README.rst
 entry_points.txt
-local_test.txt
 pyproject.toml
 requirements.txt
 setup.cfg
-test-requirements.txt
 pywebpush/__init__.py
 pywebpush/__main__.py
-pywebpush/foo.py
 pywebpush.egg-info/PKG-INFO
 pywebpush.egg-info/SOURCES.txt
 pywebpush.egg-info/dependency_links.txt

{pywebpush-2.3.0 → pywebpush-2.5.0}/pywebpush.egg-info/requires.txt

@@ -1,10 +1,12 @@
 aiohttp
-cryptography>=2.6.1
+cryptography>=47.0.0
 http-ece>=1.1.0
 requests>=2.21.0
 py-vapid>=1.7.0
 
 [dev]
+isort
+bandit
 black
 mock
 pytest

{pywebpush-2.3.0 → pywebpush-2.5.0}/requirements.txt

@@ -1,3 +1,4 @@
+# NOTE: Requirements are now in pyproject.toml
 aiohttp
 cryptography>=2.6.1
 http-ece>=1.1.0

pywebpush-2.3.0/local_test.txt

@@ -1,3 +0,0 @@
-Amidst the mists and coldest frosts I thrust my fists against the
-posts and still demand to see the ghosts.
-

pywebpush-2.3.0/pywebpush/foo.py

@@ -1,51 +0,0 @@
-from pywebpush import webpush
-import json
-import logging
-import datetime
-
-
-def send_push_notification(subscription, payload):
-
-    try:
-
-        # subscriptionData = json.loads(subscription)
-
-        # logger.error(subscriptionData)
-
-        webpush(
-            subscription_info={
-                "endpoint": subscription["endpoint"],
-                "keys": subscription["keys"],
-            },
-            data=json.dumps(payload),
-            vapid_claims={
-                "aud": "https://eshopper.africa",
-                "exp": int((datetime.datetime.now().timestamp())) + 86400,
-                "sub": "mailto:events@eshopper.africa",
-            },
-            vapid_private_key="UCUKEHn7Jd33QZx5lJFKBY4plOxGsJ6xJSOzE14jQlo",
-        )
-
-        # subscription_info = { 'endpoint': subscription['endpoint'], 'keys': subscription['keys'] },
-
-        # data = json.loads(payload),
-
-        # headers = {}
-
-        # ttl = 0
-
-        # gcm_key = ''
-
-        # content_encoding="aes128gcm"
-
-        # reg_id=""
-
-        # WebPusher = webpush(subscription_info)
-
-        # WebPusher(subscription_info).send(data, headers, ttl, gcm_key, reg_id, content_encoding, timeout=None)
-
-    except Exception as inst:
-        print(f" webpush Notification Error : {inst}")
-
-
-send_push_notification({"endpoint": "https://example.com", "keys": {}}, "laaaa")

pywebpush-2.3.0/test-requirements.txt

@@ -1,4 +0,0 @@
--r requirements.txt
-black
-mock
-pytest