Updating to use async for keycloak calls

Author: gregmccoy

CHANGELOG.md

@@ -1,3 +1,5 @@
+## Unreleased
+
 ## v2.9.0 (2023-01-11)
 
 ### Feat

poetry.lock

@@ -30,7 +30,7 @@ Documentation = "https://python-keycloak.readthedocs.io/en/latest/"
 
 [tool.poetry.dependencies]
 python = "^3.7"
-requests = "^2.20.0"
+httpx = "^0.23.0"
 python-jose = "^3.3.0"
 urllib3 = "^1.26.0"
 mock = {version = "^4.0.3", optional = true}
@@ -42,7 +42,6 @@ sphinx-rtd-theme = {version = "^1.0.0", optional = true}
 readthedocs-sphinx-ext = {version = "^2.1.9", optional = true}
 m2r2 = {version = "^0.3.2", optional = true}
 sphinx-autoapi = {version = "^2.0.0", optional = true}
-requests-toolbelt = "^0.9.1"
 
 [tool.poetry.extras]
 docs = [
@@ -61,6 +60,7 @@ docs = [
 tox = "^3.25.0"
 pytest = "^7.1.2"
 pytest-cov = "^3.0.0"
+pytest-asyncio = "0.20.3"
 wheel = "^0.37.1"
 pre-commit = "^2.19.0"
 isort = "^5.10.1"

pyproject.toml

@@ -28,8 +28,7 @@
 except ImportError:  # pragma: no cover
     from urlparse import urljoin
 
-import requests
-from requests.adapters import HTTPAdapter
+import httpx
 
 from .exceptions import KeycloakConnectionError
 
@@ -67,26 +66,19 @@ def __init__(self, base_url, headers={}, timeout=60, verify=True, proxies=None):
         self.headers = headers
         self.timeout = timeout
         self.verify = verify
-        self._s = requests.Session()
+        self._s = httpx.AsyncClient(verify=verify)
         self._s.auth = lambda x: x  # don't let requests add auth headers
 
         # retry once to reset connection with Keycloak after  tomcat's ConnectionTimeout
         # see https://github.com/marcospereirampj/python-keycloak/issues/36
-        for protocol in ("https://", "http://"):
-            adapter = HTTPAdapter(max_retries=1)
-            # adds POST to retry whitelist
-            allowed_methods = set(adapter.max_retries.allowed_methods)
-            allowed_methods.add("POST")
-            adapter.max_retries.allowed_methods = frozenset(allowed_methods)
-
-            self._s.mount(protocol, adapter)
+        self._s.transport = httpx.AsyncHTTPTransport(retries=1)
 
         if proxies:
             self._s.proxies.update(proxies)
 
-    def __del__(self):
+    async def close(self):
         """Del method."""
-        self._s.close()
+        await self._s.aclose()
 
     @property
     def base_url(self):
@@ -182,7 +174,7 @@ def del_param_headers(self, key):
         """
         self.headers.pop(key, None)
 
-    def raw_get(self, path, **kwargs):
+    async def raw_get(self, path, **kwargs):
         """Submit get request to the path.
 
         :param path: Path for request.
@@ -194,17 +186,17 @@ def raw_get(self, path, **kwargs):
         :raises KeycloakConnectionError: HttpError Can't connect to server.
         """
         try:
-            return self._s.get(
+            return await self._s.request(
+                "GET",
                 urljoin(self.base_url, path),
                 params=kwargs,
                 headers=self.headers,
                 timeout=self.timeout,
-                verify=self.verify,
             )
         except Exception as e:
             raise KeycloakConnectionError("Can't connect to server (%s)" % e)
 
-    def raw_post(self, path, data, **kwargs):
+    async def raw_post(self, path, data, **kwargs):
         """Submit post request to the path.
 
         :param path: Path for request.
@@ -218,18 +210,17 @@ def raw_post(self, path, data, **kwargs):
         :raises KeycloakConnectionError: HttpError Can't connect to server.
         """
         try:
-            return self._s.post(
+            return await self._s.post(
                 urljoin(self.base_url, path),
                 params=kwargs,
                 data=data,
                 headers=self.headers,
                 timeout=self.timeout,
-                verify=self.verify,
             )
         except Exception as e:
             raise KeycloakConnectionError("Can't connect to server (%s)" % e)
 
-    def raw_put(self, path, data, **kwargs):
+    async def raw_put(self, path, data, **kwargs):
         """Submit put request to the path.
 
         :param path: Path for request.
@@ -243,18 +234,17 @@ def raw_put(self, path, data, **kwargs):
         :raises KeycloakConnectionError: HttpError Can't connect to server.
         """
         try:
-            return self._s.put(
+            return await self._s.put(
                 urljoin(self.base_url, path),
                 params=kwargs,
                 data=data,
                 headers=self.headers,
                 timeout=self.timeout,
-                verify=self.verify,
             )
         except Exception as e:
             raise KeycloakConnectionError("Can't connect to server (%s)" % e)
 
-    def raw_delete(self, path, data=None, **kwargs):
+    async def raw_delete(self, path, data=None, **kwargs):
         """Submit delete request to the path.
 
         :param path: Path for request.
@@ -268,13 +258,13 @@ def raw_delete(self, path, data=None, **kwargs):
         :raises KeycloakConnectionError: HttpError Can't connect to server.
         """
         try:
-            return self._s.delete(
+            return await self._s.request(
+                "DELETE",
                 urljoin(self.base_url, path),
                 params=kwargs,
                 data=data or dict(),
                 headers=self.headers,
                 timeout=self.timeout,
-                verify=self.verify,
             )
         except Exception as e:
             raise KeycloakConnectionError("Can't connect to server (%s)" % e)

src/keycloak/connection.py

@@ -23,8 +23,6 @@
 
 """Keycloak custom exceptions module."""
 
-import requests
-
 
 class KeycloakError(Exception):
     """Base class for custom Keycloak errors.
@@ -167,7 +165,7 @@ def raise_error_from_response(response, error, expected_codes=None, skip_exists=
         expected_codes = [200, 201, 204]
 
     if response.status_code in expected_codes:
-        if response.status_code == requests.codes.no_content:
+        if response.status_code == 204:
             return {}
 
         try: