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

Reviewed-on: #220

.gitea/workflows/analysis.yml

@@ -11,14 +11,13 @@ on:
 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

@@ -0,0 +1,67 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [ published ]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    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-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-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:
+          password: ${{ secrets.PYPI_PYPI_API_TOKEN }}

.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.9", "3.10", "3.11", "3.12"]
-
+        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.
@@ -36,19 +37,20 @@ pip install libbot[pycord,speed]
 ### Pyrogram
 
 ```python
-from libbot.pyrogram import PyroClient
+import sys
+
+from libbot.pyrogram.classes import PyroClient
+
 
 def main():
-    client = PyroClient(scheduler=scheduler)
+    client: PyroClient = PyroClient()
 
     try:
         client.run()
     except KeyboardInterrupt:
         print("Shutting down...")
     finally:
-        if client.scheduler is not None:
-            client.scheduler.shutdown()
-        exit()
+        sys.exit()
 
 
 if __name__ == "__main__":
@@ -58,29 +60,33 @@ if __name__ == "__main__":
 ### Pycord
 
 ```python
+import asyncio
+from asyncio import AbstractEventLoop
+
 from discord import Intents
-from libbot import sync
-from libbot.pycord import PycordBot
+from libbot.utils import config_get
+from libbot.pycord.classes import PycordBot
 
 
 async def main():
-    intents = Intents.default()
-    bot = PycordBot(intents=intents)
+    intents: Intents = Intents.default()
+    bot: PycordBot = PycordBot(intents=intents)
 
     bot.load_extension("cogs")
 
     try:
-        await bot.start(sync.config_get("bot_token", "bot"))
+        await bot.start(config_get("bot_token", "bot"))
     except KeyboardInterrupt:
-        logger.warning("Shutting down...")
+        print("Shutting down...")
         await bot.close()
 
 
 if __name__ == "__main__":
