Merge pull request 'v4.3.0' (#220) from dev into main

Reviewed-on: #220

README.md

@@ -16,6 +16,7 @@ There are different sub-packages available:
 * pyrogram - Telegram bots with Pyrogram's fork "Pyrofork"
 * pycord - Discord bots with Pycord
 * speed - Performance improvements
+* cache - Support for Redis and Memcached
 * dev - Dependencies for package development purposes
 
 You can freely choose any sub-package you want, as well as add multiple (comma-separated) or none at all.

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=62.6", "wheel"]
+requires = ["setuptools>=77.0.3", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -9,11 +9,11 @@ authors = [{ name = "Profitroll" }]
 description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
 readme = "README.md"
 requires-python = ">=3.11"
-license = { text = "GPLv3" }
+license = "GPL-3.0"
+license-files = ["LICENSE"]
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",

requirements/_.txt

@@ -1,2 +1,2 @@
 aiofiles>=23.0.0
-typing-extensions~=4.12.2
+typing-extensions~=4.14.0

requirements/cache.txt

@@ -1,2 +1,2 @@
 pymemcache~=4.0.0
-redis~=5.2.1
+redis~=6.2.0

requirements/dev.txt

@@ -1,12 +1,12 @@
 black==25.1.0
 build==1.2.2.post1
 isort==5.13.2
-mypy==1.15.0
-pylint==3.3.4
-pytest-asyncio==0.25.3
-pytest-cov==6.0.0
-pytest==8.3.4
-tox==4.24.0
+mypy==1.16.1
+pylint==3.3.7
+pytest-asyncio==1.0.0
+pytest-cov==6.2.1
+pytest==8.4.1
+tox==4.27.0
 twine==6.1.0
-types-aiofiles==24.1.0.20241221
-types-ujson==5.10.0.20240515
+types-aiofiles==24.1.0.20250606
+types-ujson==5.10.0.20250326

src/libbot/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "4.1.0"
+__version__ = "4.3.0"
 __license__ = "GPL3"
 __author__ = "Profitroll"
 

src/libbot/cache/classes/cache.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Any, Dict
+from typing import Any, Dict, Optional
 
 import pymemcache
 import redis
@@ -27,16 +27,16 @@ class Cache(ABC):
         pass
 
     @abstractmethod
-    def set_json(self, key: str, value: Any) -> None:
+    def set_json(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
         # TODO This method must also carry out ObjectId conversion!
         pass
 
     @abstractmethod
-    def set_string(self, key: str, value: str) -> None:
+    def set_string(self, key: str, value: str, ttl_seconds: Optional[int] = None) -> None:
         pass
 
     @abstractmethod
-    def set_object(self, key: str, value: Any) -> None:
+    def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
         pass
 
     @abstractmethod

src/libbot/cache/classes/cache_memcached.py

@@ -1,6 +1,6 @@
 import logging
 from logging import Logger
-from typing import Dict, Any
+from typing import Dict, Any, Optional
 
 from pymemcache import Client
 
@@ -13,21 +13,30 @@ logger: Logger = logging.getLogger(__name__)
 class CacheMemcached(Cache):
     client: Client
 
-    def __init__(self, client: Client):
-        self.client = client
+    def __init__(
+        self, client: Client, prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = None
+    ) -> None:
+        self.client: Client = client
+        self.prefix: str | None = prefix
+        self.default_ttl_seconds: int = default_ttl_seconds if default_ttl_seconds is not None else 0
 
         logger.info("Initialized Memcached for caching")
 
     @classmethod
-    def from_config(cls, engine_config: Dict[str, Any]) -> "CacheMemcached":
+    def from_config(cls, engine_config: Dict[str, Any], prefix: Optional[str] = None) -> "CacheMemcached":
         if "uri" not in engine_config:
             raise KeyError(
                 "Cache configuration is invalid. Please check if all keys are set (engine: memcached)"
             )
 
-        return cls(Client(engine_config["uri"], default_noreply=True))
+        return cls(Client(engine_config["uri"], default_noreply=True), prefix=prefix)
+
+    def _get_prefixed_key(self, key: str) -> str:
+        return key if self.prefix is None else f"{self.prefix}_{key}"
 
     def get_json(self, key: str) -> Any | None:
+        key = self._get_prefixed_key(key)
+
         try:
             result: Any | None = self.client.get(key, None)
 
@@ -43,6 +52,8 @@ class CacheMemcached(Cache):
         return None if result is None else _string_to_json(result)
 
     def get_string(self, key: str) -> str | None:
+        key = self._get_prefixed_key(key)
+
         try:
             result: str | None = self.client.get(key, None)
 
@@ -61,27 +72,39 @@ class CacheMemcached(Cache):
     def get_object(self, key: str) -> Any | None:
         raise NotImplementedError()
 
-    def set_json(self, key: str, value: Any) -> None:
+    def set_json(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
+        key = self._get_prefixed_key(key)
+
         try:
-            self.client.set(key, _json_to_string(value))
+            self.client.set(
+                key,
+                _json_to_string(value),
+                expire=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds,
+            )
             logger.debug("Set json cache key '%s'", key)
         except Exception as exc:
             logger.error("Could not set json cache key '%s' due to: %s", key, exc)
             return None
 
-    def set_string(self, key: str, value: str) -> None:
+    def set_string(self, key: str, value: str, ttl_seconds: Optional[int] = None) -> None:
+        key = self._get_prefixed_key(key)
+
         try:
-            self.client.set(key, value)
+            self.client.set(
+                key, value, expire=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds
+            )
             logger.debug("Set string cache key '%s'", key)
         except Exception as exc:
             logger.error("Could not set string cache key '%s' due to: %s", key, exc)
             return None
 
     # TODO Implement binary serialization
-    def set_object(self, key: str, value: Any) -> None:
+    def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
         raise NotImplementedError()
 
     def delete(self, key: str) -> None:
+        key = self._get_prefixed_key(key)
+
         try:
             self.client.delete(key)
             logger.debug("Deleted cache key '%s'", key)

src/libbot/cache/classes/cache_redis.py

@@ -1,11 +1,11 @@
 import logging
 from logging import Logger
-from typing import Dict, Any
+from typing import Dict, Any, Optional
 
 from redis import Redis
 
 from .cache import Cache
-from ..utils._objects import _string_to_json, _json_to_string
+from ..utils._objects import _json_to_string, _string_to_json
 
 logger: Logger = logging.getLogger(__name__)
 
@@ -13,21 +13,30 @@ logger: Logger = logging.getLogger(__name__)
 class CacheRedis(Cache):
     client: Redis
 
-    def __init__(self, client: Redis):
-        self.client = client
+    def __init__(
+        self, client: Redis, prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = None
+    ) -> None:
+        self.client: Redis = client
+        self.prefix: str | None = prefix
+        self.default_ttl_seconds: int | None = default_ttl_seconds
 
         logger.info("Initialized Redis for caching")
 
     @classmethod
-    def from_config(cls, engine_config: Dict[str, Any]) -> Any:
+    def from_config(cls, engine_config: Dict[str, Any], prefix: Optional[str] = None) -> Any:
         if "uri" not in engine_config:
             raise KeyError(
                 "Cache configuration is invalid. Please check if all keys are set (engine: memcached)"
             )
 
-        return cls(Redis.from_url(engine_config["uri"]))
+        return cls(Redis.from_url(engine_config["uri"]), prefix=prefix)
+
+    def _get_prefixed_key(self, key: str) -> str:
+        return key if self.prefix is None else f"{self.prefix}_{key}"
 
     def get_json(self, key: str) -> Any | None:
+        key = self._get_prefixed_key(key)
+
         try:
             result: Any | None = self.client.get(key)
 
@@ -43,6 +52,8 @@ class CacheRedis(Cache):
         return None if result is None else _string_to_json(result)
 
     def get_string(self, key: str) -> str | None:
+        key = self._get_prefixed_key(key)
+
         try:
             result: str | None = self.client.get(key)
 
@@ -61,27 +72,37 @@ class CacheRedis(Cache):
     def get_object(self, key: str) -> Any | None:
         raise NotImplementedError()
 
-    def set_json(self, key: str, value: Any) -> None:
+    def set_json(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
+        key = self._get_prefixed_key(key)
+
         try:
-            self.client.set(key, _json_to_string(value))
+            self.client.set(
+                key,
+                _json_to_string(value),
+                ex=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds,
+            )
             logger.debug("Set json cache key '%s'", key)
         except Exception as exc:
             logger.error("Could not set json cache key '%s' due to: %s", key, exc)
             return None
 
-    def set_string(self, key: str, value: str) -> None:
+    def set_string(self, key: str, value: str, ttl_seconds: Optional[int] = None) -> None:
+        key = self._get_prefixed_key(key)
+
         try:
-            self.client.set(key, value)
+            self.client.set(key, value, ex=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds)
             logger.debug("Set string cache key '%s'", key)
         except Exception as exc:
             logger.error("Could not set string cache key '%s' due to: %s", key, exc)
             return None
 
     # TODO Implement binary serialization
-    def set_object(self, key: str, value: Any) -> None:
+    def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
         raise NotImplementedError()
 
     def delete(self, key: str) -> None:
+        key = self._get_prefixed_key(key)
+
         try:
             self.client.delete(key)
             logger.debug("Deleted cache key '%s'", key)

src/libbot/cache/manager/manager.py

@@ -1,4 +1,4 @@
-from typing import Dict, Any, Literal
+from typing import Dict, Any, Literal, Optional
 
 from ..classes import CacheMemcached, CacheRedis
 
@@ -6,6 +6,7 @@ from ..classes import CacheMemcached, CacheRedis
 def create_cache_client(
     config: Dict[str, Any],
     engine: Literal["memcached", "redis"] | None = None,
+    prefix: Optional[str] = None,
 ) -> CacheMemcached | CacheRedis:
     if engine not in ["memcached", "redis"] or engine is None:
         raise KeyError(f"Incorrect cache engine provided. Expected 'memcached' or 'redis', got '{engine}'")
@@ -17,8 +18,8 @@ def create_cache_client(
 
     match engine:
         case "memcached":
-            return CacheMemcached.from_config(config["cache"][engine])
+            return CacheMemcached.from_config(config["cache"][engine], prefix=prefix)
         case "redis":
-            return CacheRedis.from_config(config["cache"][engine])
+            return CacheRedis.from_config(config["cache"][engine], prefix=prefix)
         case _:
             raise KeyError(f"Cache implementation for the engine '{engine}' is not present.")