deceit 1.0__tar.gz → 1.2__tar.gz

{deceit-1.0/deceit.egg-info → deceit-1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deceit
-Version: 1.0
+Version: 1.2
 Summary: deceit
 Home-page: https://github.com/cscshared/deceit
 Author: dev
@@ -26,6 +26,8 @@ License-File: LICENSE
 Requires-Dist: requests
 Requires-Dist: requests_oauthlib
 Requires-Dist: pytz
+Requires-Dist: httpx
+Requires-Dist: urllib3
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
@@ -39,6 +41,9 @@ Requires-Dist: pytest-docker; extra == "dev"
 Requires-Dist: waddle; extra == "dev"
 Requires-Dist: convocations; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest-durations; extra == "dev"
+Requires-Dist: pytest-httpx; extra == "dev"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -58,8 +63,8 @@ Dynamic: summary
 
 boilerplate requests code for creating simple api clients.  includes
 a standard requests retry adapter for retrying errors 429, 502, 503, and 504,
-and a base api exceptions class that can be used for api-specific error 
-handling.  includes hooks that can be used to add request and response 
+and a base api exceptions class that can be used for api-specific error
+handling.  includes hooks that can be used to add request and response
 logging to a database if needed for debugging / traceability.
 
 named after a group of lapwings.  pax avium.
@@ -85,29 +90,29 @@ class AirflowApiClient(ApiClient):
 
     def connections(self):
         return self.get('connections')
-        
+
 ```
 
 ## anchoring off of base url
 
-if you provide a `base_url` to the constructor of `ApiClient`, all 
+if you provide a `base_url` to the constructor of `ApiClient`, all
 calls to the `ApiClient.send` function will be anchored to the `base_url`.
 In the `AirflowApiClient` example above, the `get` to the `connections`
 endpoint will use `posixpath.join` to construct the full url, e.g.,
-`http://localhost:8080/api/v1/connections`.  It is important to note 
-that deceit uses `posixpath.join` not `urllib.parse.urljoin`.  
+`http://localhost:8080/api/v1/connections`.  It is important to note
+that deceit uses `posixpath.join` not `urllib.parse.urljoin`.
 So make sure not to prefix anchored routes with `/`.
 
 ## presend and postsend
 
-The `deceit`-ful `ApiClient` includes hooks for doing `presend` and 
-`postsend` actions.  If you subclass `ApiClient` and override `presend`, 
-you can perform actions such as logging the `requests.PreparedRequest` 
+The `deceit`-ful `ApiClient` includes hooks for doing `presend` and
+`postsend` actions.  If you subclass `ApiClient` and override `presend`,
+you can perform actions such as logging the `requests.PreparedRequest`
 or adding an hmac signature.  If you subclass `ApiClient` and override
-`postsend` you can add additional post-request, pre-exception handling, 
-such as logging the request / response cycle.  `presend` takes 
+`postsend` you can add additional post-request, pre-exception handling,
+such as logging the request / response cycle.  `presend` takes
 one parameter, the `requests.PreparedRequest`, while `postsend` takes
-two parameters, the `requests.PreparedRequest` and the 
+two parameters, the `requests.PreparedRequest` and the
 `requests.models.Response`.
 
 ## timeout
@@ -119,9 +124,12 @@ the `default_timeout` parameter to the `ApiClient` constructor.
 
 ### prerequisites
 
-* python3.9 or python3.10
-* docker-compose
+* python3.10+
+* docker-compose -- in the unit tests, we use docker compose to bring up
+  airflow to have an api that we can hit.
 * internet connection
+* having `uv` installed will make things faster, since the standard
+  venv setup uses `uv`.  you can use `make uv` to install uv.
 
 ### getting started
 
@@ -129,6 +137,7 @@ standard avian setup using `make`
 
 ```bash
 cd /path/to/deceit
+make uv
 make setup
 make test
 ```

{deceit-1.0 → deceit-1.2}/README.md

@@ -4,8 +4,8 @@
 
 boilerplate requests code for creating simple api clients.  includes
 a standard requests retry adapter for retrying errors 429, 502, 503, and 504,
-and a base api exceptions class that can be used for api-specific error 
-handling.  includes hooks that can be used to add request and response 
+and a base api exceptions class that can be used for api-specific error
+handling.  includes hooks that can be used to add request and response
 logging to a database if needed for debugging / traceability.
 
 named after a group of lapwings.  pax avium.
@@ -31,29 +31,29 @@ class AirflowApiClient(ApiClient):
 
     def connections(self):
         return self.get('connections')
-        
+
 ```
 
 ## anchoring off of base url
 
-if you provide a `base_url` to the constructor of `ApiClient`, all 
+if you provide a `base_url` to the constructor of `ApiClient`, all
 calls to the `ApiClient.send` function will be anchored to the `base_url`.
 In the `AirflowApiClient` example above, the `get` to the `connections`
 endpoint will use `posixpath.join` to construct the full url, e.g.,
-`http://localhost:8080/api/v1/connections`.  It is important to note 
-that deceit uses `posixpath.join` not `urllib.parse.urljoin`.  
+`http://localhost:8080/api/v1/connections`.  It is important to note
+that deceit uses `posixpath.join` not `urllib.parse.urljoin`.
 So make sure not to prefix anchored routes with `/`.
 
 ## presend and postsend
 
-The `deceit`-ful `ApiClient` includes hooks for doing `presend` and 
-`postsend` actions.  If you subclass `ApiClient` and override `presend`, 
-you can perform actions such as logging the `requests.PreparedRequest` 
+The `deceit`-ful `ApiClient` includes hooks for doing `presend` and
+`postsend` actions.  If you subclass `ApiClient` and override `presend`,
+you can perform actions such as logging the `requests.PreparedRequest`
 or adding an hmac signature.  If you subclass `ApiClient` and override
-`postsend` you can add additional post-request, pre-exception handling, 
-such as logging the request / response cycle.  `presend` takes 
+`postsend` you can add additional post-request, pre-exception handling,
+such as logging the request / response cycle.  `presend` takes
 one parameter, the `requests.PreparedRequest`, while `postsend` takes
-two parameters, the `requests.PreparedRequest` and the 
+two parameters, the `requests.PreparedRequest` and the
 `requests.models.Response`.
 
 ## timeout
@@ -65,9 +65,12 @@ the `default_timeout` parameter to the `ApiClient` constructor.
 
 ### prerequisites
 
-* python3.9 or python3.10
-* docker-compose
+* python3.10+
+* docker-compose -- in the unit tests, we use docker compose to bring up
+  airflow to have an api that we can hit.
 * internet connection
+* having `uv` installed will make things faster, since the standard
+  venv setup uses `uv`.  you can use `make uv` to install uv.
 
 ### getting started
 
@@ -75,6 +78,7 @@ standard avian setup using `make`
 
 ```bash
 cd /path/to/deceit
+make uv
 make setup
 make test
 ```

deceit-1.2/deceit/async_api_client.py

@@ -0,0 +1,160 @@
+import base64
+import json
+import logging
+import posixpath
+from typing import Optional, Dict, Any
+import httpx
+from .encoders import JsonEncoder
+from .exceptions import ApiException
+
+
+class ApiClient:
+    def __init__(self, *args, base_url=None, default_timeout=None,
+                 exception_class=None, user=None, password=None, **kwargs):
+        self.base_url = base_url
+        self.default_timeout = default_timeout
+        self.log = logging.getLogger(__name__)
+        self.exception_class = exception_class or ApiException
+        self.m_session: Optional[httpx.AsyncClient] = None
+        self.user = user
+        self.password = password
+
+    @property
+    def session(self) -> httpx.AsyncClient:
+        if self.m_session is None or self.m_session.is_closed:
+            self.m_session = httpx.AsyncClient()
+        return self.m_session
+
+    async def close(self):
+        if self.m_session and not self.m_session.is_closed:
+            await self.m_session.aclose()
+
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, *exc_info):
+        await self.close()
+
+    async def presend(self, request: httpx.Request):  # pragma: no cover
+        """override to log requests"""
+        pass
+
+    async def postsend(self, request: httpx.Request, response: httpx.Response):  # pragma: no cover
+        """override to log responses"""
+        pass
+
+    def headers(self, *args, **kwargs):
+        headers = {}
+        if self.user and self.password:
+            credentials = base64.b64encode(
+                f'{self.user}:{self.password}'.encode()
+            ).decode()
+            headers['Authorization'] = f'Basic {credentials}'
+        return headers
+
+    def get_url(self, route: str) -> str:
+        if route.startswith('https:') or route.startswith('http:'):
+            return route
+        base_url = self.base_url
+        return posixpath.join(base_url, route) if base_url else route
+
+    async def send(
+            self,
+            method: str,
+            route: str,
+            params: Optional[Dict[str, str]] = None,
+            form_data: Optional[Dict[str, str]] = None,
+            json_data: Optional[Dict[Any, Any]] = None,
+            raw: bool = False,
+            **kwargs) -> Any:
+        """base send function that initiates an async http request
+        :param method: the type of request such as `get`, `post`, etc.
+        :param route: the anchored route to use, remember that routes are
+            prefixed to the `base_url`.
+        :param params: a dictionary of query parameters to be included in the url
+        :param form_data: a dictionary of values that will be sent in the request
+            body as form encoded values
+        :param json_data: a dictionary of values that will be sent in the
+            request json-encoded
+        :param raw: a flag that, if specified, will not cause the raising
+            of an `ApiException`.  Use this flag when you need additional
+            values out of the response or want to handle errors differently
+            than the default.
+        """
+        headers = self.headers()
+        headers.update(kwargs.pop('headers', None) or {})
+        timeout_val = kwargs.pop('timeout', None) or self.default_timeout
+        url = self.get_url(route)
+        build_kwargs = {}
+        if timeout_val is not None:
+            build_kwargs['timeout'] = httpx.Timeout(timeout_val)
+
+        if json_data is not None:
+            build_kwargs['content'] = json.dumps(json_data, cls=JsonEncoder)
+            headers.setdefault('content-type', 'application/json')
+        elif form_data is not None:
+            build_kwargs['data'] = form_data
+
+
+        request = self.session.build_request(
+            method, url, headers=headers, params=params,
+            **build_kwargs, **kwargs)
+        await self.presend(request)
+        response = await self.session.send(request)
+        await self.postsend(request, response)
+
+        if raw:
+            return response
+        result = await self.handle_response(response)
+        if result:
+            return result
+        return response
+
+    async def handle_response(self, response: httpx.Response) -> Optional[Dict[Any, Any]]:
+        """handles responses by returning the json dict or raising an
+        `ApiException` for non 200-series responses
+
+        :param response: the response received from the api
+        :return: the json dict if we received a successful response or None
+        """
+        if response.status_code // 100 != 2:
+            content = response.content
+            text = response.text
+            try:
+                data = json.loads(text)
+            except (json.JSONDecodeError, ValueError):
+                data = None
+            raise self.exception_class(
+                response.status_code,
+                content,
+                text,
+                data,
+                dict(response.headers),
+            )
+        try:
+            return response.json()
+        except (json.JSONDecodeError, ValueError):
+            return None
+
+    async def get(self, route, params=None, **kwargs):
+        return await self.send('get', route, params=params, **kwargs)
+
+    async def post(self, route, form_data=None, json_data=None, **kwargs):
+        return await self.send(
+            'post', route, form_data=form_data, json_data=json_data, **kwargs)
+
+    async def put(self, route, form_data=None, json_data=None, **kwargs):
+        return await self.send(
+            'put', route, form_data=form_data, json_data=json_data, **kwargs)
+
+    async def delete(self, route, params=None, form_data=None,
+                     json_data=None, **kwargs):
+        return await self.send(
+            'delete', route, params=params, form_data=form_data,
+            json_data=json_data, **kwargs)
+
+    async def patch(self, route, params=None, form_data=None,
+                    json_data=None, **kwargs):
+        return await self.send(
+            'patch', route, params=params, form_data=form_data,
+            json_data=json_data, **kwargs)

