Async support (#139)

* add async version of request methods

* rename async methods

* remove requests dependency for httpx

* fix

* get correct length of json

* formatting

* get follow redirects

* sort imports

* formatting

* set black line-length to match flake8 conf

* fix github actions black config

* formatting

Author: equinor-ruaj

.github/workflows/linting.yml

@@ -18,23 +18,23 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - uses: psf/black@stable
         with:
-          options: "--check --verbose --line-length 80"
+          options: "--check --verbose --line-length 79"
           src: "./src/sumo/wrapper"
   flake8:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: ["3.8"]
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install flake8
-    - name: Analysing the code with flake8
-      run: |
-        flake8 src/sumo/wrapper --config .flake8
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8
+      - name: Analysing the code with flake8
+        run: |
+          flake8 src/sumo/wrapper --config .flake8

.gitignore

@@ -11,3 +11,4 @@ build
 /src/testing.py
 /docs/_build
 /docs/_static
+/src/sumo/wrapper/version.py

pyproject.toml

@@ -7,4 +7,4 @@ requires = [
 ]
 
 [tool.black]
-line-length = 80
+line-length = 79

requirements/requirements.txt

@@ -1,6 +1,6 @@
 msal>=1.18.0
 msal-extensions>=1.0.0
-requests>=2.24.0
 PyYAML>=5.4
 setuptools>=49.2.1
 pyjwt>=2.4.0
+httpx>=0.24.1

src/sumo/wrapper/_blob_client.py

@@ -1,4 +1,5 @@
-import requests
+import httpx
+
 from ._request_error import raise_request_error_exception
 
 
@@ -20,11 +21,38 @@ def upload_blob(self, blob: bytes, url: str):
         }
 
         try:
-            response = requests.put(url, data=blob, headers=headers)
-        except requests.exceptions.ProxyError as err:
+            response = httpx.put(url, data=blob, headers=headers)
+        except httpx.ProxyError as err:
+            raise_request_error_exception(503, err)
+
+        if response.is_error:
+            raise_request_error_exception(response.status_code, response.text)
+
+        return response
+
+    async def upload_blob_async(self, blob: bytes, url: str):
+        """Upload a blob async.
+
+        Parameters:
+            blob: byte string to upload
+            url: pre-authorized URL to blob store
+        """
+
+        headers = {
+            "Content-Type": "application/octet-stream",
+            "Content-Length": str(len(blob)),
+            "x-ms-blob-type": "BlockBlob",
+        }
+
+        try:
+            async with httpx.AsyncClient() as client:
+                response = await client.put(
+                    url=url, data=blob, headers=headers
+                )
+        except httpx.ProxyError as err:
             raise_request_error_exception(503, err)
 
-        if not response.ok:
+        if response.is_error:
             raise_request_error_exception(response.status_code, response.text)
 
         return response

src/sumo/wrapper/_call_azure_api.py

@@ -1,4 +1,4 @@
-import requests
+import httpx
 import logging
 
 from ._auth import Auth
@@ -154,9 +154,9 @@ def get_json(self, url, bearer=None):
 
         headers = {"Content-Type": "application/json", "Authorization": bearer}
 
-        response = requests.get(url, headers=headers)
+        response = httpx.get(url, headers=headers)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return response.json()
@@ -182,9 +182,9 @@ def get_image(self, url, bearer=None):
 
         headers = {"Content-Type": "html/text", "Authorization": bearer}
 
-        response = requests.get(url, headers=headers, stream=True)
+        response = httpx.get(url, headers=headers)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return None
@@ -210,9 +210,9 @@ def get_content(self, url, bearer=None):
 
         headers = {"Content-Type": "application/json", "Authorization": bearer}
 
-        response = requests.get(url, headers=headers)
+        response = httpx.get(url, headers=headers)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return response.content
@@ -249,11 +249,11 @@ def post(self, url, blob=None, json=None, bearer=None):
         }
 
         try:
-            response = requests.post(url, data=blob, json=json, headers=headers)
-        except requests.exceptions.ProxyError as err:
+            response = httpx.post(url, data=blob, json=json, headers=headers)
+        except httpx.ProxyError as err:
             _raise_request_error_exception(503, err)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return response
@@ -293,11 +293,11 @@ def put(self, url, blob=None, json=None, bearer=None):
             headers["Authorization"] = bearer
 
         try:
-            response = requests.put(url, data=blob, json=json, headers=headers)
-        except requests.exceptions.ProxyError as err:
+            response = httpx.put(url, data=blob, json=json, headers=headers)
+        except httpx.ProxyError as err:
             _raise_request_error_exception(503, err)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return response
@@ -321,9 +321,9 @@ def delete_object(self, url, bearer=None):
             "Authorization": bearer,
         }
 
-        response = requests.delete(url, headers=headers)
+        response = httpx.delete(url, headers=headers)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return response.json()

src/sumo/wrapper/_call_sumo_api.py

@@ -30,7 +30,9 @@ def __init__(
             self.base_url = f"https://main-sumo-{env}.radix.equinor.com/api/v1"
 
         resource_id = (
-            resource_id if resource_id else APP_REGISTRATION[env]["RESOURCE_ID"]
+            resource_id
+            if resource_id
+            else APP_REGISTRATION[env]["RESOURCE_ID"]
         )
         client_id = (
             client_id if client_id else APP_REGISTRATION[env]["CLIENT_ID"]
@@ -224,7 +226,9 @@ def save_child_level_json(self, parent_id, json, bearer=None):
         Return
             string: The object id of the newly created object, or error message.
         """
-        return self._post_objects(object_id=parent_id, json=json, bearer=bearer)
+        return self._post_objects(
+            object_id=parent_id, json=json, bearer=bearer
+        )
 
     def update_child_level_json(
         self, json, object_id=None, url=None, bearer=None