lsrestclient 3.1.1__py3-none-any.whl → 3.3.0__py3-none-any.whl

lsrestclient/client.py

@@ -1,23 +1,33 @@
 import os
+from enum import Enum
 from typing import Optional, Dict, Any
 from unittest.mock import MagicMock
 
 import lsjsonclasses
 import requests
-from requests import Session
+import requests_cache
+from requests import Response, Session
 
 import re
 
+from requests_cache import CachedSession, SQLiteCache
+
 from lsrestclient import (
     LsRestClientResponse,
     exceptions,
 )
 from lsrestclient.contexts.bearer_token import bearer_token_context
+from lsrestclient.settings import LsRestClientSettings
 
 find_parameters_regex = re.compile("{(.*?)}")
 
 
-class LsRestClient(Session):
+class LsRestClientBackendEnum(str, Enum):
+    sqlite = "sqlite"
+    redis = "redis"
+
+
+class LsRestClient(object):
     _clients = {}
 
     @classmethod
@@ -65,8 +75,28 @@ class LsRestClient(Session):
         name: str = "default",
         headers: dict = None,
         ignore_bearer_context: bool = False,
+        cache: bool = False,
+        cache_backend: LsRestClientBackendEnum = LsRestClientBackendEnum.sqlite,
     ) -> None:
         """Class representing a REST client for JSON API."""
+        if cache:
+            if cache_backend == LsRestClientBackendEnum.redis:
+                settings = LsRestClientSettings()
+                backend = requests_cache.RedisCache(
+                    namespace=f"lsrestclient_{name}",
+                    host=settings.redis_host,
+                    port=settings.redis_port,
+                    db=settings.redis_db,
+                    ttl=settings.redis_ttl,
+                    ttl_offset=settings.redis_ttl_offset,
+                )
+            else:
+                backend = SQLiteCache(f".cache/{name}")
+
+            self._session = CachedSession(backend=backend, cache_control=True, filter_fn=self.cache_filter)
+
+        else:
+            self._session = Session()
 
         self._mocks = {}
         self.base_url = base_url
@@ -83,6 +113,13 @@ class LsRestClient(Session):
         super().__init__()
         self._clients[name] = self
 
+    def cache_filter(self, response: Response) -> bool:
+        settings = LsRestClientSettings()
+        cache_control = response.headers.get("Cache-Control")
+        if not cache_control and settings.insert_no_cache:
+            return False
+        return True
+
     @staticmethod
     def mock_name(client_name: str, method: str, url: str) -> str:
         return f"{client_name}_{method.upper()}_{url}"
@@ -203,7 +240,14 @@ class LsRestClient(Session):
 
         try:
             # noinspection PyArgumentList