-    loop = asyncio.get_event_loop()
+    loop: AbstractEventLoop = asyncio.get_event_loop()
     loop.run_until_complete(main())
 ```
 
 ## Config examples
 
-For bot config examples please check the examples directory. Without a valid config file, the bot won't start at all, so you need to make sure the correct config file is used.
+For bot config examples please check the examples directory. Without a valid config file, the bot won't start at all, so
+you need to make sure the correct config file is used.

examples/README.md

@@ -0,0 +1,4 @@
+# Examples
+
+If you're looking for Pyrogram usage examples, please take a look at
+the [PyrogramBotBase](https://git.end-play.xyz/profitroll/PyrogramBotBase) repository.

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 +1,2 @@
 aiofiles>=23.0.0
+typing-extensions~=4.14.0

requirements/cache.txt

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

requirements/dev.txt

@@ -1,11 +1,12 @@
-black==24.10.0
+black==25.1.0
 build==1.2.2.post1
 isort==5.13.2
-mypy==1.14.0
-pylint==3.3.3
-pytest-asyncio==0.25.0
-pytest-cov==6.0.0
-pytest==8.3.4
-tox==4.23.2
-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.20250606
+types-ujson==5.10.0.20250326

src/libbot/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "4.0.0"
+__version__ = "4.3.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) -> "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)
+
+    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) -> 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)
+
+    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,25 @@
+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,
+) -> 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}'")
+
+    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)
+        case "redis":
+            return CacheRedis.from_config(config["cache"][engine], prefix=prefix)
+        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/pycord/__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/pycord/classes/bot.py

@@ -1,9 +1,13 @@
 import logging
+from logging import Logger
 from pathlib import Path
 from typing import Any, Dict
 
 from typing_extensions import override
 
+from ...i18n.classes import BotLocale
+from ...utils import json_read
+
 try:
     from apscheduler.schedulers.asyncio import AsyncIOScheduler
     from apscheduler.schedulers.background import BackgroundScheduler
@@ -11,14 +15,7 @@ try:
 except ImportError as exc:
     raise ImportError("You need to install libbot[pycord] in order to use this class.") from exc
 
-try:
-    from ujson import loads
-except ImportError:
-    from json import loads
-
-from ...i18n.classes import BotLocale
-
-logger = logging.getLogger(__name__)
+logger: Logger = logging.getLogger(__name__)
 
 
 class PycordBot(Bot):
@@ -32,11 +29,7 @@ class PycordBot(Bot):
             scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
             **kwargs,
     ):
-        if config is None:
-            with open(config_path, "r", encoding="utf-8") as f:
-                self.config: dict = loads(f.read())
-        else:
-            self.config = config
+        self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
 
         super().__init__(
             debug_guilds=(self.config["bot"]["debug_guilds"] if self.config["debug"] else None),

src/libbot/pycord/utils/__init__.py

@@ -0,0 +1 @@
+from .color import color_from_hex, hex_from_color

src/libbot/pycord/utils/color.py

@@ -0,0 +1,35 @@
+from discord import Colour
+
+
+def _int_from_hex(hex_string: str) -> int:
+    try:
+        return int(hex_string, base=16)
+    except Exception as exc:
+        raise ValueError("Input string must be a valid HEX code.") from exc
+
+
+def _hex_from_int(color_int: int) -> str:
+    if not 0 <= color_int <= 0xFFFFFF:
+        raise ValueError("Color's value must be in the range 0 to 0xFFFFFF.")
+
+    return f"#{color_int:06x}"
+
+
+def color_from_hex(hex_string: str) -> Colour:
+    """Convert valid hexadecimal string to discord.Colour.
+
+    :param hex_string: Hexadecimal string to convert into Colour object
+    :type hex_string: str
+    :return: Colour object
+    """
+    return Colour(_int_from_hex(hex_string))
+
+
+def hex_from_color(color: Colour) -> str:
+    """Convert discord.Colour to hexadecimal string.
+
+    :param color: Colour object to convert into the string
+    :type color: Colour
+    :return: Hexadecimal string in #XXXXXX format
+    """
+    return _hex_from_int(color.value)

src/libbot/pyrogram/__init__.py

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

src/libbot/pyrogram/classes/client.py

@@ -2,6 +2,7 @@ import asyncio
 import logging
 import sys
 from datetime import datetime, timedelta
+from logging import Logger
 from os import cpu_count, getpid
 from pathlib import Path
 from time import time
@@ -9,6 +10,12 @@ from typing import Any, Dict, List
 
 from typing_extensions import override
 
+from .command import PyroCommand
+from .commandset import CommandSet
+from ...i18n import _
+from ...i18n.classes import BotLocale
+from ...utils import json_read
+
 try:
     import pyrogram
     from apscheduler.schedulers.asyncio import AsyncIOScheduler
@@ -35,12 +42,7 @@ try:
 except ImportError:
     from json import dumps, loads
 
-from ...i18n.classes import BotLocale
-from ...i18n import _
-from .command import PyroCommand
-from .commandset import CommandSet
-
-logger = logging.getLogger(__name__)
+logger: Logger = logging.getLogger(__name__)
 
 
 class PyroClient(Client):
@@ -66,11 +68,7 @@ class PyroClient(Client):
             scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
             **kwargs,
     ):
-        if config is None:
-            with open(config_path, "r", encoding="utf-8") as f:
-                self.config: dict = loads(f.read())
-        else:
-            self.config = config
+        self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
 
         super().__init__(
             name=name,

src/libbot/utils/config/_functions.py

@@ -20,7 +20,7 @@ def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LO
 
     ### Args:
         * key (`str`): Key that contains the value
-        * *path (`str`): Path to the 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:
@@ -59,7 +59,7 @@ async def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CON
 
     ### Args:
         * key (`str`): Key that contains the value
-        * *path (`str`): Path to the 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:
@@ -98,7 +98,7 @@ def config_set(key: str, value: Any, *path: str, config_file: str | Path = DEFAU
     ### Args:
         * key (`str`): Key that leads to the value
         * value (`Any`): Any JSON serializable data
-        * *path (`str`): Path to the key of the target
+        * *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:
@@ -116,7 +116,7 @@ async def config_set(
     ### Args:
         * key (`str`): Key that leads to the value
         * value (`Any`): Any JSON serializable data
-        * *path (`str`): Path to the key of the target
+        * *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:
@@ -136,7 +136,7 @@ def config_delete(
 
     ### Args:
         * key (`str`): Key to delete
-        * *path (`str`): Path to the key of the target
+        * *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"`
 
@@ -165,7 +165,7 @@ async def config_delete(
 
     ### Args:
         * key (`str`): Key to delete
-        * *path (`str`): Path to the key of the target
+        * *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"`
 

src/libbot/utils/misc/_functions.py

@@ -3,11 +3,11 @@ from typing import Any, Dict
 from typing import Callable
 
 
-def supports_argument(func: Callable, arg_name: str) -> bool:
+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
+        * func (`Callable[..., Any]`): Function to be inspected
         * arg_name (`str`): Argument to be checked
 
     ### Returns:
@@ -24,11 +24,13 @@ 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
+        * target (`Dict[str, Any]`): 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`
@@ -39,29 +41,29 @@ def nested_set(target: dict, value: Any, *path: str, create_missing=True) -> Dic
     ### Returns:
         * `Dict[str, Any]`: Changed 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]:
+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
+        * target (`Dict[str, Any]`): Dictionary to perform modifications on
 
     ### Raises:
         * `KeyError`: Key is not found under path provided
@@ -69,16 +71,16 @@ def nested_delete(target: dict, *path: str) -> Dict[str, Any]:
     ### Returns:
         `Dict[str, Any]`: Changed 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

@@ -18,5 +18,6 @@ deps =
     -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