basic boilerplate to prep aiohttp

Author: UmanShahzad

ipinfo/handler_async.py

@@ -7,6 +7,7 @@
 import os
 import sys
 
+import aiohttp
 import requests
 
 from .cache.default import DefaultCache
@@ -41,6 +42,9 @@ def __init__(self, access_token=None, **kwargs):
         if "timeout" not in self.request_options:
             self.request_options["timeout"] = self.REQUEST_TIMEOUT_DEFAULT
 
+        # setup aiohttp
+        self.httpsess = None
+
         # setup cache
         if "cache" in kwargs:
             self.cache = kwargs["cache"]
@@ -52,8 +56,34 @@ def __init__(self, access_token=None, **kwargs):
                 cache_options["ttl"] = self.CACHE_TTL
             self.cache = DefaultCache(**cache_options)
 
+    async def init(self):
+        """
+        Initializes internal aiohttp connection pool.
+
+        This isn't _required_, as the pool is initialized lazily when needed.
+        But in case you require non-lazy initialization, you may await this.
+
+        This is idempotent.
+        """
+        await self._ensure_aiohttp_ready()
+
+    async def deinit(self):
+        """
+        Deinitialize the async handler.
+
+        This is required in case you need to let go of the memory/state
+        associated with the async handler in a long-running process.
+
+        This is idempotent.
+        """
+        if self.httpsess:
+            await self.httpsess.close()
+            self.httpsess = None
+
     async def getDetails(self, ip_address=None):
         """Get details for specified IP address as a Details object."""
+        self._ensure_aiohttp_ready()
+
         # If the supplied IP address uses the objects defined in the built-in
         # module ipaddress, extract the appropriate string notation before
         # formatting the URL.
@@ -82,6 +112,8 @@ async def getDetails(self, ip_address=None):
 
     async def getBatchDetails(self, ip_addresses):
         """Get details for a batch of IP addresses at once."""
+        self._ensure_aiohttp_ready()
+
         result = {}
 
         # Pre-populate with anything we've got in the cache, and keep around
@@ -128,6 +160,11 @@ async def getBatchDetails(self, ip_addresses):
 
         return result
 
+    def _ensure_aiohttp_ready(self):
+        """Ensures aiohttp internal state is initialized."""
+        if not self.httpsess:
+            self.httpsess = aiohttp.ClientSession()
+
     def _get_headers(self):
         """Built headers for request to IPinfo API."""
         headers = {

tests/handler_async_test.py

@@ -13,13 +13,15 @@ async def test_init():
     assert handler.access_token == token
     assert isinstance(handler.cache, DefaultCache)
     assert "PK" in handler.countries
+    await handler.deinit()
 
 
 @pytest.mark.asyncio
 async def test_headers():
     token = "mytesttoken"
     handler = AsyncHandler(token)
     headers = handler._get_headers()
+    await handler.deinit()
 
     assert "user-agent" in headers
     assert "accept" in headers
@@ -77,3 +79,5 @@ async def test_get_details():
         assert domains["ip"] == "8.8.8.8"
         assert domains["total"] == 12988
         assert len(domains["domains"]) == 5
+
+    await handler.deinit()