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

Reviewed-on: #224

docs/Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -1,61 +0,0 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-import os
-import sys
-from datetime import datetime
-from typing import List, Dict, Any
-
-import libbot
-
-sys.path.insert(0, os.path.abspath(".."))
-
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
-project: str = "LibBotUniversal"
-author: str = libbot.__author__
-version: str = libbot.__version__
-release: str = version
-copyright: str = f"{datetime.now().year} {author}"
-
-html_title: str = f"{project} v{version} Documentation"
-
-
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-extensions: List[str] = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.autosummary",
-    "sphinx.ext.viewcode",
-    "sphinx.ext.viewcode",
-    "sphinx.ext.napoleon",
-    "sphinx_copybutton",
-]
-
-templates_path: List[str] = ["_templates"]
-exclude_patterns: List[str] = ["_build", "Thumbs.db", ".DS_Store"]
-
-
-# -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
-html_theme: str = "furo"
-html_static_path: List[str] = ["_static"]
-
-html_theme_options: Dict[str, Any] = {
-    "source_repository": "https://git.end-play.xyz/profitroll/LibBotUniversal",
-    "source_branch": "main",
-    "source_directory": "docs/",
-    "light_css_variables": {
-        "font-stack": "'Outfit', sans-serif",
-    },
-}
-
-resource_links: Dict[str, Any] = {
-    "issues": "https://git.end-play.xyz/profitroll/LibBotUniversal/issues",
-    "examples": "https://git.end-play.xyz/profitroll/LibBotUniversal/tree/main/examples",
-}

docs/index.rst

@@ -1,29 +0,0 @@
-Welcome to LibBotUniversal
-=============================
-
-LibBotUniversal (AKA libbot) simplifies development and maintenance of different chatbots.
-
-Getting started
-*****************************
-
-There are a few pages to take a look at if you're just getting started.
-
-* Installing the library
-* Creating your first bot
-* Examples of different bots
-
-Getting help
-*****************************
-
-If you are looking for help or want to report a bug, we got you covered.
-
-* Bug reports are being submitted on the repo's issue tracker.
-
-Package
-*****************************
-
-.. toctree::
-   :maxdepth: 1
-   :caption: API reference
-
-   modules

docs/make.bat

@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.https://www.sphinx-doc.org/
-	exit /b 1
-)
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd

docs/modules.rst

@@ -1,7 +0,0 @@
-libbot
-======
-
-.. toctree::
-   :maxdepth: 5
-
-   libbot

pyproject.toml

@@ -28,7 +28,6 @@ dependencies = { file = "requirements/_.txt" }
 
 [tool.setuptools.dynamic.optional-dependencies]
 dev = { file = "requirements/dev.txt" }
-docs = { file = "requirements/docs.txt" }
 pycord = { file = "requirements/pycord.txt" }
 pyrogram = { file = "requirements/pyrogram.txt" }
 speed = { file = "requirements/speed.txt" }

requirements/docs.txt

@@ -1,3 +0,0 @@
-furo==2024.8.6
-sphinx==8.1.3
-sphinx_copybutton==0.5.2

src/libbot/__init__.py

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

src/libbot/cache/classes/cache_memcached.py

@@ -29,7 +29,7 @@ class CacheMemcached(Cache):
                 "Cache configuration is invalid. Please check if all keys are set (engine: memcached)"
             )
 
-        return cls(Client(engine_config["uri"], default_noreply=True, default_ttl_seconds=default_ttl_seconds), prefix=prefix)
+        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}"

src/libbot/errors/config.py

@@ -4,8 +4,8 @@ from typing import Any, List, Optional
 class ConfigKeyError(Exception):
     """Raised when config key is not found.
 
-    Args:
+    ### Attributes:
-        key (str | List[str]): Missing config key
+        * key (`str | List[str]`): Missing config key.
     """
 
     def __init__(self, key: str | List[str]) -> None:
