♻️ Extract AuthRegistry; move bulk of request and response processing to OperationModel.

Author: Raphael Krupinski

src/lapidary/runtime/client_base.py

@@ -1,18 +1,14 @@
 import abc
 import logging
-from collections.abc import Awaitable, Callable, Iterable, Mapping, MutableMapping
+from collections.abc import Iterable
 from importlib.metadata import version
-from typing import Any, Optional, cast
+from typing import Optional
 
 import httpx
 from typing_extensions import Self
 
-from ._httpx import AuthType
-from .model.op import OperationModel
-from .model.request import RequestFactory
-from .operation import get_operation_model
-from .request import build_request
-from .types_ import MultiAuth, NamedAuth, SecurityRequirements
+from .model.auth import AuthRegistry
+from .types_ import NamedAuth, SecurityRequirements
 
 logger = logging.getLogger(__name__)
 
@@ -36,112 +32,25 @@ def __init__(
             headers['User-Agent'] = user_agent
 
         self._client = _http_client or httpx.AsyncClient(base_url=base_url, headers=headers, **httpx_kwargs)
-        self._security = security
-        self._lapidary_operations: MutableMapping[str, OperationModel] = {}
-        self._auth: MutableMapping[str, httpx.Auth] = {}
-        self._auth_cache: MutableMapping[str, httpx.Auth] = {}
+        self._auth_registry = AuthRegistry(security)
 
     async def __aenter__(self: Self) -> Self:
         await self._client.__aenter__()
         return self
 
     async def __aexit__(self, __exc_type=None, __exc_value=None, __traceback=None) -> None:
-        await self._client.__aexit__(__exc_type, __exc_value, __traceback)
-
-    async def _request(
-        self,
-        method: str,
-        path: str,
-        fn: Callable[..., Awaitable],
-        security: Optional[Iterable[SecurityRequirements]],
-        actual_params: Mapping[str, Any],
-    ):
-        if fn.__name__ not in self._lapidary_operations:
-            operation = get_operation_model(method, path, fn)
-            self._lapidary_operations[fn.__name__] = operation
-        else:
-            operation = self._lapidary_operations[fn.__name__]
-
-        auth = self._resolve_auth(fn, security)
-
-        request = build_request(
-            operation,
-            actual_params,
-            cast(RequestFactory, self._client.build_request),
-        )
-
-        logger.debug('%s %s %s', request.method, request.url, request.headers)
-
-        response = await self._client.send(request, auth=auth)
-        await response.aread()
-
-        return operation.handle_response(response)
-
-    def _resolve_auth(self, fn: Callable, security: Optional[Iterable[SecurityRequirements]]) -> AuthType:
-        if security:
-            sec_name = fn.__name__
-            sec_source = security
-        elif self._security:
-            sec_name = '*'
-            sec_source = self._security
-        else:
-            sec_name = None
-            sec_source = None
-
-        if sec_source:
-            assert sec_name
-            if sec_name not in self._auth_cache:
-                auth = self._mk_auth(sec_source)
-                self._auth_cache[sec_name] = auth
-            else:
-                auth = self._auth_cache[sec_name]
-            return auth
-        else:
-            return None
+        return await self._client.__aexit__(__exc_type, __exc_value, __traceback)
 
     def lapidary_authenticate(self, *auth_args: NamedAuth, **auth_kwargs: httpx.Auth) -> None:
         """Register named Auth instances for future use with methods that require authentication."""
         if auth_args:
             # make python complain about duplicate names
             self.lapidary_authenticate(**dict(auth_args), **auth_kwargs)
 
-        self._auth.update(auth_kwargs)
-        self._auth_cache.clear()
+        self._auth_registry.authenticate(auth_kwargs)
 
     def lapidary_deauthenticate(self, *sec_names: str) -> None:
         """Remove reference to a given Auth instance.
         Calling with no parameters removes all references"""
 
-        if sec_names:
-            for sec_name in sec_names:
-                del self._auth[sec_name]
-        else:
-            self._auth.clear()
-        self._auth_cache.clear()
-
-    def _mk_auth(self, security: Iterable[SecurityRequirements]) -> httpx.Auth:
-        security = list(security)
-        assert security
-        last_error: Optional[Exception] = None
-        for requirements in security:
-            try:
-                auth = _build_auth(self._auth, requirements)
-                break
-            except ValueError as ve:
-                last_error = ve
-                continue
-        else:
-            assert last_error
-            # due to asserts and break above, we never enter here, unless ValueError was raised
-            raise last_error  # noqa
-        return auth
-
-
-def _build_auth(schemes: Mapping[str, httpx.Auth], requirements: SecurityRequirements) -> httpx.Auth:
-    auth_flows = []
-    for scheme, scopes in requirements.items():
-        auth_flow = schemes.get(scheme)
-        if not auth_flow:
-            raise ValueError('Not authenticated', scheme)
-        auth_flows.append(auth_flow)
-    return MultiAuth(*auth_flows)
+        self._auth_registry.deauthenticate(sec_names)

src/lapidary/runtime/model/annotations.py

@@ -105,11 +105,6 @@ def apply_request(self, builder: 'RequestBuilder', value: typing.Any) -> None:
     def http_name(self) -> str:
         return self.alias or self._name
 
-    def __eq__(self, other):
-        if not isinstance(other, type(self)):
-            raise NotImplementedError
-        return self.__dict__ == other.__dict__
-
 
 T = typing.TypeVar('T')
 

src/lapidary/runtime/model/auth.py

@@ -0,0 +1,80 @@
+from collections.abc import Iterable, Mapping, MutableMapping
+from typing import Optional
+
+import httpx
+
+from .._httpx import AuthType
+from ..types_ import MultiAuth, SecurityRequirements
+
+
+class AuthRegistry:
+    def __init__(self, security: Optional[Iterable[SecurityRequirements]]):
+        # Every Auth instance the user code authenticated with
+        self._auth: MutableMapping[str, httpx.Auth] = {}
+
+        # (Multi)Auth instance for every operation and the client
+        self._auth_cache: MutableMapping[str, httpx.Auth] = {}
+
+        # Client-wide security requirements
+        self._security = security
+
+    def resolve_auth(self, name: str, security: Optional[Iterable[SecurityRequirements]]) -> AuthType:
+        if security:
+            sec_name = name
+            sec_source = security
+        elif self._security:
+            sec_name = '*'
+            sec_source = self._security
+        else:
+            sec_name = None
+            sec_source = None
+
+        if sec_source:
+            assert sec_name
+            if sec_name not in self._auth_cache:
+                auth = self._mk_auth(sec_source)
+                self._auth_cache[sec_name] = auth
+            else:
+                auth = self._auth_cache[sec_name]
+            return auth
+        else:
+            return None
+
+    def _mk_auth(self, security: Iterable[SecurityRequirements]) -> httpx.Auth:
+        security = list(security)
+        assert security
+        last_error: Optional[Exception] = None
+        for requirements in security:
+            try:
+                auth = _build_auth(self._auth, requirements)
+                break
+            except ValueError as ve:
+                last_error = ve
+                continue
+        else:
+            assert last_error
+            # due to asserts and break above, we never enter here, unless ValueError was raised
+            raise last_error  # noqa
+        return auth
+
+    def authenticate(self, auth_models: Mapping[str, httpx.Auth]) -> None:
+        self._auth.update(auth_models)
+        self._auth_cache.clear()
+
+    def deauthenticate(self, sec_names: Iterable[str]) -> None:
+        if sec_names:
+            for sec_name in sec_names:
+                del self._auth[sec_name]
+        else:
+            self._auth.clear()
+        self._auth_cache.clear()
+
+
+def _build_auth(schemes: Mapping[str, httpx.Auth], requirements: SecurityRequirements) -> httpx.Auth:
+    auth_flows = []
+    for scheme, scopes in requirements.items():
+        auth_flow = schemes.get(scheme)
+        if not auth_flow:
+            raise ValueError('Not authenticated', scheme)
+        auth_flows.append(auth_flow)
+    return MultiAuth(*auth_flows)