jdejaegh/python-irceline
1
0
Fork 0
mirror of https://github.com/jdejaegh/python-irceline.git synced 2025-06-27 03:35:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add params to class and docstring

Browse source
This commit is contained in:
Jules 2024-06-16 15:18:31 +02:00
parent c62b135b52
commit 12f45d7df7
Signed by: jdejaegh
GPG key ID: 99D6D184CA66933A
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/open_irceline/api.py
View file

@ -18,9 +18,9 @@ class IrcelineApiError(Exception):
class IrcelineBaseClient: class IrcelineBaseClient:
def __init__(self, session: aiohttp.ClientSession) -> None: def __init__(self, session: aiohttp.ClientSession, cache_size: int = 20) -> None:
self._session = session self._session = session
self._cache = SizedDict(20) self._cache = SizedDict(cache_size)
async def _api_wrapper(self, url: str, querystring: dict = None, headers: dict = None, method: str = 'GET'): async def _api_wrapper(self, url: str, querystring: dict = None, headers: dict = None, method: str = 'GET'):
""" """
@ -54,6 +54,12 @@ class IrcelineBaseClient:
raise IrcelineApiError(f"Something really wrong happened! {exception}") from exception raise IrcelineApiError(f"Something really wrong happened! {exception}") from exception
async def _api_cached_wrapper(self, url: str, method: str = 'GET'): async def _api_cached_wrapper(self, url: str, method: str = 'GET'):
"""
Call the API but uses cache based on the ETag value to avoid repeated calls for the same ressource
:param url: url to fetch
:param method: HTTP method (default to GET)
:return: response from the client
"""
if url in self._cache: if url in self._cache:
headers = {"If-None-Match": f'{self._cache.get(url, {}).get("etag")}'} headers = {"If-None-Match": f'{self._cache.get(url, {}).get("etag")}'}
else: else: