shopware-api-client 1.0.100__py3-none-any.whl → 1.0.102__py3-none-any.whl

shopware_api_client/base.py

@@ -1,6 +1,7 @@
 import asyncio
 import json
 from datetime import UTC, datetime
+from functools import cached_property
 from typing import (
     Any,
     AsyncGenerator,
@@ -9,6 +10,7 @@ from typing import (
     Self,
     Type,
     TypeVar,
+    cast,
     get_origin,
     overload,
 )
@@ -42,6 +44,8 @@ from .exceptions import (
 )
 from .logging import logger
 
+APPLICATION_JSON = "application/json"
+
 EndpointClass = TypeVar("EndpointClass", bound="EndpointBase[Any]")
 ModelClass = TypeVar("ModelClass", bound="ApiModelBase[Any]")
 
@@ -61,11 +65,12 @@ class ClientBase:
         self.raw = raw
 
     async def __aenter__(self) -> "Self":
-        self._get_client()
+        client = self.http_client
+        assert isinstance(client, httpx.AsyncClient), "http_client must be an instance of httpx.AsyncClient"
         return self
 
     async def __aexit__(self, *args: Any) -> None:
-        await self._get_client().aclose()
+        await self.http_client.aclose()
 
     async def log_request(self, request: httpx.Request) -> None:
         if not hasattr(request, "_content"):
@@ -82,11 +87,15 @@ class ClientBase:
             response.headers,
         )
 
-    def _get_client(self) -> httpx.AsyncClient:
+    @cached_property
+    def http_client(self) -> httpx.AsyncClient:
+        return self._get_http_client()
+
+    def _get_http_client(self) -> httpx.AsyncClient:
         raise NotImplementedError()
 
     def _get_headers(self) -> dict[str, str]:
-        headers = {"Content-Type": "application/json", "Accept": "application/json"}
+        headers = {"Content-Type": APPLICATION_JSON, "Accept": APPLICATION_JSON}
 
         if self.language_id is not None:
             headers["sw-language-id"] = str(self.language_id)
@@ -95,24 +104,30 @@ class ClientBase:
 
     @property
     def timeout(self) -> httpx.Timeout:
-        client = self._get_client()
+        client = self.http_client
         return client.timeout
 
     @timeout.setter
     def timeout(self, timeout: httpx._types.TimeoutTypes) -> None:
-        client = self._get_client()
+        client = self.http_client
         client.timeout = timeout  # type: ignore
 
+    async def retry_sleep(self, retry_wait_base: int, retry_count: int) -> None:
+        retry_sleep = retry_wait_base**retry_count
+        logger.debug(f"Try failed, retrying in {retry_sleep} seconds.")
+        await asyncio.sleep(retry_sleep)
+
     async def _make_request(self, method: str, relative_url: str, **kwargs: Any) -> httpx.Response:
         if relative_url.startswith("http://") or relative_url.startswith("https://"):
             url = relative_url
         else:
             url = f"{self.api_url}{relative_url}"
-        client = self._get_client()
+        client = self.http_client
 
         headers = self._get_headers()
         headers.update(kwargs.pop("headers", {}))
 
+        retry_wait_base = int(kwargs.pop("retriy_wait_base", 2))
         retries = int(kwargs.pop("retries", 0))
         retry_errors = tuple(
             kwargs.pop("retry_errors", [SWAPIInternalServerError, SWAPIServiceUnavailable, SWAPIGatewayTimeout])
@@ -126,7 +141,7 @@ class ClientBase:
             try:
                 response = await client.request(method, url, headers=headers, **kwargs)
             except httpx.RequestError as exc:
-                if retry_count == retries:
+                if retry_count >= retries:
                     raise SWAPIException(f"HTTP client exception ({exc.__class__.__name__}). Details: {str(exc)}")
                 await asyncio.sleep(2**retry_count)
                 retry_count += 1
@@ -137,10 +152,10 @@ class ClientBase:
                     errors: list = response.json().get("errors")
                     # ensure `errors` attribute is a list/tuple, fallback to from_response if not
                     if not isinstance(errors, (list, tuple)):
-                       raise ValueError("`errors` attribute in json not a list/tuple!")
-                    
+                        raise ValueError("`errors` attribute in json not a list/tuple!")
+
                     error: SWAPIError | SWAPIErrorList = SWAPIError.from_errors(errors)
-                except (json.JSONDecodeError, ValueError):
+                except ValueError:
                     error: SWAPIError | SWAPIErrorList = SWAPIError.from_response(response)  # type: ignore
 
                 if isinstance(error, SWAPIErrorList) and len(error.errors) == 1:
@@ -159,9 +174,27 @@ class ClientBase:
                 if retry_count == retries:
                     raise error
 
-                logger.debug(f"Try failed, retrying in {2 ** retry_count} seconds.")
-                await asyncio.sleep(2**retry_count)
+                await self.retry_sleep(retry_wait_base, retry_count)
                 retry_count += 1
+            elif response.status_code == 200 and response.headers.get("Content-Type", "").startswith(APPLICATION_JSON):
+                # guard against "200 okay" responses with malformed json
+                try:
+                    setattr(response, "json_cached", response.json())
+                    return response
+                except json.JSONDecodeError:
+                    # retries exhausted?
+                    if retry_count >= retries:
+                        response.status_code = 500
+                        exception = SWAPIError.from_response(response)
+                        # prefix details with x-trace-header to
+                        exception.detail = (
+                            f"x-trace-id: {str(response.headers.get('x-trace-id', 'not-set'))}" + exception.detail
+                        )
+                        raise exception
+
+                    # schedule retry
+                    await self.retry_sleep(retry_wait_base, retry_count)
+                    retry_count += 1
             else:
                 return response
 
@@ -187,7 +220,7 @@ class ClientBase:
         )
 
     async def close(self) -> None:
