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

Reviewed-on: #224

.gitea/workflows/analysis.yml

@@ -6,19 +6,18 @@ on:
       - main
       - dev
   pull_request:
-    types: [opened, synchronize, reopened]
+    types: [ opened, synchronize, reopened ]
 
 jobs:
   sonarcloud:
     name: SonarCloud
-    runs-on: ubuntu-latest
-    container: catthehacker/ubuntu:act-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: SonarCloud Scan
-        uses: SonarSource/sonarcloud-github-action@master
+      - name: SonarQube Scan
+        uses: SonarSource/sonarqube-scan-action@v4.2.1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitea/workflows/publish.yml

@@ -9,81 +9,58 @@ permissions:
 
 jobs:
   release-build:
-    runs-on: ubuntu-latest
-    container: catthehacker/ubuntu:act-latest
-
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-
       - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
-
       - name: Build release distributions
         run: |
           python -m pip install build
           python -m build
-
       - name: Upload distributions
         uses: christopherhx/gitea-upload-artifact@v4
         with:
           name: release-dists
           path: dist/
-
   gitea-publish:
-    runs-on: ubuntu-latest
-    container: catthehacker/ubuntu:act-latest
-
-    needs:
-      - release-build
-
+    runs-on: ubuntu-24.04
+    needs: release-build
     permissions:
       id-token: write
-
     environment:
       name: gitea
       url: https://git.end-play.xyz/profitroll/-/packages/pypi/libbot
-
     env:
       GITHUB_WORKFLOW_REF: ${{ gitea.workflow_ref }}
       INPUT_REPOSITORY_URL: https://git.end-play.xyz/api/packages/profitroll/pypi
-
     steps:
       - name: Retrieve release distributions
         uses: christopherhx/gitea-download-artifact@v4
         with:
           name: release-dists
           path: dist/
-
       - name: Publish package distributions to TestPyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.PYPI_GITEA_API_TOKEN }}
           repository-url: https://git.end-play.xyz/api/packages/profitroll/pypi
-
   pypi-publish:
-    runs-on: ubuntu-latest
-    container: catthehacker/ubuntu:act-latest
-
-    needs:
-      - release-build
-
+    runs-on: ubuntu-24.04
+    needs: release-build
     permissions:
       id-token: write
-
     environment:
       name: pypi
-
     env:
       GITHUB_WORKFLOW_REF: ${{ gitea.workflow_ref }}
-
     steps:
       - name: Retrieve release distributions
         uses: christopherhx/gitea-download-artifact@v4
         with:
           name: release-dists
           path: dist/
-
       - name: Publish package distributions to TestPyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:

.gitea/workflows/tests.yml

@@ -11,18 +11,18 @@ on:
 jobs:
   test:
     name: Build and Test
-    runs-on: ubuntu-latest
-    container: catthehacker/ubuntu:act-latest
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
         python-version: [ "3.11", "3.12", "3.13" ]
-
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: './requirements/*'
         env:
           AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
       - name: Install dependencies

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",
@@ -31,6 +31,7 @@ dev = { file = "requirements/dev.txt" }
 pycord = { file = "requirements/pycord.txt" }
 pyrogram = { file = "requirements/pyrogram.txt" }
 speed = { file = "requirements/speed.txt" }
+cache = { file = "requirements/cache.txt" }
 
 [project.urls]
 Source = "https://git.end-play.xyz/profitroll/LibBotUniversal"

requirements/_.txt

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

requirements/cache.txt

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

requirements/dev.txt

@@ -1,12 +1,12 @@
-black==24.10.0
+black==25.1.0
 build==1.2.2.post1
 isort==5.13.2
-mypy==1.14.1
-pylint==3.3.3
-pytest-asyncio==0.25.1
-pytest-cov==6.0.0
-pytest==8.3.4
-tox==4.23.2
-twine==6.0.1
-types-aiofiles==24.1.0.20241221
-types-ujson==5.10.0.20240515
+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.20250708
+types-ujson==5.10.0.20250326

src/libbot/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "4.0.2"
+__version__ = "4.4.0"
 __license__ = "GPL3"
 __author__ = "Profitroll"
 

