Merge pull request 'Update to 3.0.1' (#98) from dev into main

Reviewed-on: #98

.gitea/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+    tags-ignore:
+      - v*
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    container: catthehacker/ubuntu:act-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+        env:
+          AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox tox-gh-actions
+      - name: Test with tox
+        run: tox

.renovaterc

@@ -3,6 +3,15 @@
     "extends": [
         "config:base"
     ],
+    "baseBranches": [
+        "dev"
+    ],
+    "pip_requirements": {
+        "fileMatch": [
+            "requirements/.*\\.txt$"
+        ],
+        "enabled": true
+    },
     "packageRules": [
         {
             "matchUpdateTypes": [

examples/commands.json

@@ -0,0 +1,21 @@
+{
+    "help": {
+        "scopes": [
+            {
+                "name": "BotCommandScopeDefault"
+            },
+            {
+                "name": "BotCommandScopeChat",
+                "chat_id": "owner"
+            }
+        ]
+    },
+    "shutdown": {
+        "scopes": [
+            {
+                "name": "BotCommandScopeChat",
+                "chat_id": "owner"
+            }
+        ]
+    }
+}

examples/config.json

@@ -0,0 +1,38 @@
+{
+    "locale": "en",
+    "bot": {
+        "owner": 0,
+        "api_id": 0,
+        "api_hash": "",
+        "bot_token": "",
+        "workers": 1,
+        "max_concurrent_transmissions": 1,
+        "scoped_commands": true
+    },
+    "reports": {
+        "chat_id": "owner"
+    },
+    "disabled_plugins": [],
+    "commands": {
+        "help": {
+            "scopes": [
+                {
+                    "name": "BotCommandScopeDefault"
+                },
+                {
+                    "name": "BotCommandScopeChat",
+                    "chat_id": "owner"
+                }
+            ]
+        },
+        "shutdown": {
+            "scopes": [
+                {
+                    "name": "BotCommandScopeChat",
+                    "chat_id": "owner"
+                }
+            ]
+        }
+    }
+}
+

examples/locale.json

@@ -0,0 +1,23 @@
+{
+    "metadata": {
+        "flag": "🇬🇧",
+        "name": "English",
+        "codes": [
+            "en"
+        ]
+    },
+    "bot": {
+        "name": "Your Bot",
+        "about": "I'm a your bot. Nice to meet you!",
+        "description": "I'm just your bot. Yet nice to meet you!"
+    },
+    "commands": {
+        "help": "Show help message"
+    },
+    "messages": {
+        "help": "Sample Text"
+    },
+    "callbacks": {
+        "sample": "This button is working!"
+    }
+}

libbot/__init__.py

@@ -1,9 +0,0 @@
-__name__ = "libbot"
-__version__ = "1.9"
-__license__ = "GPL3"
-__author__ = "Profitroll"
-
-from .__main__ import *
-from . import sync
-from . import i18n
-from . import pyrogram

pyproject.toml

@@ -1,15 +1,15 @@
 [build-system]
-requires = ["setuptools>=62.6,<66"]
+requires = ["setuptools>=62.6", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "libbot"
-version = "1.9"
+dynamic = ["version", "dependencies", "optional-dependencies"]
 authors = [{ name = "Profitroll" }]
 description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
 readme = "README.md"
 requires-python = ">=3.8"
-license = { text = "GPL3" }
+license = { file = "LICENSE" }
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
@@ -22,33 +22,46 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Utilities",
 ]
-dependencies = ["aiofiles~=23.1.0"]
 
-[project.optional-dependencies]
+[tool.setuptools.dynamic]
-pycord = ["py-cord~=2.4.1"]
+version = { attr = "libbot.__version__" }
-pyrogram = ["pyrogram~=2.0.106", "apscheduler~=3.10.1"]
+dependencies = { file = "requirements/_.txt" }
-speed = ["ujson~=5.8.0"]
+
+[tool.setuptools.dynamic.optional-dependencies]
+dev = { file = "requirements/dev.txt" }
+pycord = { file = "requirements/pycord.txt" }
+pyrogram = { file = "requirements/pyrogram.txt" }
+speed = { file = "requirements/speed.txt" }
 
 [project.urls]
 Source = "https://git.end-play.xyz/profitroll/LibBotUniversal"
 Documentation = "https://git.end-play.xyz/profitroll/LibBotUniversal/wiki"
 Tracker = "https://git.end-play.xyz/profitroll/LibBotUniversal/issues"
 
-[tool.setuptools]
+[tool.setuptools.packages.find]
-packages = [
+where = ["src"]
-    "libbot",
-    "libbot.sync",
-    "libbot.pyrogram",
-    "libbot.pyrogram.classes",
-    "libbot.i18n",
-    "libbot.i18n.sync",
-    "libbot.i18n.classes",
-]
-
-[tool.setuptools_scm]
 
 [tool.black]
 target-version = ['py38', 'py39', 'py310', 'py311']
 
 [tool.isort]
 profile = "black"
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+python_files = ["test_*.py"]
+pythonpath = "."
+testpaths = ["tests"]
+
+[tool.mypy]
+namespace_packages = true
+install_types = true
+strict = true
+show_error_codes = true
+
+[tool.pylint.main]
+extension-pkg-whitelist = ["ujson"]
+py-version = 3.8
+
+[tool.coverage.run]
+source = ["libbot"]

requirements/_.txt

@@ -0,0 +1 @@
+aiofiles>=23.0.0

requirements/dev.txt

@@ -0,0 +1,11 @@
+black==24.4.2
+build==1.2.1
+isort==5.13.2
+mypy==1.10.0
+pylint==3.2.0
+pytest-asyncio==0.23.6
+pytest-cov==5.0.0
+pytest==8.2.0
+tox==4.15.0
+types-aiofiles==23.2.0.20240403
+types-ujson==5.9.0.0

requirements/pycord.txt

@@ -0,0 +1,2 @@
+apscheduler~=3.10.4
+py-cord~=2.5.0

requirements/pyrogram.txt

@@ -0,0 +1,2 @@
+apscheduler~=3.10.4
+pyrofork~=2.3.21.post3

requirements/speed.txt

@@ -0,0 +1 @@
+ujson~=5.10.0

setup.cfg

@@ -1,3 +0,0 @@
-[metadata]
-description_file=README.md
-license_files=LICENSE

setup.py

@@ -1,4 +0,0 @@
-from setuptools import setup
-
-if __name__ == "__main__":
-    setup()

src/libbot/__init__.py

@@ -0,0 +1,6 @@
+__version__ = "3.0.1"
+__license__ = "GPL3"
+__author__ = "Profitroll"
+
+from . import i18n, pycord, pyrogram, sync
+from .__main__ import *

src/libbot/__main__.py

@@ -35,6 +35,8 @@ async def json_write(data: Any, path: Union[str, Path]) -> None:
     async with aiofiles.open(str(path), mode="w", encoding="utf-8") as f:
         await f.write(
             dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
+            if hasattr(dumps, "escape_forward_slashes")
+            else dumps(data, ensure_ascii=False, indent=4)
         )
 
 

src/libbot/i18n/__init__.py

@@ -2,14 +2,15 @@ from os import listdir
 from pathlib import Path
 from typing import Any, Dict, Union
 
-from libbot import config_get, json_read, sync
+import libbot
+from libbot.i18n import sync
 from libbot.i18n.classes.bot_locale import BotLocale
 
 
 async def _(
     key: str,
     *args: str,
-    locale: str = sync.config_get("locale"),
+    locale: Union[str, None] = "en",
     locales_root: Union[str, Path] = Path("locale"),
 ) -> Any:
     """Get value of locale string
@@ -17,20 +18,20 @@ async def _(
     ### Args:
         * key (`str`): The last key of the locale's keys path.
         * *args (`list`): Path to key like: `dict[args][key]`.
-        * locale (`str`): Locale to looked up in. Defaults to config's `"locale"` value.
+        * locale (`Union[str, None]`): Locale to looked up in. Defaults to `"en"`.
         * locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
 
     ### Returns:
         * `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
     """
-    locale = sync.config_get("locale") if locale is None else locale
+    locale = libbot.sync.config_get("locale") if locale is None else locale
 
     try:
-        this_dict = await json_read(Path(f"{locales_root}/{locale}.json"))
+        this_dict = await libbot.json_read(Path(f"{locales_root}/{locale}.json"))
     except FileNotFoundError:
         try:
-            this_dict = await json_read(
+            this_dict = await libbot.json_read(
-                Path(f'{locales_root}/{await config_get("locale")}.json')
+                Path(f'{locales_root}/{await libbot.config_get("locale")}.json')
             )
         except FileNotFoundError:
             return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
@@ -65,7 +66,7 @@ async def in_all_locales(
     valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
     for lc in valid_locales:
         try:
-            this_dict = await json_read(Path(f"{locales_root}/{lc}.json"))
+            this_dict = await libbot.json_read(Path(f"{locales_root}/{lc}.json"))
         except FileNotFoundError:
             continue
 
@@ -101,7 +102,7 @@ async def in_every_locale(
     valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
     for lc in valid_locales:
         try:
-            this_dict = await json_read(Path(f"{locales_root}/{lc}.json"))
+            this_dict = await libbot.json_read(Path(f"{locales_root}/{lc}.json"))
         except FileNotFoundError:
             continue
 

src/libbot/i18n/classes/bot_locale.py

@@ -10,6 +10,7 @@ class BotLocale:
 
     def __init__(
         self,
+        default_locale: Union[str, None] = "en",
         locales_root: Union[str, Path] = Path("locale"),
     ) -> None:
         if isinstance(locales_root, str):
@@ -23,7 +24,9 @@ class BotLocale:
             ".".join(entry.split(".")[:-1]) for entry in files_locales
         ]
 
-        self.default: str = sync.config_get("locale")
+        self.default: str = (
+            sync.config_get("locale") if default_locale is None else default_locale
+        )
         self.locales: dict = {}
 
         for lc in valid_locales:

src/libbot/i18n/sync/__init__.py

@@ -2,14 +2,13 @@ from os import listdir
 from pathlib import Path
 from typing import Any, Dict, Union
 
-from libbot import sync
+import libbot
-from libbot.sync import config_get, json_read
 
 
 def _(
     key: str,
     *args: str,
-    locale: str = sync.config_get("locale"),
+    locale: Union[str, None] = "en",
     locales_root: Union[str, Path] = Path("locale"),
 ) -> Any:
     """Get value of locale string
@@ -17,20 +16,22 @@ def _(
     ### Args:
         * key (`str`): The last key of the locale's keys path.
         * *args (`list`): Path to key like: `dict[args][key]`.
-        * locale (`str`): Locale to looked up in. Defaults to config's `"locale"` value.
+        * locale (`Union[str, None]`): Locale to looked up in. Defaults to `"en"`.
         * locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
 
     ### Returns:
         * `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
     """
     if locale is None:
-        locale = sync.config_get("locale")
+        locale = libbot.sync.config_get("locale")
 
     try:
-        this_dict = json_read(Path(f"{locales_root}/{locale}.json"))
+        this_dict = libbot.sync.json_read(Path(f"{locales_root}/{locale}.json"))
     except FileNotFoundError:
         try:
-            this_dict = json_read(Path(f'{locales_root}/{config_get("locale")}.json'))
+            this_dict = libbot.sync.json_read(
+                Path(f'{locales_root}/{libbot.sync.config_get("locale")}.json')
+            )
         except FileNotFoundError:
             return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
 
@@ -64,7 +65,7 @@ def in_all_locales(
     valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
     for lc in valid_locales:
         try:
-            this_dict = json_read(Path(f"{locales_root}/{lc}.json"))
+            this_dict = libbot.sync.json_read(Path(f"{locales_root}/{lc}.json"))
         except FileNotFoundError:
             continue
 
@@ -100,7 +101,7 @@ def in_every_locale(
     valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
     for lc in valid_locales:
         try:
-            this_dict = json_read(Path(f"{locales_root}/{lc}.json"))
+            this_dict = libbot.sync.json_read(Path(f"{locales_root}/{lc}.json"))
         except FileNotFoundError:
             continue
 

src/libbot/pycord/classes/__init__.py

@@ -0,0 +1 @@
+from .bot import PycordBot

src/libbot/pycord/classes/bot.py

@@ -0,0 +1,57 @@
+import logging
+from pathlib import Path
+from typing import Any, Dict, Union
+
+try:
+    from apscheduler.schedulers.asyncio import AsyncIOScheduler
+    from apscheduler.schedulers.background import BackgroundScheduler
+    from discord import Bot
+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 libbot.i18n import BotLocale
+from libbot.i18n.sync import _
+
+logger = logging.getLogger(__name__)
+
+
+class PycordBot(Bot):
+    def __init__(
+        self,
+        config: Union[Dict[str, Any], None] = None,
+        config_path: Union[str, Path] = Path("config.json"),
+        locales_root: Union[str, Path, None] = None,
+        scheduler: Union[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
+
+        super().__init__(
+            debug_guilds=self.config["bot"]["debug_guilds"],
+            owner_ids=self.config["bot"]["owners"],
+            **kwargs,
+        )
+
+        self.bot_locale: BotLocale = BotLocale(
+            default_locale=self.config["locale"],
+            locales_root=(Path("locale") if locales_root is None else locales_root),
+        )
+        self.default_locale: str = self.bot_locale.default
+        self.locales: dict = self.bot_locale.locales
+
+        self._ = self.bot_locale._
+        self.in_all_locales = self.bot_locale.in_all_locales
+        self.in_every_locale = self.bot_locale.in_every_locale
+
+        self.scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = scheduler

src/libbot/pyrogram/classes/client.py

@@ -46,6 +46,7 @@ class PyroClient(Client):
     def __init__(
         self,
         name: str = "bot_client",
+        owner: Union[int, None] = None,
         config: Union[Dict[str, Any], None] = None,
         config_path: Union[str, Path] = Path("config.json"),
         api_id: Union[int, None] = None,
@@ -58,6 +59,8 @@ class PyroClient(Client):
         sleep_threshold: int = 120,
         max_concurrent_transmissions: int = 1,
         commands_source: Union[Dict[str, dict], None] = None,
+        scoped_commands: Union[bool, None] = None,
+        i18n_bot_info: bool = False,
         scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
         **kwargs,
     ):
@@ -93,16 +96,21 @@ class PyroClient(Client):
             else max_concurrent_transmissions,
             **kwargs,
         )
-        self.owner: int = self.config["bot"]["owner"]
+        self.owner: int = self.config["bot"]["owner"] if owner is None else owner
         self.commands: List[PyroCommand] = []
         self.commands_source: Dict[str, dict] = (
             self.config["commands"] if commands_source is None else commands_source
         )
-        self.scoped_commands: bool = self.config["bot"]["scoped_commands"]
+        self.scoped_commands: bool = (
+            self.config["bot"]["scoped_commands"]
+            if scoped_commands is None
+            else scoped_commands
+        )
         self.start_time: float = 0
 
         self.bot_locale: BotLocale = BotLocale(
-            (Path("locale") if locales_root is None else locales_root)
+            default_locale=self.config["locale"],
+            locales_root=(Path("locale") if locales_root is None else locales_root),
         )
         self.default_locale: str = self.bot_locale.default
         self.locales: dict = self.bot_locale.locales
@@ -115,7 +123,9 @@ class PyroClient(Client):
 
         self.scopes_placeholders: Dict[str, int] = {"owner": self.owner}
 
-    async def start(self, register_commands: bool = True):
+        self.i18n_bot_info: bool = i18n_bot_info
+
+    async def start(self, register_commands: bool = True) -> None:
         await super().start()
 
         self.start_time = time()
@@ -128,6 +138,55 @@ class PyroClient(Client):
             getpid(),
         )
 
+        if self.i18n_bot_info:
+            # Register default bot's info
+            try:
+                await self.set_bot_info(
+                    name=self._("name", "bot"),
+                    about=self._("about", "bot"),
+                    description=self._("description", "bot"),
+                    lang_code="",
+                )
+                logger.info(
+                    "Bot's info for the default locale %s has been updated",
+                    self.default_locale,
+                )
+            except KeyError:
+                logger.warning(
+                    "Default locale %s has incorrect keys or values in bot section",
+                    self.default_locale,
+                )
+
+            # Register bot's info for each available locale
+            for locale_code in self.locales:
+                locale = self.locales[locale_code]
+
+                if "metadata" not in locale or ("codes" not in locale["metadata"]):
+                    logger.warning(
+                        "Locale %s is missing metadata or metadata.codes key",
+                        locale_code,
+                    )
+                    continue
+
+                for code in locale["metadata"]["codes"]:
+                    try:
+                        await self.set_bot_info(
+                            name=locale["bot"]["name"],
+                            about=locale["bot"]["about"],
+                            description=locale["bot"]["description"],
+                            lang_code=code,
+                        )
+                        logger.info(
+                            "Bot's info for the locale %s has been updated",
+                            self.code,
+                        )
+                    except KeyError:
+                        logger.warning(
+                            "Locale %s has incorrect keys or values in bot section",
+                            locale_code,
+                        )
+
+        # Send a message to the bot's reports chat about the startup
         try:
             await self.send_message(
                 chat_id=self.owner
@@ -135,10 +194,13 @@ class PyroClient(Client):
                 else self.config["reports"]["chat_id"],
                 text=f"Bot started PID `{getpid()}`",
             )
+        except BadRequest:
+            logger.warning("Unable to send message to report chat.")
 
         if self.scheduler is None:
             return
 
+        # Schedule the task to register all commands
         if register_commands:
             self.scheduler.add_job(
                 self.register_commands,
@@ -148,10 +210,8 @@ class PyroClient(Client):
             )
 
         self.scheduler.start()
-        except BadRequest:
-            logger.warning("Unable to send message to report chat.")
 
-    async def stop(self, exit_completely: bool = True):
+    async def stop(self, exit_completely: bool = True) -> None:
         try:
             await self.send_message(
                 chat_id=self.owner
@@ -169,16 +229,16 @@ class PyroClient(Client):
         if exit_completely:
             try:
                 exit()
-            except SystemExit as exp:
+            except SystemExit as exc:
                 raise SystemExit(
                     "Bot has been shut down, this is not an application error!"
-                ) from exp
+                ) from exc
 
     async def collect_commands(self) -> Union[List[CommandSet], None]:
         """Gather list of the bot's commands
 
         ### Returns:
-            * `List[CommandSet]`: List of the commands' sets
+            * `List[CommandSet]`: List of the commands' sets.
         """
         command_sets = None
 
@@ -269,7 +329,7 @@ class PyroClient(Client):
     def add_command(
         self,
         command: str,
-    ):
+    ) -> None:
         """Add command to the bot's internal commands list
 
         ### Args:
@@ -288,7 +348,7 @@ class PyroClient(Client):
 
     async def register_commands(
         self, command_sets: Union[List[CommandSet], None] = None
-    ):
+    ) -> None:
         """Register commands stored in bot's 'commands' attribute"""
 
         if command_sets is None:
@@ -317,7 +377,9 @@ class PyroClient(Client):
                 language_code=command_set.language_code,
             )
 
-    async def remove_commands(self, command_sets: Union[List[CommandSet], None] = None):
+    async def remove_commands(
+        self, command_sets: Union[List[CommandSet], None] = None
+    ) -> None:
         """Remove commands stored in bot's 'commands' attribute"""
 
         if command_sets is None:

src/libbot/sync/__init__.py

@@ -29,7 +29,11 @@ def json_write(data: Any, path: Union[str, Path]) -> None:
         * path (`Union[str, Path]`): Path-like object or path as a string of a destination
     """
     with open(str(path), mode="w", encoding="utf-8") as f:
-        f.write(dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4))
+        f.write(
+            dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
+            if hasattr(dumps, "escape_forward_slashes")
+            else dumps(data, ensure_ascii=False, indent=4)
+        )
 
 
 def nested_set(target: dict, value: Any, *path: str, create_missing=True) -> dict:
@@ -51,7 +55,9 @@ def nested_set(target: dict, value: Any, *path: str, create_missing=True) -> dic
         elif create_missing:
             d = d.setdefault(key, {})
         else:
-            return target
+            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
     return target

tests/config.json

@@ -0,0 +1,6 @@
+{
+    "locale": "en",
+    "bot": {
+        "bot_token": "sample_token"
+    }
+}

tests/conftest.py

@@ -0,0 +1,20 @@
+from pathlib import Path
+
+import pytest
+
+from libbot.i18n import BotLocale
+
+
+@pytest.fixture()
+def location_config() -> Path:
+    return Path("tests/config.json")
+
+
+@pytest.fixture()
+def location_locale() -> Path:
+    return Path("tests/data/locale/")
+
+
+@pytest.fixture()
+def bot_locale(location_locale: Path) -> BotLocale:
+    return BotLocale(locales_root=location_locale)

tests/data/empty.json

@@ -0,0 +1 @@
+{}

tests/data/invalid.json

@@ -0,0 +1,3 @@
+{
+    "foo": 'bar'
+}

tests/data/locale/en.json

@@ -0,0 +1,23 @@
+{
+    "metadata": {
+        "flag": "🇬🇧",
+        "name": "English",
+        "codes": [
+            "en"
+        ]
+    },
+    "bot": {
+        "name": "",
+        "about": "", 
+        "description": ""
+    },
+    "foo": "bar",
+    "messages": {
+        "example": "okay"
+    },
+    "callbacks": {
+        "default": {
+            "nested": "sure"
+        }
+    }
+}

tests/data/locale/uk.json

@@ -0,0 +1,23 @@
+{
+    "metadata": {
+        "flag": "🇺🇦",
+        "name": "Українська",
+        "codes": [
+            "uk"
+        ]
+    },
+    "bot": {
+        "name": "",
+        "about": "", 
+        "description": ""
+    },
+    "foo": "бар",
+    "messages": {
+        "example": "окей"
+    },
+    "callbacks": {
+        "default": {
+            "nested": "авжеж"
+        }
+    }
+}

tests/data/test.json

@@ -0,0 +1,15 @@
+{
+    "foo": "bar",
+    "abcdefg": [
+        "higklmnop",
+        {
+            "lol": {
+                "kek": [
+                    1.0000035,
+                    0.2542,
+                    1337
+                ]
+            }
+        }
+    ]
+}

tests/test_bot_locale.py

@@ -0,0 +1,59 @@
+from pathlib import Path
+from typing import Any, List, Union
+
+import pytest
+
+from libbot.i18n import BotLocale
+
+
+@pytest.mark.parametrize(
+    "key, args, locale, expected",
+    [
+        ("foo", [], None, "bar"),
+        ("foo", [], "uk", "бар"),
+        ("example", ["messages"], None, "okay"),
+        ("example", ["messages"], "uk", "окей"),
+        ("nested", ["callbacks", "default"], None, "sure"),
+        ("nested", ["callbacks", "default"], "uk", "авжеж"),
+    ],
+)
+def test_bot_locale_get(
+    key: str,
+    args: List[str],
+    locale: Union[str, None],
+    expected: Any,
+    bot_locale: BotLocale,
+):
+    assert (
+        bot_locale._(key, *args, locale=locale)
+        if locale is not None
+        else bot_locale._(key, *args)
+    ) == expected
+
+
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], ["bar", "бар"]),
+        ("example", ["messages"], ["okay", "окей"]),
+        ("nested", ["callbacks", "default"], ["sure", "авжеж"]),
+    ],
+)
+def test_i18n_in_all_locales(
+    key: str, args: List[str], expected: Any, bot_locale: BotLocale
+):
+    assert (bot_locale.in_all_locales(key, *args)) == expected
+
+
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], {"en": "bar", "uk": "бар"}),
+        ("example", ["messages"], {"en": "okay", "uk": "окей"}),
+        ("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
+    ],
+)
+def test_i18n_in_every_locale(
+    key: str, args: List[str], expected: Any, bot_locale: BotLocale
+):
+    assert (bot_locale.in_every_locale(key, *args)) == expected

tests/test_config_async.py

@@ -0,0 +1,48 @@
+from pathlib import Path
+from typing import Any, List
+
+import pytest
+
+from libbot import config_get, config_set
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "args, expected",
+    [
+        (["locale"], "en"),
+        (["bot_token", "bot"], "sample_token"),
+    ],
+)
+async def test_config_get_valid(args: List[str], expected: str, location_config: Path):
+    assert await config_get(args[0], *args[1:], config_file=location_config) == expected
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "args, expected",
+    [
+        (["bot_stonks", "bot"], pytest.raises(KeyError)),
+    ],
+)
+async def test_config_get_invalid(
+    args: List[str], expected: Any, location_config: Path
+):
+    with expected:
+        assert (
+            await config_get(args[0], *args[1:], config_file=location_config)
+            == expected
+        )
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "key, path, value",
+    [
+        ("locale", [], "en"),
+        ("bot_token", ["bot"], "sample_token"),
+    ],
+)
+async def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
+    await config_set(key, value, *path, config_file=location_config)
+    assert await config_get(key, *path, config_file=location_config) == value

tests/test_config_sync.py

@@ -0,0 +1,42 @@
+from pathlib import Path
+from typing import Any, List
+
+import pytest
+
+from libbot import sync
+
+
+@pytest.mark.parametrize(
+    "args, expected",
+    [
+        (["locale"], "en"),
+        (["bot_token", "bot"], "sample_token"),
+    ],
+)
+def test_config_get_valid(args: List[str], expected: str, location_config: Path):
+    assert sync.config_get(args[0], *args[1:], config_file=location_config) == expected
+
+
+@pytest.mark.parametrize(
+    "args, expected",
+    [
+        (["bot_stonks", "bot"], pytest.raises(KeyError)),
+    ],
+)
+def test_config_get_invalid(args: List[str], expected: Any, location_config: Path):
+    with expected:
+        assert (
+            sync.config_get(args[0], *args[1:], config_file=location_config) == expected
+        )
+
+
+@pytest.mark.parametrize(
+    "key, path, value",
+    [
+        ("locale", [], "en"),
+        ("bot_token", ["bot"], "sample_token"),
+    ],
+)
+def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
+    sync.config_set(key, value, *path, config_file=location_config)
+    assert sync.config_get(key, *path, config_file=location_config) == value

tests/test_i18n_async.py

@@ -0,0 +1,66 @@
+from pathlib import Path
+from typing import Any, List, Union
+
+import pytest
+
+from libbot import i18n
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "key, args, locale, expected",
+    [
+        ("foo", [], None, "bar"),
+        ("foo", [], "uk", "бар"),
+        ("example", ["messages"], None, "okay"),
+        ("example", ["messages"], "uk", "окей"),
+        ("nested", ["callbacks", "default"], None, "sure"),
+        ("nested", ["callbacks", "default"], "uk", "авжеж"),
+    ],
+)
+async def test_i18n_get(
+    key: str,
+    args: List[str],
+    locale: Union[str, None],
+    expected: Any,
+    location_locale: Path,
+):
+    assert (
+        await i18n._(key, *args, locale=locale, locales_root=location_locale)
+        if locale is not None
+        else await i18n._(key, *args, locales_root=location_locale)
+    ) == expected
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], ["bar", "бар"]),
+        ("example", ["messages"], ["okay", "окей"]),
+        ("nested", ["callbacks", "default"], ["sure", "авжеж"]),
+    ],
+)
+async def test_i18n_in_all_locales(
+    key: str, args: List[str], expected: Any, location_locale: Path
+):
+    assert (
+        await i18n.in_all_locales(key, *args, locales_root=location_locale)
+    ) == expected
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], {"en": "bar", "uk": "бар"}),
+        ("example", ["messages"], {"en": "okay", "uk": "окей"}),
+        ("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
+    ],
+)
+async def test_i18n_in_every_locale(
+    key: str, args: List[str], expected: Any, location_locale: Path
+):
+    assert (
+        await i18n.in_every_locale(key, *args, locales_root=location_locale)
+    ) == expected

tests/test_i18n_sync.py

@@ -0,0 +1,59 @@
+from pathlib import Path
+from typing import Any, List, Union
+
+import pytest
+
+from libbot.i18n import sync
+
+
+@pytest.mark.parametrize(
+    "key, args, locale, expected",
+    [
+        ("foo", [], None, "bar"),
+        ("foo", [], "uk", "бар"),
+        ("example", ["messages"], None, "okay"),
+        ("example", ["messages"], "uk", "окей"),
+        ("nested", ["callbacks", "default"], None, "sure"),
+        ("nested", ["callbacks", "default"], "uk", "авжеж"),
+    ],
+)
+def test_i18n_get(
+    key: str,
+    args: List[str],
+    locale: Union[str, None],
+    expected: Any,
+    location_locale: Path,
+):
+    assert (
+        sync._(key, *args, locale=locale, locales_root=location_locale)
+        if locale is not None
+        else sync._(key, *args, locales_root=location_locale)
+    ) == expected
+
+
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], ["bar", "бар"]),
+        ("example", ["messages"], ["okay", "окей"]),
+        ("nested", ["callbacks", "default"], ["sure", "авжеж"]),
+    ],
+)
+def test_i18n_in_all_locales(
+    key: str, args: List[str], expected: Any, location_locale: Path
+):
+    assert (sync.in_all_locales(key, *args, locales_root=location_locale)) == expected
+
+
+@pytest.mark.parametrize(
+    "key, args, expected",
+    [
+        ("foo", [], {"en": "bar", "uk": "бар"}),
+        ("example", ["messages"], {"en": "okay", "uk": "окей"}),
+        ("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
+    ],
+)
+def test_i18n_in_every_locale(
+    key: str, args: List[str], expected: Any, location_locale: Path
+):
+    assert (sync.in_every_locale(key, *args, locales_root=location_locale)) == expected

tests/test_json_async.py

@@ -0,0 +1,64 @@
+try:
+    from ujson import JSONDecodeError, dumps
+except ImportError:
+    from json import dumps, JSONDecodeError
+
+from pathlib import Path
+from typing import Any, Union
+
+import pytest
+
+from libbot import json_read, json_write
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "path, expected",
+    [
+        (
+            "tests/data/test.json",
+            {
+                "foo": "bar",
+                "abcdefg": ["higklmnop", {"lol": {"kek": [1.0000035, 0.2542, 1337]}}],
+            },
+        ),
+        ("tests/data/empty.json", {}),
+    ],
+)
+async def test_json_read_valid(path: Union[str, Path], expected: Any):
+    assert await json_read(path) == expected
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "path, expected",
+    [
+        ("tests/data/invalid.json", JSONDecodeError),
+        ("tests/data/nonexistent.json", FileNotFoundError),
+    ],
+)
+async def test_json_read_invalid(path: Union[str, Path], expected: Any):
+    with pytest.raises(expected):
+        await json_read(path)
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "data, path",
+    [
+        (
+            {
+                "foo": "bar",
+                "abcdefg": ["higklmnop", {"lol": {"kek": [1.0000035, 0.2542, 1337]}}],
+            },
+            "tests/data/test.json",
+        ),
+        ({}, "tests/data/empty.json"),
+    ],
+)
+async def test_json_write(data: Any, path: Union[str, Path]):
+    await json_write(data, path)
+
+    assert Path(path).is_file()
+    with open(path, "r", encoding="utf-8") as f:
+        assert f.read() == dumps(data, ensure_ascii=False, indent=4)

tests/test_json_sync.py

@@ -0,0 +1,61 @@
+try:
+    from ujson import JSONDecodeError, dumps
+except ImportError:
+    from json import dumps, JSONDecodeError
+
+from pathlib import Path
+from typing import Any, Union
+
+import pytest
+
+from libbot import sync
+
+
+@pytest.mark.parametrize(
+    "path, expected",
+    [
+        (
+            "tests/data/test.json",
+            {
+                "foo": "bar",
+                "abcdefg": ["higklmnop", {"lol": {"kek": [1.0000035, 0.2542, 1337]}}],
+            },
+        ),
+        ("tests/data/empty.json", {}),
+    ],
+)
+def test_json_read_valid(path: Union[str, Path], expected: Any):
+    assert sync.json_read(path) == expected
+
+
+@pytest.mark.parametrize(
+    "path, expected",
+    [
+        ("tests/data/invalid.json", JSONDecodeError),
+        ("tests/data/nonexistent.json", FileNotFoundError),
+    ],
+)
+def test_json_read_invalid(path: Union[str, Path], expected: Any):
+    with pytest.raises(expected):
+        assert sync.json_read(path) == expected
+
+
+@pytest.mark.parametrize(
+    "data, path",
+    [
+        (
+            {
+                "foo": "bar",
+                "abcdefg": ["higklmnop", {"lol": {"kek": [1.0000035, 0.2542, 1337]}}],
+            },
+            "tests/data/test.json",
+        ),
+        ({}, "tests/data/empty.json"),
+    ],
+)
+def test_json_write(data: Any, path: Union[str, Path]):
+    sync.json_write(data, path)
+
+    assert Path(path).is_file()
+    with open(path, "r", encoding="utf-8") as f:
+        assert f.read() == dumps(data, ensure_ascii=False, indent=4)

tests/test_nested_set.py

@@ -0,0 +1,63 @@
+from typing import Any, Dict, List
+
+import pytest
+
+from libbot import sync
+
+
+@pytest.mark.parametrize(
+    "target, value, path, create_missing, expected",
+    [
+        ({"foo": "bar"}, "rab", ["foo"], True, {"foo": "rab"}),
+        ({"foo": "bar"}, {"123": 456}, ["foo"], True, {"foo": {"123": 456}}),
+        (
+            {"foo": {"bar": {}}},
+            True,
+            ["foo", "bar", "test"],
+            True,
+            {"foo": {"bar": {"test": True}}},
+        ),
+        (
+            {"foo": {"bar": {}}},
+            True,
+            ["foo", "bar", "test"],
+            False,
+            {"foo": {"bar": {}}},
+        ),
+    ],
+)
+def test_nested_set_valid(
+    target: Dict[str, Any],
+    value: Any,
+    path: List[str],
+    create_missing: bool,
+    expected: Any,
+):
+    assert (
+        sync.nested_set(target, value, *path, create_missing=create_missing)
+    ) == expected
+
+
+@pytest.mark.parametrize(
+    "target, value, path, create_missing, expected",
+    [
+        (
+            {"foo": {"bar": {}}},
+            True,
+            ["foo", "bar", "test1", "test2"],
+            False,
+            KeyError,
+        ),
+    ],
+)
+def test_nested_set_invalid(
+    target: Dict[str, Any],
+    value: Any,
+    path: List[str],
+    create_missing: bool,
+    expected: Any,
+):
+    with pytest.raises(expected):
+        assert (
+            sync.nested_set(target, value, *path, create_missing=create_missing)
+        ) == expected

tox.ini

@@ -0,0 +1,23 @@
+[tox]
+minversion = 3.8.0
+envlist = py38, py39, py310, py311
+isolated_build = true
+
+[gh-actions]
+python = 
+    3.8: py38
+    3.9: py39
+    3.10: py310
+    3.11: py311
+
+[testenv]
+setenv = 
+    PYTHONPATH = {toxinidir}
+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
+commands =
+    pytest --basetemp={envtmpdir} --cov=libbot