-        await self._get_client().aclose()
+        await self.http_client.aclose()
 
     async def bulk_upsert(
         self,
@@ -289,7 +322,8 @@ class ApiModelBase(BaseModel, Generic[EndpointClass]):
 
     def _get_endpoint(self) -> EndpointClass:
         # we want a fresh endpoint
-        endpoint: EndpointClass = getattr(self._get_client(), self._identifier).__class__(self._get_client())  # type: ignore
+        client = self._get_client()
+        endpoint: EndpointClass = getattr(client, self._identifier).__class__(client)  # type: ignore
         return endpoint
 
     async def save(self, force_insert: bool = False, update_fields: IncEx | None = None) -> Self | dict | None:
@@ -372,7 +406,7 @@ class EndpointBase(Generic[ModelClass]):
         field = self.model_class.model_fields[name]
 
         if get_origin(field.annotation) in [ForeignRelation, ManyRelation]:
-            return to_camel(name)
+            return cast(str, to_camel(name))
         else:
             return self.model_class.model_fields[name].serialization_alias or name
 

shopware_api_client/client.py

@@ -19,7 +19,7 @@ class AdminClient(ClientBase, AdminEndpoints):
         self._client: httpx.AsyncClient | None = None
         self.init_endpoints(self)
 
-    def _get_client(self) -> httpx.AsyncClient:
+    def _get_http_client(self) -> httpx.AsyncClient:
         if self._client is None:
             self._client = httpx.AsyncClient(
                 event_hooks={"request": [self.log_request], "response": [self.log_response]}
@@ -164,7 +164,10 @@ class AdminClient(ClientBase, AdminEndpoints):
 
             result = await self._retry_bulk_parts(action="delete", name=name, objs=objs, exception=e, **request_kwargs)
         else:
-            result = response.json()
+            if hasattr(response, "json_cached"):
+                result = response.json_cached
+            else:
+                result = response.json()
 
         return result
 
@@ -177,7 +180,7 @@ class StoreClient(ClientBase, StoreEndpoints):
         self._client: httpx.AsyncClient | None = None
         self.init_endpoints(self)
 
-    def _get_client(self) -> httpx.AsyncClient:
+    def _get_http_client(self) -> httpx.AsyncClient:
         if self._client is None:
             self._client = httpx.AsyncClient(
                 event_hooks={"request": [self.log_request], "response": [self.log_response]},

{shopware_api_client-1.0.100.dist-info → shopware_api_client-1.0.102.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: shopware-api-client
-Version: 1.0.100
+Version: 1.0.102
 Summary:  An api client for the Shopware API
 License: MIT
 Keywords: shopware,api,client
@@ -315,6 +315,12 @@ We have two classes `Base` and `Relations`. This way we can [reuse the Base-Mode
 
 ## Development
 
+### Testing
+
+You can use `poetry build` and `poetry run pip install -e .` to install the current src.
+
+Then run `poetry run pytest .` to execute the tests.
+
 ### Model Creation
 
 Shopware provides API-definitions for their whole API. You can download it from `<shopurl>/api/_info/openapi3.json`

{shopware_api_client-1.0.100.dist-info → shopware_api_client-1.0.102.dist-info}/RECORD

@@ -1,6 +1,6 @@
 shopware_api_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-shopware_api_client/base.py,sha256=dq9o45_1jtrBlkNNnQssNv7H3_WOWsdqLRphuu32Riw,23528
-shopware_api_client/client.py,sha256=Ii8oRpCkCVzR6unRIanMxxOHHbqlFedaYEEyrlZwlkI,7456
+shopware_api_client/base.py,sha256=8iBg3_OvcsEETVGmW-QsSy2HU-6JLnnogA6NaupuE6k,25067
+shopware_api_client/client.py,sha256=vkTZ8WLIu0Q3_73gXvidkTSpMJlWsJUjFyhDY2f2ISM,7583
 shopware_api_client/config.py,sha256=HStgfQcClpo_aqaTRDrqdTUjqSGPFkIMjrPwSruVnM8,1565
 shopware_api_client/endpoints/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 shopware_api_client/endpoints/admin/__init__.py,sha256=yfGXeIzGDoAIzVBp0zEGYMcWKoc-qrjMeot8HXOwfhA,17213
@@ -108,7 +108,7 @@ shopware_api_client/endpoints/store/core/cart.py,sha256=34eNwuv7H9WZUtJGf4TkTGHi
 shopware_api_client/exceptions.py,sha256=AELVvzdjH0RABF0WgqQ-DbEuZB1k-5V8L_NkKZLV6tk,4459
 shopware_api_client/logging.py,sha256=4QSTK1vcdBew4shvLG-fm-xDOlddhOZeyb5T9Og0fSA,251
 shopware_api_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-shopware_api_client-1.0.100.dist-info/LICENSE,sha256=qTihFhbGE2ZJJ7Byc9hnEYBY33yDK2Jw87SpAm0IKUs,1107
-shopware_api_client-1.0.100.dist-info/METADATA,sha256=bliK6_zoJTbegjL2cb-xVSQUWuGRaCC-9J7_X0FWgQA,22502
-shopware_api_client-1.0.100.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-shopware_api_client-1.0.100.dist-info/RECORD,,
+shopware_api_client-1.0.102.dist-info/LICENSE,sha256=qTihFhbGE2ZJJ7Byc9hnEYBY33yDK2Jw87SpAm0IKUs,1107
+shopware_api_client-1.0.102.dist-info/METADATA,sha256=FQYM1P-ZsAL0904pyeXAA9rBwPM11Tpz4NH1vj2L1oI,22659
+shopware_api_client-1.0.102.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+shopware_api_client-1.0.102.dist-info/RECORD,,