src/libbot/cache/__init__.py

@@ -0,0 +1,2 @@
+# This file is left empty on purpose
+# Adding imports here will cause import errors when libbot[pycord] is not installed

src/libbot/cache/classes/__init__.py

@@ -0,0 +1,3 @@
+from .cache import Cache
+from .cache_memcached import CacheMemcached
+from .cache_redis import CacheRedis

src/libbot/cache/classes/cache.py

@@ -0,0 +1,44 @@
+from abc import ABC, abstractmethod
+from typing import Any, Dict, Optional
+
+import pymemcache
+import redis
+
+
+class Cache(ABC):
+    client: pymemcache.Client | redis.Redis
+
+    @classmethod
+    @abstractmethod
+    def from_config(cls, engine_config: Dict[str, Any]) -> Any:
+        pass
+
+    @abstractmethod
+    def get_json(self, key: str) -> Any | None:
+        # TODO This method must also carry out ObjectId conversion!
+        pass
+
+    @abstractmethod
+    def get_string(self, key: str) -> str | None:
+        pass
+
+    @abstractmethod
+    def get_object(self, key: str) -> Any | None:
+        pass
+
+    @abstractmethod
+    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, ttl_seconds: Optional[int] = None) -> None:
+        pass
+
+    @abstractmethod
+    def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
+        pass
+
+    @abstractmethod
+    def delete(self, key: str) -> None:
+        pass

src/libbot/cache/classes/cache_memcached.py

@@ -0,0 +1,112 @@
+import logging
+from logging import Logger
+from typing import Dict, Any, Optional
+
+from pymemcache import Client
+
+from .cache import Cache
+from ..utils._objects import _json_to_string, _string_to_json
+
+logger: Logger = logging.getLogger(__name__)
+
+
+class CacheMemcached(Cache):
+    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], prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = 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), prefix=prefix, default_ttl_seconds=default_ttl_seconds)
+
+    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)
+
+            logger.debug(
+                "Got json cache key '%s'%s",
+                key,
+                "" if result is not None else " (not found)",
+            )
+        except Exception as exc:
+            logger.error("Could not get json cache key '%s' due to: %s", key, exc)
+            return None
+
+        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)
+
+            logger.debug(
+                "Got string cache key '%s'%s",
+                key,
+                "" if result is not None else " (not found)",
+            )
+
+            return result
+        except Exception as exc:
+            logger.error("Could not get string cache key '%s' due to: %s", key, exc)
+            return None
+
+    # TODO Implement binary deserialization
+    def get_object(self, key: str) -> Any | None:
+        raise NotImplementedError()
+
+    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),
+                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, ttl_seconds: Optional[int] = None) -> None:
+        key = self._get_prefixed_key(key)
+
+        try:
+            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, 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)
+        except Exception as exc:
+            logger.error("Could not delete cache key '%s' due to: %s", key, exc)

src/libbot/cache/classes/cache_redis.py

@@ -0,0 +1,110 @@
+import logging
+from logging import Logger
+from typing import Dict, Any, Optional
+
+from redis import Redis
+
+from .cache import Cache
+from ..utils._objects import _json_to_string, _string_to_json
+
+logger: Logger = logging.getLogger(__name__)
+
+
+class CacheRedis(Cache):
+    client: Redis
+
+    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], prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = 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"]), prefix=prefix, default_ttl_seconds=default_ttl_seconds)
+
+    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)
+
+            logger.debug(
+                "Got json cache key '%s'%s",
+                key,
+                "" if result is not None else " (not found)",
+            )
+        except Exception as exc:
+            logger.error("Could not get json cache key '%s' due to: %s", key, exc)
+            return None
+
+        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)
+
+            logger.debug(
+                "Got string cache key '%s'%s",
+                key,
+                "" if result is not None else " (not found)",
+            )
+
+            return result
+        except Exception as exc:
+            logger.error("Could not get string cache key '%s' due to: %s", key, exc)
+            return None
+
+    # TODO Implement binary deserialization
+    def get_object(self, key: str) -> Any | None:
+        raise NotImplementedError()
+
+    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),
+                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, ttl_seconds: Optional[int] = None) -> None:
+        key = self._get_prefixed_key(key)
+
+        try:
+            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, 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)
+        except Exception as exc:
+            logger.error("Could not delete cache key '%s' due to: %s", key, exc)