@@ -21,9 +21,9 @@ class ConfigKeyError(Exception):
 class ConfigValueError(Exception):
     """Raised when config key's value is invalid.
 
-    Args:
+    ### Attributes:
-        key (str | List[str]): Invalid config key
+        * key (`str | List[str]`): Invalid config key.
-        value (Optional[Any]): Key's correct value
+        * value (`Optional[Any]`): Key's correct value.
     """
 
     def __init__(self, key: str | List[str], value: Optional[Any] = None) -> None:

src/libbot/i18n/_functions.py

@@ -18,16 +18,16 @@ def _(
     locale: str | None = "en",
     locales_root: str | Path = Path("locale"),
 ) -> Any:
-    """Get value of the locale string.
+    """Get value of locale string.
 
     Args:
-        key (str): The last key of the locale's keys path
+        key (str): The last key of the locale's keys path.
-        *args (str): Path to key like: `dict[args][key]`
+        *args (str): Path to key like: `dict[args][key]`.
-        locale (str | None): Locale to be looked up in. Defaults to `"en"`
+        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")`
+        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]`
+        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 the locale string.
+    """Get value of locale string.
 
     Args:
-        key (str): The last key of the locale's keys path
+        key (str): The last key of the locale's keys path.
-        *args (str): Path to key like: `dict[args][key]`
+        *args (str): Path to key like: `dict[args][key]`.
-        locale (str | None): Locale to be looked up in. Defaults to `"en"`
+        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")`
+        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]`
+        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
 
@@ -97,13 +97,14 @@ def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("locale
     """Get value of the provided key and path in all available locales.
 
     Args:
-        key (str): The last key of the locale's keys path
+        key (str): The last key of the locale's keys path.
-        *args (str): Path to key like: `dict[args][key]`
+        *args (str): Path to key like: `dict[args][key]`.
-        locales_root (str | Path, optional): Folder where locales are located. Defaults to `Path("locale")`
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to `Path("locale")`.
 
     Returns:
-        List[Any]: List of values in all locales
+        List[Any]: List of values in all locales.
     """
+
     output: List[Any] = []
 
     for locale in _get_valid_locales(locales_root):
@@ -130,12 +131,12 @@ async def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("
     """Get value of the provided key and path in all available locales.
 
     Args:
-        key (str): The last key of the locale's keys path
+        key (str): The last key of the locale's keys path.
-        *args (str): Path to key like: `dict[args][key]`
+        *args (str): Path to key like: `dict[args][key]`.
-        locales_root (str | Path, optional): Folder where locales are located. Defaults to `Path("locale")`
+        locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
 
     Returns:
-        List[Any]: List of values in all locales
+        List[Any]: List of values in all locales.
     """
 
     output: List[Any] = []
@@ -160,17 +161,20 @@ async def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("
 
 
 @asyncable
-def in_every_locale(key: str, *args: str, locales_root: str | Path = Path("locale")) -> Dict[str, Any]:
+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.
 
     Args:
-        key (str): The last key of the locale's keys path
+        key (str): The last key of the locale's keys path.
-        *args (str): Path to key like: `dict[args][key]`
+        *args (str): Path to key like: `dict[args][key]`.
-        locales_root (str | Path, optional): Folder where locales are located. Defaults to `Path("locale")`
+        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
+        Dict[str, Any]: Locale is a key, and it's value from locale file is a value.
     """
+
     output: Dict[str, Any] = {}
 
     for locale in _get_valid_locales(locales_root):
@@ -199,12 +203,12 @@ async def in_every_locale(
     """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
+        key (str): The last key of the locale's keys path.
-        *args (str): Path to key like: `dict[args][key]`
+        *args (str): Path to key like: `dict[args][key]`.
-        locales_root (str | Path, optional): Folder where locales are located. Defaults to `Path("locale")`
+        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
+        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

@@ -16,8 +16,8 @@ class BotLocale:
     ) -> None:
         """
         Args:
-            default_locale (str | None): Default bot's locale. Defaults to `"en"`
+            default_locale (str | None, optional): Default locale. Defaults to "en".
-            locales_root (str | Path): Folder where locales are located. Defaults to `Path("locale")`
+            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)
@@ -38,12 +38,12 @@ class BotLocale:
         """Get value of locale string.
 
         Args:
-            key (str): The last key of the locale's keys path
+            key (str): The last key of the locale's keys path.
-            *args (str): Path to key like: `dict[args][key]`
+            *args (str): Path to key like: `dict[args][key]`.
-            locale (str | None, optional): Locale to be looked up in. Defaults to config's `"locale"` value
+            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]`
+            Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`.
         """
         if locale is None:
             locale: str = self.default
@@ -72,11 +72,11 @@ class BotLocale:
         """Get value of the provided key and path in all available locales.
 
         Args:
-            key (str): The last key of the locale's keys path
+            key (str): The last key of the locale's keys path.
-            *args (str): Path to key like: `dict[args][key]`
+            *args (str): Path to key like: `dict[args][key]`.
 
         Returns:
-            List[Any]: List of values in all locales
+            List[Any]: List of values in all locales.
         """
         output: List[Any] = []
 
@@ -102,11 +102,11 @@ class BotLocale:
         """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
+            key (str): The last key of the locale's keys path.
-            *args (str): Path to key like: `dict[args][key]`
+            *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
+            Dict[str, Any]: Locale is a key, and it's value from locale file is a value.
         """
         output: Dict[str, Any] = {}
 

src/libbot/pycord/classes/bot.py

@@ -19,7 +19,6 @@ logger: Logger = logging.getLogger(__name__)
 
 
 class PycordBot(Bot):
-    # TODO Write a docstring
     @override
     def __init__(
             self,
@@ -30,16 +29,6 @@ class PycordBot(Bot):
             scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
             **kwargs,
     ):
-        """
-
-        Args:
-            *args:
-            config:
-            config_path:
-            locales_root:
-            scheduler:
-            **kwargs:
-        """
         self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
 
         super().__init__(
@@ -62,30 +51,15 @@ class PycordBot(Bot):
 
         self.scheduler: AsyncIOScheduler | BackgroundScheduler | None = scheduler
 
-    # TODO Write a docstring
     @override
     async def start(self, token: str, reconnect: bool = True, scheduler_start: bool = True) -> None:
-        """
-
-        Args:
-            token:
-            reconnect:
-            scheduler_start:
-        """
         if self.scheduler is not None and scheduler_start:
             self.scheduler.start()
 
         await super().start(token, reconnect=reconnect)
 
-    # TODO Write a docstring
     @override
     async def close(self, scheduler_shutdown: bool = True, scheduler_wait: bool = True) -> None:
-        """
-
-        Args:
-            scheduler_shutdown:
-            scheduler_wait:
-        """
         if self.scheduler is not None and scheduler_shutdown:
             self.scheduler.shutdown(scheduler_wait)
 

src/libbot/pycord/utils/color.py

@@ -16,24 +16,20 @@ def _hex_from_int(color_int: int) -> str:
 
 
 def color_from_hex(hex_string: str) -> Colour:
-    """Convert valid hexadecimal string to :class:`discord.Colour`.
+    """Convert valid hexadecimal string to discord.Colour.
 
-    Args:
+    :param hex_string: Hexadecimal string to convert into Colour object
-        hex_string (str): Hexadecimal string to convert into :class:`discord.Colour` object
+    :type hex_string: str
-
+    :return: Colour object
-    Returns:
-        Colour: :class:`discord.Colour` object
     """
     return Colour(_int_from_hex(hex_string))
 
 
 def hex_from_color(color: Colour) -> str:
-    """Convert :class:`discord.Colour` to hexadecimal string.
+    """Convert discord.Colour to hexadecimal string.
 
-    Args:
+    :param color: Colour object to convert into the string
-        color (Colour): :class:`discord.Colour` object to convert into the string
+    :type color: Colour
-
+    :return: Hexadecimal string in #XXXXXX format
-    Returns:
-        str: Hexadecimal string in #XXXXXX format
     """
     return _hex_from_int(color.value)

src/libbot/pyrogram/classes/client.py

@@ -6,7 +6,7 @@ from logging import Logger
 from os import cpu_count, getpid
 from pathlib import Path
 from time import time
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List
 
 from typing_extensions import override
 
@@ -46,7 +46,6 @@ logger: Logger = logging.getLogger(__name__)
 
 
 class PyroClient(Client):
-    # TODO Write a docstring
     @override
     def __init__(
             self,
@@ -120,12 +119,6 @@ class PyroClient(Client):
 
     @override
     async def start(self, register_commands: bool = True, scheduler_start: bool = True) -> None:
-        """Start the bot and it's services.
-
-        Args:
-            register_commands (bool, optional): Register commands on start. Defaults to `True`
-            scheduler_start (bool, optional): Start the scheduler on start. Defaults to `True`
-        """
         await super().start()
 
         self.start_time = time()
@@ -218,13 +211,6 @@ class PyroClient(Client):
     async def stop(
             self, exit_completely: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
     ) -> None:
-        """Stop the bot and it's services.
-
-        Args:
-            exit_completely (bool, optional): Exit the program. Defaults to `True`
-            scheduler_shutdown (bool): Shutdown the scheduler. Defaults to `True`
-            scheduler_wait (bool): Wait for tasks to finish. Defaults to `True`
-        """
         try:
             await self.send_message(
                 chat_id=(
@@ -251,10 +237,10 @@ class PyroClient(Client):
                 raise SystemExit("Bot has been shut down, this is not an application error!") from exc
 
     async def collect_commands(self) -> List[CommandSet] | None:
-        """Gather list of the bot's commands.
+        """Gather list of the bot's commands
 
-        Returns:
+        ### Returns:
-            List[CommandSet]: List of the commands' sets
+            * `List[CommandSet]`: List of the commands' sets.
         """
         command_sets = None
 
@@ -336,10 +322,10 @@ class PyroClient(Client):
             self,
             command: str,
     ) -> None:
-        """Add command to the bot's internal commands list.
+        """Add command to the bot's internal commands list
 
-        Args:
+        ### Args:
-            command (str): Command's name
+            * command (`str`)
         """
         self.commands.append(
             PyroCommand(
@@ -352,12 +338,9 @@ class PyroClient(Client):
             command,
         )
 
-    async def register_commands(self, command_sets: Optional[List[CommandSet]] = None) -> None:
+    async def register_commands(self, command_sets: List[CommandSet] | None = None) -> None:
-        """Register commands stored in bot's 'commands' attribute.
+        """Register commands stored in bot's 'commands' attribute"""
 
-        Args:
-            command_sets (List[CommandSet], optional): List of command sets. Commands will be parsed from bot's 'commands' attribute if not provided
-        """
         if command_sets is None:
             commands = [
                 BotCommand(command=command.command, description=command.description)
@@ -382,12 +365,9 @@ class PyroClient(Client):
                 language_code=command_set.language_code,
             )
 
-    async def remove_commands(self, command_sets: Optional[List[CommandSet]] = None) -> None:
+    async def remove_commands(self, command_sets: List[CommandSet] | None = None) -> None:
-        """Remove commands stored in bot's 'commands' attribute.
+        """Remove commands stored in bot's 'commands' attribute"""
 
-        Args:
-            command_sets (List[CommandSet], optional): List of command sets. Commands with scope :class:`pyrogram.types.BotCommandScopeDefault` will be removed if not provided
-        """
         if command_sets is None:
             logger.info("Removing commands with a default scope 'BotCommandScopeDefault'")
             await self.delete_bot_commands(BotCommandScopeDefault())