Merge pull request 'Update dependency pytest-cov to v6.3.0' (#248) from renovate/pytest-cov-6.x into dev

Reviewed-on: #248

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.15.0

requirements/cache.txt

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

requirements/dev.txt

@@ -1,12 +1,12 @@
 black==25.1.0
-build==1.2.2.post1
+build==1.3.0
 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
-twine==6.1.0
-types-aiofiles==24.1.0.20241221
-types-ujson==5.10.0.20240515
+mypy==1.17.1
+pylint==3.3.8
+pytest-asyncio==1.1.0
+pytest-cov==6.3.0
+pytest==8.4.2
+tox==4.30.2
+twine==6.2.0
+types-aiofiles==24.1.0.20250822
+types-ujson==5.10.0.20250822

requirements/speed.txt

@@ -1 +1 @@
-ujson~=5.10.0
+ujson~=5.11.0

src/libbot/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "4.1.0"
+__version__ = "4.4.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, 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))
+        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)
 
@@ -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, 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"]))
+        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)
 
@@ -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,7 +6,20 @@ 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}'")
 
@@ -17,8 +30,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, default_ttl_seconds=default_ttl_seconds)
         case "redis":
-            return CacheRedis.from_config(config["cache"][engine])
+            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/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 (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"`
+    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")
-    ```
+
+        >>> 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 (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"`
+    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")
-    ```
+
+        >>> 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 (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"`
+    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 (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"`
+    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 (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"`
+    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 (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"`
+    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

@@ -4,14 +4,14 @@ from typing import Callable
 
 
 def supports_argument(func: Callable[..., Any], arg_name: str) -> bool:
-    """Check whether a function has a specific argument
+    """Check whether a function has a specific argument.
 
-    ### Args:
-        * func (`Callable[..., Any]`): 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
@@ -29,17 +29,17 @@ def nested_set(
 ) -> Dict[str, Any]:
     """Set the key by its path to the value
 
-    ### Args:
-        * 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`
+    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.
     """
     target_copy: Dict[str, Any] = target
 
@@ -60,16 +60,16 @@ def nested_set(
 
 
 def nested_delete(target: Dict[str, Any], *path: str) -> Dict[str, Any]:
-    """Delete the key by its path
+    """Delete the key by its path.
 
-    ### Args:
-        * target (`Dict[str, Any]`): 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.
     """
     target_copy: Dict[str, Any] = target