src/libbot/cache/manager/__init__.py

@@ -0,0 +1 @@
+from .manager import create_cache_client

src/libbot/cache/manager/manager.py

@@ -0,0 +1,37 @@
+from typing import Dict, Any, Literal, Optional
+
+from ..classes import CacheMemcached, CacheRedis
+
+
+def create_cache_client(
+    config: Dict[str, Any],
+    engine: Literal["memcached", "redis"] | None = None,
+    prefix: Optional[str] = None,
+    default_ttl_seconds: Optional[int] = None,
+) -> CacheMemcached | CacheRedis:
+    """Create a cache client of a provided type.
+
+    Args:
+        config (Dict[str, Any]): Cache client configuration.
+        engine (Literal["memcached", "redis"] | None): Cache engine to use. Defaults to None.
+        prefix (:obj:`str`, optional): Prefix used for each key-value pair. Defaults to None (no prefix).
+        default_ttl_seconds (:obj:`int`, optional): Default TTL for values (in seconds). Defaults to None (does not expire).
+
+    Returns:
+        CacheMemcached | CacheRedis: Cache client.
+    """
+    if engine not in ["memcached", "redis"] or engine is None:
+        raise KeyError(f"Incorrect cache engine provided. Expected 'memcached' or 'redis', got '{engine}'")
+
+    if "cache" not in config or engine not in config["cache"]:
+        raise KeyError(
+            f"Cache configuration is invalid. Please check if all keys are set (engine: '{engine}')"
+        )
+
+    match engine:
+        case "memcached":
+            return CacheMemcached.from_config(config["cache"][engine], prefix=prefix, default_ttl_seconds=default_ttl_seconds)
+        case "redis":
+            return CacheRedis.from_config(config["cache"][engine], prefix=prefix, default_ttl_seconds=default_ttl_seconds)
+        case _:
+            raise KeyError(f"Cache implementation for the engine '{engine}' is not present.")

src/libbot/cache/utils/_objects.py

@@ -0,0 +1,42 @@
+import logging
+from copy import deepcopy
+from logging import Logger
+from typing import Any
+
+try:
+    from ujson import dumps, loads
+except ImportError:
+    from json import dumps, loads
+
+logger: Logger = logging.getLogger(__name__)
+
+try:
+    from bson import ObjectId
+except ImportError:
+    logger.warning(
+        "Could not import bson.ObjectId. PyMongo conversions will not be supported by the cache. It's safe to ignore this message if you do not use MongoDB."
+    )
+
+
+def _json_to_string(json_object: Any) -> str:
+    json_object_copy: Any = deepcopy(json_object)
+
+    if isinstance(json_object_copy, dict) and "_id" in json_object_copy:
+        json_object_copy["_id"] = str(json_object_copy["_id"])
+
+    return dumps(json_object_copy, ensure_ascii=False, indent=0, escape_forward_slashes=False)
+
+
+def _string_to_json(json_string: str) -> Any:
+    json_object: Any = loads(json_string)
+
+    if "_id" in json_object:
+        try:
+            json_object["_id"] = ObjectId(json_object["_id"])
+        except NameError:
+            logger.debug(
+                "Tried to convert attribute '_id' with value '%s' but bson.ObjectId is not present, skipping the conversion.",
+                json_object["_id"],
+            )
+
+    return json_object

src/libbot/i18n/_functions.py

@@ -18,16 +18,16 @@ def _(
     locale: str | None = "en",
     locales_root: str | Path = Path("locale"),
 ) -> Any:
-    """Get value of locale string
+    """Get value of locale string.
 
-    ### Args:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locale (`str | None`): Locale to looked up in. Defaults to `"en"`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locale (str | None): Locale to looked up in. Defaults to "en".
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
 
