Merge pull request #44 from alexmv/master

More complete types, custom error handler, and fix a deadlock

Author: Fatal1ty

aioapns/client.py

@@ -1,6 +1,7 @@
 from ssl import SSLContext
-from typing import Optional
+from typing import Awaitable, Callable, Optional
 
+from aioapns.common import NotificationRequest, NotificationResult
 from aioapns.connection import (
     APNsBaseConnectionPool,
     APNsCertConnectionPool,
@@ -22,8 +23,14 @@ def __init__(
         use_sandbox: bool = False,
         no_cert_validation: bool = False,
         ssl_context: Optional[SSLContext] = None,
-    ):
+        err_func: Optional[
+            Callable[
+                [NotificationRequest, NotificationResult], Awaitable[None]
+            ]
+        ] = None,
+    ) -> None:
         self.pool: APNsBaseConnectionPool
+        self.err_func = err_func
         if client_cert is not None and key is not None:
             raise ValueError("cannot specify both client_cert and key")
         elif client_cert:
@@ -53,13 +60,18 @@ def __init__(
                 "the key credentials"
             )
 
-    async def send_notification(self, request):
+    async def send_notification(
+        self, request: NotificationRequest
+    ) -> NotificationResult:
         response = await self.pool.send_notification(request)
         if not response.is_successful:
-            logger.error(
-                "Status of notification %s is %s (%s)",
-                request.notification_id,
-                response.status,
-                response.description,
-            )
+            if self.err_func is not None:
+                await self.err_func(request, response)
+            else:
+                logger.error(
+                    "Status of notification %s is %s (%s)",
+                    request.notification_id,
+                    response.status,
+                    response.description,
+                )
         return response

aioapns/common.py

@@ -1,5 +1,6 @@
 import asyncio
 from enum import Enum
+from typing import Any, Dict, Optional
 from uuid import uuid4
 
 PRIORITY_NORMAL = "5"
@@ -29,14 +30,14 @@ class NotificationRequest:
 
     def __init__(
         self,
-        device_token,
-        message,
-        notification_id=None,
-        time_to_live=None,
-        priority=None,
-        collapse_key=None,
-        push_type=None,
-    ):
+        device_token: str,
+        message: Dict[str, Any],
+        notification_id: Optional[str] = None,
+        time_to_live: Optional[int] = None,
+        priority: Optional[int] = None,
+        collapse_key: Optional[str] = None,
+        push_type: Optional[PushType] = None,
+    ) -> None:
         self.device_token = device_token
         self.message = message
         self.notification_id = notification_id or str(uuid4())
@@ -49,23 +50,30 @@ def __init__(
 class NotificationResult:
     __slots__ = ("notification_id", "status", "description")
 
-    def __init__(self, notification_id, status, description=None):
+    def __init__(
+        self,
+        notification_id: str,
+        status: str,
+        description: Optional[str] = None,
+    ):
         self.notification_id = notification_id
         self.status = status
         self.description = description
 
     @property
-    def is_successful(self):
+    def is_successful(self) -> bool:
         return self.status == APNS_RESPONSE_CODE.SUCCESS
 
 
 class DynamicBoundedSemaphore(asyncio.BoundedSemaphore):
+    _bound_value: int
+
     @property
-    def bound(self):
+    def bound(self) -> int:
         return self._bound_value
 
     @bound.setter
-    def bound(self, new_bound):
+    def bound(self, new_bound: int) -> None:
         if new_bound > self._bound_value:
             if self._value > 0:
                 self._value += new_bound - self._bound_value
@@ -76,13 +84,13 @@ def bound(self, new_bound):
             self._value -= self._bound_value - new_bound
         self._bound_value = new_bound
 
-    def release(self):
+    def release(self) -> None:
         self._value += 1
         if self._value > self._bound_value:
             self._value = self._bound_value
         self._wake_up_next()
 
-    def destroy(self, exc):
+    def destroy(self, exc: Exception) -> None:
         while self._waiters:
             waiter = self._waiters.popleft()
             if not waiter.done():