{deceit-1.0 → deceit-1.2}/deceit/encoders.py

@@ -18,4 +18,4 @@ def make_json_serializable(value, fn=lambda x: x):
 
 class JsonEncoder(json.JSONEncoder):
     def default(self, o):  # pylint: disable=method-hidden
-        return make_json_serializable(o, super(JsonEncoder, self).default)
+        return make_json_serializable(o, super().default)

{deceit-1.0 → deceit-1.2}/deceit/exceptions.py

@@ -29,7 +29,7 @@ class ApiException(Exception):
         if self.headers:
             st = json.dumps(self.headers, indent=2)
             st_headers = f'[{klass}] [{self.status_code}] / headers => {st}'
-        p.text(f'[{klass}] [{self.status_code}] => {body}' + st_headers)
+        p.text(f'[{klass}] [{self.status_code}] => {body}\n{st_headers}')
         p.text()
 
     @classmethod

{deceit-1.0 → deceit-1.2/deceit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deceit
-Version: 1.0
+Version: 1.2
 Summary: deceit
 Home-page: https://github.com/cscshared/deceit
 Author: dev
@@ -26,6 +26,8 @@ License-File: LICENSE
 Requires-Dist: requests
 Requires-Dist: requests_oauthlib
 Requires-Dist: pytz
+Requires-Dist: httpx
+Requires-Dist: urllib3
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
@@ -39,6 +41,9 @@ Requires-Dist: pytest-docker; extra == "dev"
 Requires-Dist: waddle; extra == "dev"
 Requires-Dist: convocations; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest-durations; extra == "dev"
+Requires-Dist: pytest-httpx; extra == "dev"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -58,8 +63,8 @@ Dynamic: summary
 
 boilerplate requests code for creating simple api clients.  includes
 a standard requests retry adapter for retrying errors 429, 502, 503, and 504,
-and a base api exceptions class that can be used for api-specific error 
-handling.  includes hooks that can be used to add request and response 
+and a base api exceptions class that can be used for api-specific error
+handling.  includes hooks that can be used to add request and response
 logging to a database if needed for debugging / traceability.
 
 named after a group of lapwings.  pax avium.
@@ -85,29 +90,29 @@ class AirflowApiClient(ApiClient):
 
     def connections(self):
         return self.get('connections')
-        
+
 ```
 
 ## anchoring off of base url
 
-if you provide a `base_url` to the constructor of `ApiClient`, all 
+if you provide a `base_url` to the constructor of `ApiClient`, all
 calls to the `ApiClient.send` function will be anchored to the `base_url`.
 In the `AirflowApiClient` example above, the `get` to the `connections`
 endpoint will use `posixpath.join` to construct the full url, e.g.,
-`http://localhost:8080/api/v1/connections`.  It is important to note 
-that deceit uses `posixpath.join` not `urllib.parse.urljoin`.  
+`http://localhost:8080/api/v1/connections`.  It is important to note
+that deceit uses `posixpath.join` not `urllib.parse.urljoin`.
 So make sure not to prefix anchored routes with `/`.
 
 ## presend and postsend
 
-The `deceit`-ful `ApiClient` includes hooks for doing `presend` and 
-`postsend` actions.  If you subclass `ApiClient` and override `presend`, 
-you can perform actions such as logging the `requests.PreparedRequest` 
+The `deceit`-ful `ApiClient` includes hooks for doing `presend` and
+`postsend` actions.  If you subclass `ApiClient` and override `presend`,
+you can perform actions such as logging the `requests.PreparedRequest`
 or adding an hmac signature.  If you subclass `ApiClient` and override
-`postsend` you can add additional post-request, pre-exception handling, 
-such as logging the request / response cycle.  `presend` takes 
+`postsend` you can add additional post-request, pre-exception handling,
+such as logging the request / response cycle.  `presend` takes
 one parameter, the `requests.PreparedRequest`, while `postsend` takes
-two parameters, the `requests.PreparedRequest` and the 
+two parameters, the `requests.PreparedRequest` and the
 `requests.models.Response`.
 
 ## timeout
@@ -119,9 +124,12 @@ the `default_timeout` parameter to the `ApiClient` constructor.
 
 ### prerequisites
 
-* python3.9 or python3.10
-* docker-compose
+* python3.10+
+* docker-compose -- in the unit tests, we use docker compose to bring up
+  airflow to have an api that we can hit.
 * internet connection
+* having `uv` installed will make things faster, since the standard
+  venv setup uses `uv`.  you can use `make uv` to install uv.
 
 ### getting started
 
@@ -129,6 +137,7 @@ standard avian setup using `make`
 
 ```bash
 cd /path/to/deceit
+make uv
 make setup
 make test
 ```

{deceit-1.0 → deceit-1.2}/deceit.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ setup.py
 deceit/__init__.py
 deceit/adapters.py
 deceit/api_client.py
+deceit/async_api_client.py
 deceit/encoders.py
 deceit/exceptions.py
 deceit.egg-info/PKG-INFO

{deceit-1.0 → deceit-1.2}/deceit.egg-info/requires.txt

@@ -1,6 +1,8 @@
 requests
 requests_oauthlib
 pytz
+httpx
+urllib3
 
 [dev]
 pytest
@@ -15,3 +17,6 @@ pytest-docker
 waddle
 convocations
 pytest-cov
+pytest-asyncio
+pytest-durations
+pytest-httpx

{deceit-1.0 → deceit-1.2}/dev.txt

@@ -10,3 +10,6 @@ pytest-docker
 waddle
 convocations
 pytest-cov
+pytest-asyncio
+pytest-durations
+pytest-httpx

{deceit-1.0 → deceit-1.2}/setup.py

@@ -6,7 +6,7 @@ from setuptools import setup
 # Version info -- read without importing
 _locals = {}
 
-version = '1.0'
+version = '1.2'
 
 # PyYAML ships a split Python 2/3 codebase. Unfortunately, some pip versions
 # attempt to interpret both halves of PyYAML, yielding SyntaxErrors. Thus, we
@@ -68,6 +68,8 @@ setup(
         'requests',
         'requests_oauthlib',
         'pytz',
+        'httpx',
+        'urllib3',
     ],
     extras_require=extras,
 )