-    ### Returns:
-        * `Any`: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`
+    Returns:
+        Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`.
     """
     if locale is None:
         locale: str = config_get("locale")
@@ -58,16 +58,16 @@ async def _(
     locale: str | None = "en",
     locales_root: str | Path = Path("locale"),
 ) -> Any:
-    """Get value of locale string
+    """Get value of locale string.
 
-    ### Args:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locale (`str | None`): Locale to looked up in. Defaults to `"en"`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locale (str | None): Locale to looked up in. Defaults to "en".
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
 
-    ### Returns:
-        * `Any`: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`
+    Returns:
+        Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`.
     """
     locale: str = config_get("locale") if locale is None else locale
 
@@ -94,15 +94,15 @@ async def _(
 
 @asyncable
 def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("locale")) -> List[Any]:
-    """Get value of the provided key and path in all available locales
+    """Get value of the provided key and path in all available locales.
 
-    ### Args:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to `Path("locale")`.
 
-    ### Returns:
-        * `List[Any]`: List of values in all locales
+    Returns:
+        List[Any]: List of values in all locales.
     """
 
     output: List[Any] = []
@@ -128,15 +128,15 @@ def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("locale
 
 @in_all_locales.asynchronous
 async def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("locale")) -> List[Any]:
-    """Get value of the provided key and path in all available locales
+    """Get value of the provided key and path in all available locales.
 
-    ### Args:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
 
-    ### Returns:
-        * `List[Any]`: List of values in all locales
+    Returns:
+        List[Any]: List of values in all locales.
     """
 
     output: List[Any] = []
@@ -164,15 +164,15 @@ async def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("
 def in_every_locale(
     key: str, *args: str, locales_root: str | Path = Path("locale")
 ) -> Dict[str, Any]:
-    """Get value of the provided key and path in every available locale with locale tag
+    """Get value of the provided key and path in every available locale with locale tag.
 
-    ### Args:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
 
-    ### Returns:
-        * `Dict[str, Any]`: Locale is a key, and it's value from locale file is a value
+    Returns:
+        Dict[str, Any]: Locale is a key, and it's value from locale file is a value.
     """
 
     output: Dict[str, Any] = {}
@@ -200,15 +200,15 @@ def in_every_locale(
 async def in_every_locale(
     key: str, *args: str, locales_root: str | Path = Path("locale")
 ) -> Dict[str, Any]:
-    """Get value of the provided key and path in every available locale with locale tag
+    """Get value of the provided key and path in every available locale with locale tag.
 
-    ### Args:
-        * key (`str`): The last key of the locale's keys path.
-        * *args (`str`): Path to key like: `dict[args][key]`.
-        * locales_root (`str | Path`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
+    Args:
+        key (str): The last key of the locale's keys path.
+        *args (str): Path to key like: `dict[args][key]`.
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
 
-    ### Returns:
-        * `Dict[str, Any]`: Locale is a key, and it's value from locale file is a value
+    Returns:
+        Dict[str, Any]: Locale is a key, and it's value from locale file is a value.
     """
 
     output: Dict[str, Any] = {}

src/libbot/i18n/classes/bot_locale.py

@@ -14,6 +14,11 @@ class BotLocale:
         default_locale: str | None = "en",
         locales_root: str | Path = Path("locale"),
     ) -> None:
+        """
+        Args:
+            default_locale (str | None, optional): Default locale. Defaults to "en".
+            locales_root (str | Path, optional): Path to a directory with locale files. Defaults to Path("locale").
+        """
         if isinstance(locales_root, str):
             locales_root = Path(locales_root)
         elif not isinstance(locales_root, Path):
@@ -30,15 +35,15 @@ class BotLocale:
             self.locales[locale] = json_read(Path(f"{locales_root}/{locale}.json"))
 
     def _(self, key: str, *args: str, locale: str | None = None) -> Any:
-        """Get value of locale string
+        """Get value of locale string.
 
-        ### Args:
-            * key (`str`): The last key of the locale's keys path
-            * *args (`str`): Path to key like: `dict[args][key]`
-            * locale (`str | None`, *optional*): Locale to looked up in. Defaults to config's `"locale"` value
+        Args:
+            key (str): The last key of the locale's keys path.
+            *args (str): Path to key like: `dict[args][key]`.
+            locale (str | None, optional): Locale to looked up in. Defaults to config's `"locale"` value.
 