-            requests_response = requests.request(
+            # requests_response = requests.request(
+            #     method.upper(),
+            #     full_url,
+            #     *args,
+            #     params=params,
+            #     **kwargs,
+            # )
+            requests_response = self._session.request(
                 method.upper(),
                 full_url,
                 *args,

lsrestclient/lsfastapi.py

@@ -0,0 +1,40 @@
+from abc import ABC, abstractmethod
+
+from lsrestclient import LsRestClient
+import logging
+
+log = logging.getLogger(__name__)
+
+
+class LsFastApiClientBase(ABC):
+    _client = None
+    client_name = None
+
+    def __init__(self):
+        pass
+
+    @classmethod
+    def client(cls) -> LsRestClient:
+        # noinspection PyBroadException
+        try:
+            cls._client = LsRestClient.client(cls.client_name)
+        except Exception as e:  # pragma: no cover
+            # noinspection PyArgumentList
+            cls._client = cls.register()
+        return cls._client
+
+    @classmethod
+    def register(cls, base_url: str = None) -> LsRestClient:
+        # noinspection PyArgumentList
+        log.debug(f"Registering {cls.client_name} API client at {base_url}")
+        cls._client = LsRestClient(name=cls.client_name, base_url=base_url or cls.base_url())
+        return cls._client
+
+    @classmethod
+    def health(cls):
+        return cls.client().get("/healthz")
+
+    @classmethod
+    @abstractmethod
+    def base_url(cls):
+        raise NotImplementedError

lsrestclient/response.py

@@ -1,3 +1,4 @@
+import datetime
 from dataclasses import dataclass
 from typing import Optional
 
@@ -5,6 +6,7 @@ import lsjsonclasses
 import pydash
 from requests import Response
 from requests.structures import CaseInsensitiveDict
+from requests_cache import CachedResponse
 
 
 @dataclass
@@ -16,6 +18,11 @@ class LsRestClientResponse:
     status_code: int
     content: str
     headers: CaseInsensitiveDict
+    created_at: datetime.datetime | None = None
+    expires: datetime.datetime | None = None
+    cache_key: str | None = None
+    revalidated: bool | None = None
+    from_cache: bool | None = False
 
     _json: Optional[dict] = None
 
@@ -43,11 +50,14 @@ class LsRestClientResponse:
         else:
             content = response.content.decode("utf8" if encoding is None else encoding)
 
-        return cls(
-            status_code=response.status_code,
-            content=content,
-            headers=response.headers,
-        )
+        ret = cls(status_code=response.status_code, content=content, headers=response.headers)
+        if isinstance(response, CachedResponse):
+            ret.created_at = response.created_at
+            ret.expires = response.expires
+            ret.cache_key = response.cache_key
+            ret.revalidated = response.revalidated
+            ret.from_cache = response.from_cache
+        return ret
 
     @classmethod
     def from_dict(cls, status_code: int = 200, data: dict = None, headers: CaseInsensitiveDict = None):

lsrestclient/settings.py

@@ -0,0 +1,11 @@
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class LsRestClientSettings(BaseSettings):
+    model_config = SettingsConfigDict(env_prefix="lsrestclient_")
+    insert_no_cache: bool = True
+    redis_host: str = "localhost"
+    redis_port: int = 6379
+    redis_db: int = 10
+    redis_ttl: bool = True
+    redis_ttl_offset: int = 3600

{lsrestclient-3.1.1.dist-info → lsrestclient-3.3.0.dist-info}/METADATA

@@ -1,17 +1,19 @@
 Metadata-Version: 2.1
 Name: lsrestclient
-Version: 3.1.1
+Version: 3.3.0
 Summary: REST Api Client
 Author: mba
 Author-email: bartel@electronic-shop.lu
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.12,<4.0
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
+Provides-Extra: redis
 Requires-Dist: lsjsonclasses (>=2.0.1,<3.0.0)
+Requires-Dist: pydantic (>=2.11.7,<3.0.0)
+Requires-Dist: pydantic-settings (>=2.10.1,<3.0.0)
 Requires-Dist: pydash (>4.0.0)
+Requires-Dist: redis (>=6.4.0,<7.0.0) ; extra == "redis"
 Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: requests-cache (>=1.2.1,<2.0.0)
 Requires-Dist: webexception (>=1.0.5,<2.0.0)
 Description-Content-Type: text/markdown
 

{lsrestclient-3.1.1.dist-info → lsrestclient-3.3.0.dist-info}/RECORD

@@ -1,13 +1,15 @@
 lsrestclient/__init__.py,sha256=lI62SHmG0m-iukB5UEwdN5dO4cKnDasOt-TmR1rgaWI,72
 lsrestclient/auth.py,sha256=IC6niEht-xB_wC7da0HIeM05Ha785qhls-Q39P6dMHQ,467
-lsrestclient/client.py,sha256=VnF8y4q4uR6vCMJNMYuS72cTmuCWwGFjYJkgeLWtJD4,11862
+lsrestclient/client.py,sha256=Nd3QQ9g0EOhcemJRnuGXpY_eeho5Cn2JNRMmGVeIDpc,13435
 lsrestclient/contexts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lsrestclient/contexts/bearer_token.py,sha256=GZZOzAI2Ng_9DvFCbhv1Wwb8wJ1AYCca3fQeNtt2NaU,753
 lsrestclient/exceptions.py,sha256=exJd1BfygNkkAqekmWepVXvXlMiOInVzPRnq7TmPURs,2149
 lsrestclient/fixtures.py,sha256=dFkAYQXL6xqTOwRofb03Nsu_cIjq1sG10Rh8dxWfz9s,239
+lsrestclient/lsfastapi.py,sha256=AkeJI4zcJTYGgj625OY_ae_aFi9BBiZP6xy85NxJXJ8,1064
 lsrestclient/mock.py,sha256=Ya12F0t5sXHTSt-X4jDDj5ILJx6y6QaBAMXutQMsIRI,1376
-lsrestclient/response.py,sha256=8ovVmVB8gLW3U1EkewdQlPdFYP-YLoOpIH3ATVQc3wc,2189
-lsrestclient-3.1.1.dist-info/METADATA,sha256=kHaZe0v1gee56HD9-u24rC6-qLbWeVhGH42jRgfSWsc,6748
-lsrestclient-3.1.1.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-lsrestclient-3.1.1.dist-info/entry_points.txt,sha256=7lN1XN3lq5Jv5PlpOdIlFrLlFlwzE5MaEWSgMhKASOM,47
-lsrestclient-3.1.1.dist-info/RECORD,,
+lsrestclient/response.py,sha256=4DYeN9e7phcrbm0QwwQS7uBI-sTDq7bKkP28BRWCzqA,2704
+lsrestclient/settings.py,sha256=qRhQYFCOA8sKhejrd7r47Q4Vo6mQjLbXko7jv3_889A,350
+lsrestclient-3.3.0.dist-info/METADATA,sha256=ZK5YCDx-_upxS0K9u9eKBpqNiY3DnF9EsVjUEZYNjdw,6816
+lsrestclient-3.3.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+lsrestclient-3.3.0.dist-info/entry_points.txt,sha256=7lN1XN3lq5Jv5PlpOdIlFrLlFlwzE5MaEWSgMhKASOM,47
+lsrestclient-3.3.0.dist-info/RECORD,,