-        ### Returns:
-            * `Any`: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`
+        Returns:
+            Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`.
         """
         if locale is None:
             locale: str = self.default
@@ -64,14 +69,14 @@ class BotLocale:
             return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
 
     def in_all_locales(self, key: str, *args: str) -> List[Any]:
-        """Get value of the provided key and path in all available locales
+        """Get value of the provided key and path in all available locales.
 
-        ### Args:
-            * key (`str`): The last key of the locale's keys path.
-            * *args (`str`): Path to key like: `dict[args][key]`.
+        Args:
+            key (str): The last key of the locale's keys path.
+            *args (str): Path to key like: `dict[args][key]`.
 
-        ### Returns:
-            * `List[Any]`: List of values in all locales
+        Returns:
+            List[Any]: List of values in all locales.
         """
         output: List[Any] = []
 
@@ -94,14 +99,14 @@ class BotLocale:
         return output
 
     def in_every_locale(self, key: str, *args: str) -> Dict[str, Any]:
-        """Get value of the provided key and path in every available locale with locale tag
+        """Get value of the provided key and path in every available locale with locale tag.
 
-        ### Args:
-            * key (`str`): The last key of the locale's keys path.
-            * *args (`str`): Path to key like: `dict[args][key]`.
+        Args:
+            key (str): The last key of the locale's keys path.
+            *args (str): Path to key like: `dict[args][key]`.
 
-        ### Returns:
-            * `Dict[str, Any]`: Locale is a key, and it's value from locale file is a value
+        Returns:
+            Dict[str, Any]: Locale is a key, and it's value from locale file is a value.
         """
         output: Dict[str, Any] = {}
 

src/libbot/utils/config/_functions.py

@@ -15,34 +15,24 @@ DEFAULT_CONFIG_LOCATION: str = "config.json"
 
 @asyncable
 def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION) -> Any:
-    """Get a value of the config key by its path provided
-    For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`
+    """Get a value of the config key by its path provided.
+    For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`.
 
-    ### Args:
-        * key (`str`): Key that contains the value
-        * *path (`str`): Path to the key that contains the value
-        * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
+    Args:
+        key (str): Key that contains the value
+        *path (str): Path to the key that contains the value (pass *[] or don't pass anything at all to get on the top/root level)
+        config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
-    ### Returns:
-        * `Any`: Key's value
+    Returns:
+        Any: Key's value
 
-    ### Example:
-    Get the "salary" of "Pete" from this JSON structure:
-    ```json
-    {
-        "users": {
-            "Pete": {
-                "salary": 10.0
-            }
-        }
-    }
-    ```
+    Example:
+        Get the "salary" of "Pete" from this JSON structure: `{"users": {"Pete": {"salary": 10.0}}}`
 
-    This can be easily done with the following code:
-    ```python
-    import libbot
-    salary = libbot.sync.config_get("salary", "users", "Pete")
-    ```
+        This can be easily done with the following code:
+
+        >>> import libbot
+        salary: float = libbot.sync.config_get("salary", "users", "Pete")
     """
     this_key: Dict[str, Any] = json_read(config_file)
 
@@ -54,34 +44,24 @@ def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LO
 
 @config_get.asynchronous
 async def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION) -> Any:
-    """Get a value of the config key by its path provided
-    For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`
+    """Get a value of the config key by its path provided.
+    For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`.
 
-    ### Args:
-        * key (`str`): Key that contains the value
-        * *path (`str`): Path to the key that contains the value
-        * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
+    Args:
+        key (str): Key that contains the value
+        *path (str): Path to the key that contains the value (pass *[] or don't pass anything at all to get on the top/root level)
+        config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
-    ### Returns:
-        * `Any`: Key's value
+    Returns:
+        Any: Key's value
 
-    ### Example:
-    Get the "salary" of "Pete" from this JSON structure:
-    ```json
-    {
-        "users": {
-            "Pete": {
-                "salary": 10.0
-            }
-        }
-    }
-    ```
+    Example:
+        Get the "salary" of "Pete" from this JSON structure: `{"users": {"Pete": {"salary": 10.0}}}`
 
-    This can be easily done with the following code:
-    ```python
-    import libbot
-    salary = await libbot.config_get("salary", "users", "Pete")
-    ```
+        This can be easily done with the following code:
+
+        >>> import libbot
+        salary: float = libbot.sync.config_get("salary", "users", "Pete")
     """
     this_key: Dict[str, Any] = await json_read(config_file)
 
@@ -93,16 +73,16 @@ async def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CON
 
 @asyncable
 def config_set(key: str, value: Any, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION) -> None:
-    """Set config's key by its path to the value
+    """Set config's key by its path to the value.
 
-    ### Args:
-        * key (`str`): Key that leads to the value
-        * value (`Any`): Any JSON serializable data
-        * *path (`str`): Path to the key of the target
-        * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
+    Args:
+        key (str): Key that leads to the value.
+        value (Any): Any JSON-serializable data.
+        *path (str): Path to the key of the target (pass *[] or don't pass anything at all to set on the top/root level).
+        config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to "config.json".
 
-    ### Raises:
-        * `KeyError`: Key is not found under path provided
+    Raises:
+        KeyError: Key was not found under the provided path.
     """
     json_write(nested_set(json_read(config_file), value, *(*path, key)), config_file)
 
@@ -111,16 +91,16 @@ def config_set(key: str, value: Any, *path: str, config_file: str | Path = DEFAU
 async def config_set(
     key: str, value: Any, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION
 ) -> None:
-    """Set config's key by its path to the value
+    """Set config's key by its path to the value.
 
-    ### Args:
-        * key (`str`): Key that leads to the value
-        * value (`Any`): Any JSON serializable data
-        * *path (`str`): Path to the key of the target
-        * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
+    Args:
+        key (str): Key that leads to the value.
+        value (Any): Any JSON-serializable data.
+        *path (str): Path to the key of the target (pass *[] or don't pass anything at all to set on the top/root level).
+        config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to "config.json".
 
-    ### Raises:
-        * `KeyError`: Key is not found under path provided
+    Raises:
+        KeyError: Key was not found under the provided path.
     """
     await json_write(nested_set(await json_read(config_file), value, *(*path, key)), config_file)
 
@@ -132,16 +112,16 @@ def config_delete(
     missing_ok: bool = False,
     config_file: str | Path = DEFAULT_CONFIG_LOCATION,
 ) -> None:
-    """Set config's key by its path
+    """Delete config's key by its path.
 
-    ### Args:
-        * key (`str`): Key to delete
-        * *path (`str`): Path to the key of the target
-        * missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
-        * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
+    Args:
+        key (str): Key to delete.
+        *path (str): Path to the key of the target (pass *[] or don't pass anything at all to delete on the top/root level)
+        missing_ok (bool): Do not raise an exception if the key is missing. Defaults to False.
+        config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to "config.json".
 
-    ### Raises:
-        * `KeyError`: Key is not found under path provided and `missing_ok` is `False`
+    Raises:
+        KeyError: Key is not found under path provided and `missing_ok` is False.
     """
     config_data: Dict[str, Any] = json_read(config_file)
 
@@ -161,16 +141,16 @@ async def config_delete(
     missing_ok: bool = False,
     config_file: str | Path = DEFAULT_CONFIG_LOCATION,
 ) -> None:
-    """Set config's key by its path
+    """Delete config's key by its path.
 
-    ### Args:
-        * key (`str`): Key to delete
-        * *path (`str`): Path to the key of the target
-        * missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
-        * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
+    Args:
+        key (str): Key to delete.
+        *path (str): Path to the key of the target (pass *[] or don't pass anything at all to delete on the top/root level)
+        missing_ok (bool): Do not raise an exception if the key is missing. Defaults to False.
+        config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to "config.json".
 
-    ### Raises:
-        * `KeyError`: Key is not found under path provided and `missing_ok` is `False`
+    Raises:
+        KeyError: Key is not found under path provided and `missing_ok` is False.
     """
     config_data: Dict[str, Any] = await json_read(config_file)
 

src/libbot/utils/json/_functions.py

@@ -14,13 +14,13 @@ except ImportError:
 
 @asyncable
 def json_read(path: str | Path) -> Any:
-    """Read contents of a JSON file
+    """Read contents of a JSON file and return it.
 
-    ### Args:
-        * path (`str | Path`): Path-like object or path as a string
+    Args:
+        path (str | Path): Path-like object or path to the file as a string.
 
-    ### Returns:
-        * `Any`: File contents
+    Returns:
+        Any: File contents.
     """
     with open(str(path), mode="r", encoding="utf-8") as f:
         data = f.read()
@@ -30,13 +30,13 @@ def json_read(path: str | Path) -> Any:
 
 @json_read.asynchronous
 async def json_read(path: str | Path) -> Any:
-    """Read contents of a JSON file
+    """Read contents of a JSON file and return it.
 
-    ### Args:
-        * path (`str | Path`): Path-like object or path as a string
+    Args:
+        path (str | Path): Path-like object or path to the file as a string.
 
-    ### Returns:
-        * `Any`: File contents
+    Returns:
+        Any: File contents.
     """
     async with aiofiles.open(str(path), mode="r", encoding="utf-8") as f:
         data = await f.read()
@@ -46,11 +46,11 @@ async def json_read(path: str | Path) -> Any:
 
 @asyncable
 def json_write(data: Any, path: str | Path) -> None:
-    """Write contents to a JSON file
+    """Write contents to a JSON file.
 
-    ### Args:
-        * data (`Any`): Contents to write. Must be a JSON serializable
-        * path (`str | Path`): Path-like object or path as a string of a destination
+    Args:
+        data (Any): Contents to write. Must be a JSON-serializable object.
+        path (str | Path): Path-like object or path to the file as a string.
     """
     with open(str(path), mode="w", encoding="utf-8") as f:
         f.write(
@@ -62,11 +62,11 @@ def json_write(data: Any, path: str | Path) -> None:
 
 @json_write.asynchronous
 async def json_write(data: Any, path: str | Path) -> None:
-    """Write contents to a JSON file
+    """Write contents to a JSON file.
 
-    ### Args:
-        * data (`Any`): Contents to write. Must be a JSON serializable
-        * path (`str | Path`): Path-like object or path as a string of a destination
+    Args:
+        data (Any): Contents to write. Must be a JSON-serializable object.
+        path (str | Path): Path-like object or path to the file as a string.
     """
     async with aiofiles.open(str(path), mode="w", encoding="utf-8") as f:
         await f.write(

src/libbot/utils/misc/_functions.py

@@ -3,15 +3,15 @@ from typing import Any, Dict
 from typing import Callable
 
 
-def supports_argument(func: Callable, arg_name: str) -> bool:
-    """Check whether a function has a specific argument
+def supports_argument(func: Callable[..., Any], arg_name: str) -> bool:
+    """Check whether a function has a specific argument.
 
-    ### Args:
-        * func (`Callable`): Function to be inspected
-        * arg_name (`str`): Argument to be checked
+    Args:
+        func (Callable[..., Any]): Function to be inspected.
+        arg_name (str): Argument to be checked.
 
-    ### Returns:
-        * `bool`: `True` if argument is supported and `False` if not
+    Returns:
+        bool: True if argument is supported and False if not.
     """
     if hasattr(func, "__code__"):
         return arg_name in inspect.signature(func).parameters
@@ -24,61 +24,63 @@ def supports_argument(func: Callable, arg_name: str) -> bool:
     return False
 
 
-def nested_set(target: dict, value: Any, *path: str, create_missing=True) -> Dict[str, Any]:
+def nested_set(
+    target: Dict[str, Any], value: Any, *path: str, create_missing: bool = True
+) -> Dict[str, Any]:
     """Set the key by its path to the value
 
-    ### Args:
-        * target (`dict`): Dictionary to perform modifications on
-        * value (`Any`): Any data
-        * *path (`str`): Path to the key of the target
-        * create_missing (`bool`, *optional*): Create keys on the way if they're missing. Defaults to `True`
+    Args:
+        target (Dict[str, Any]): Dictionary to perform the modification on.
+        value (Any): New value.
+        *path (str): Path to the key.
+        create_missing (:obj:`bool`, optional): Create keys on the way if they're missing. Defaults to True.
 
-    ### Raises:
-        * `KeyError`: Key is not found under path provided
+    Raises:
+        KeyError: Key is not found under the provided path.
 
-    ### Returns:
-        * `Dict[str, Any]`: Changed dictionary
+    Returns:
+        Dict[str, Any]: Modified dictionary.
     """
-    d = target
+    target_copy: Dict[str, Any] = target
 
     for key in path[:-1]:
-        if key in d:
-            d = d[key]
+        if key in target_copy:
+            target_copy = target_copy[key]
         elif create_missing:
-            d = d.setdefault(key, {})
+            target_copy = target_copy.setdefault(key, {})
         else:
             raise KeyError(
                 f"Key '{key}' is not found under path provided ({path}) and create_missing is False"
             )
 
-    if path[-1] in d or create_missing:
-        d[path[-1]] = value
+    if path[-1] in target_copy or create_missing:
+        target_copy[path[-1]] = value
 
     return target
 
 
-def nested_delete(target: dict, *path: str) -> Dict[str, Any]:
-    """Delete the key by its path
+def nested_delete(target: Dict[str, Any], *path: str) -> Dict[str, Any]:
+    """Delete the key by its path.
 
-    ### Args:
-        * target (`dict`): Dictionary to perform modifications on
+    Args:
+        target (Dict[str, Any]): Dictionary to perform the modification on.
 
-    ### Raises:
-        * `KeyError`: Key is not found under path provided
+    Raises:
+        KeyError: Key is not found under the provided path.
 
-    ### Returns:
-        `Dict[str, Any]`: Changed dictionary
+    Returns:
+        Dict[str, Any]: Modified dictionary.
     """
-    d = target
+    target_copy: Dict[str, Any] = target
 
     for key in path[:-1]:
-        if key in d:
-            d = d[key]
+        if key in target_copy:
+            target_copy = target_copy[key]
         else:
             raise KeyError(f"Key '{key}' is not found under path provided ({path})")
 
-    if path[-1] in d:
-        del d[path[-1]]
+    if path[-1] in target_copy:
+        del target_copy[path[-1]]
     else:
         raise KeyError(f"Key '{path[-1]}' is not found under path provided ({path})")
 

tests/config.json

@@ -2,5 +2,14 @@
     "locale": "en",
     "bot": {
         "bot_token": "sample_token"
+    },
+    "cache": {
+        "type": "memcached",
+        "memcached": {
+            "uri": "127.0.0.1:11211"
+        },
+        "redis": {
+            "uri": "redis://127.0.0.1:6379/0"
+        }
     }
 }

tests/test_cache.py

@@ -0,0 +1,28 @@
+from pathlib import Path
+
+from libbot.cache.classes import Cache
+from libbot.cache.manager import create_cache_client
+
+try:
+    from ujson import JSONDecodeError, dumps, loads
+except ImportError:
+    from json import JSONDecodeError, dumps, loads
+
+from typing import Any, Dict
+
+import pytest
+
+
+@pytest.mark.parametrize(
+    "engine",
+    [
+        "memcached",
+        "redis",
+    ],
+)
+def test_cache_creation(engine: str, location_config: Path):
+    with open(location_config, "r", encoding="utf-8") as file:
+        config: Dict[str, Any] = loads(file.read())
+
+    cache: Cache = create_cache_client(config, engine)
+    assert isinstance(cache, Cache)

tox.ini

@@ -10,13 +10,14 @@ python =
     3.13: py313
 
 [testenv]
-setenv = 
+setenv =
     PYTHONPATH = {toxinidir}
-deps = 
+deps =
     -r{toxinidir}/requirements/_.txt
     -r{toxinidir}/requirements/dev.txt
     -r{toxinidir}/requirements/pycord.txt
     -r{toxinidir}/requirements/pyrogram.txt
     -r{toxinidir}/requirements/speed.txt
+    -r{toxinidir}/requirements/cache.txt
 commands =
     pytest --basetemp={envtmpdir} --cov=libbot