Merge pull request 'Update to 3.0.0' (#52) from dev into main

Reviewed-on: #52

.gitea/workflows/analysis.yml

@@ -1,24 +0,0 @@
-name: Analysis
-
-on:
-  push:
-    branches:
-      - main
-      - dev
-  pull_request:
-    types: [opened, synchronize, reopened]
-
-jobs:
-  sonarcloud:
-    name: SonarCloud
-    runs-on: ubuntu-latest
-    container: catthehacker/ubuntu:act-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: SonarCloud Scan
-        uses: SonarSource/sonarcloud-github-action@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitea/workflows/tests.yml

@@ -10,12 +10,11 @@ on:
 
 jobs:
   test:
-    name: Build and Test
     runs-on: ubuntu-latest
     container: catthehacker/ubuntu:act-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
       - uses: actions/checkout@v3
@@ -28,12 +27,6 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install tox tox-gh-actions build
+          pip install tox tox-gh-actions
       - name: Test with tox
         run: tox
-      - name: Build
-        run: python -m build
-      - uses: actions/upload-artifact@v3
-        with:
-          name: Artifacts
-          path: dist/*

.gitignore

@@ -165,6 +165,4 @@ venv/
 venv_linux/
 venv_windows/
 
-.vscode/
-
-tests/.tmp/
+.vscode/

README.md

@@ -1,86 +1,2 @@
-<h1 align="center">LibBotUniversal</h1>
+# LibBotUniversal
 
-<p align="center">
-<a href="https://git.end-play.xyz/profitroll/LibBotUniversal/src/branch/master/LICENSE"><img alt="PyPI - License" src="https://img.shields.io/pypi/l/libbot">
-<a href="https://git.end-play.xyz/profitroll/LibBotUniversal/releases/latest"><img alt="Gitea Release" src="https://img.shields.io/gitea/v/release/profitroll/LibBotUniversal?gitea_url=https%3A%2F%2Fgit.end-play.xyz"></a>
-<a href="https://pypi.org/project/libbot/"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/libbot"></a>
-<a href="https://git.end-play.xyz/profitroll/LibBotUniversal"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
-</p>  
-
-Handy library for Telegram/Discord bots development.
-
-## Getting started
-
-There are different sub-packages available:
-
-* pyrogram - Telegram bots with Pyrogram's fork "Pyrofork"
-* pycord - Discord bots with Pycord
-* speed - Performance improvements
-* 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.
-
-```shell
-# Only general features
-pip install libbot
-
-# Only with Pyrogram
-pip install libbot[pyrogram]
-
-# With Pycord and Performance improvements
-pip install libbot[pycord,speed]
-```
-
-## Examples
-
-### Pyrogram
-
-```python
-from libbot.pyrogram import PyroClient
-
-def main():
-    client = PyroClient(scheduler=scheduler)
-
-    try:
-        client.run()
-    except KeyboardInterrupt:
-        print("Shutting down...")
-    finally:
-        if client.scheduler is not None:
-            client.scheduler.shutdown()
-        exit()
-
-
-if __name__ == "__main__":
-    main()
-```
-
-### Pycord
-
-```python
-from discord import Intents
-from libbot import sync
-from libbot.pycord import PycordBot
-
-
-async def main():
-    intents = Intents.default()
-    bot = PycordBot(intents=intents)
-
-    bot.load_extension("cogs")
-
-    try:
-        await bot.start(sync.config_get("bot_token", "bot"))
-    except KeyboardInterrupt:
-        logger.warning("Shutting down...")
-        await bot.close()
-
-
-if __name__ == "__main__":
-    loop = asyncio.get_event_loop()
-    loop.run_until_complete(main())
-```
-
-## Config examples
-
-For bot config examples please check the examples directory. Without a valid config file, the bot won't start at all, so you need to make sure the correct config file is used.

examples/commands.json

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

examples/config_pycord.json

@@ -1,13 +0,0 @@
-{
-    "locale": "en",
-    "debug": false,
-    "bot": {
-        "owners": [
-            0
-        ],
-        "debug_guilds": [
-            0
-        ],
-        "bot_token": ""
-    }
-}

examples/config_pyrogram.json

@@ -1,38 +0,0 @@
-{
-    "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

@@ -1,23 +0,0 @@
-{
-    "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!"
-    }
-}

pyproject.toml

@@ -8,17 +8,17 @@ 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.9"
-license = { text = "GPLv3" }
+requires-python = ">=3.8"
+license = { file = "LICENSE" }
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Utilities",
 ]
@@ -42,7 +42,7 @@ Tracker = "https://git.end-play.xyz/profitroll/LibBotUniversal/issues"
 where = ["src"]
 
 [tool.black]
-target-version = ['py39', 'py310', 'py311' ,'py312']
+target-version = ['py38', 'py39', 'py310', 'py311']
 
 [tool.isort]
 profile = "black"
@@ -61,7 +61,7 @@ show_error_codes = true
 
 [tool.pylint.main]
 extension-pkg-whitelist = ["ujson"]
-py-version = 3.9
+py-version = 3.8
 
 [tool.coverage.run]
 source = ["libbot"]

requirements/dev.txt

@@ -1,11 +1,11 @@
-black==24.10.0
-build==1.2.2.post1
+black==23.12.1
+build==1.0.3
 isort==5.13.2
-mypy==1.14.0
-pylint==3.3.3
-pytest-asyncio==0.25.0
-pytest-cov==6.0.0
-pytest==8.3.4
-tox==4.23.2
-types-aiofiles==24.1.0.20241221
-types-ujson==5.10.0.20240515
+mypy==1.8.0
+pylint==3.0.3
+pytest-asyncio==0.23.3
+pytest-cov==4.1.0
+pytest==7.4.4
+tox==4.11.4
+types-aiofiles==23.2.0.0
+types-ujson==5.9.0.0

requirements/pycord.txt

@@ -1,2 +1,2 @@
-apscheduler~=3.11.0
-py-cord~=2.6.0
+apscheduler~=3.10.4
+py-cord~=2.4.1

requirements/pyrogram.txt

@@ -1,2 +1,2 @@
-apscheduler~=3.11.0
-pyrofork~=2.3.32
+apscheduler~=3.10.4
+pyrofork~=2.3.16.post1

requirements/speed.txt

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

sonar-project.properties

@@ -1,2 +0,0 @@
-sonar.projectKey=profitroll_libbot
-sonar.organization=profitroll

src/libbot/__init__.py

@@ -1,6 +1,6 @@
-__version__ = "3.3.1"
+__version__ = "3.0.0"
 __license__ = "GPL3"
 __author__ = "Profitroll"
 
-from . import errors, i18n, pycord, pyrogram, sync
-from .__main__ import config_delete, config_get, config_set, json_read, json_write
+from . import i18n, pycord, pyrogram, sync
+from .__main__ import *

src/libbot/__main__.py

@@ -8,10 +8,7 @@ try:
 except ImportError:
     from json import dumps, loads
 
-from ._utils import supports_argument
-from .sync._nested import nested_delete, nested_set
-
-DEFAULT_CONFIG_LOCATION: str = "config.json"
+from libbot.sync import nested_set
 
 
 async def json_read(path: Union[str, Path]) -> Any:
@@ -25,7 +22,6 @@ async def json_read(path: Union[str, Path]) -> Any:
     """
     async with aiofiles.open(str(path), mode="r", encoding="utf-8") as f:
         data = await f.read()
-
     return loads(data)
 
 
@@ -39,13 +35,13 @@ 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 supports_argument(dumps, "escape_forward_slashes")
+            if hasattr(dumps, "escape_forward_slashes")
             else dumps(data, ensure_ascii=False, indent=4)
         )
 
 
 async def config_get(
-    key: str, *path: str, config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION
+    key: str, *path: str, config_file: Union[str, Path] = "config.json"
 ) -> 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"`
@@ -77,15 +73,13 @@ async def config_get(
     ```
     """
     this_key = await json_read(config_file)
-
     for dict_key in path:
         this_key = this_key[dict_key]
-
     return this_key[key]
 
 
 async def config_set(
-    key: str, value: Any, *path: str, config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION
+    key: str, value: Any, *path: str, config_file: Union[str, Path] = "config.json"
 ) -> None:
     """Set config's key by its path to the value
 
@@ -94,38 +88,8 @@ async def config_set(
         * value (`Any`): Any JSON serializable data
         * *path (`str`): Path to the key of the target
         * config_file (`Union[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
     """
     await json_write(
         nested_set(await json_read(config_file), value, *(*path, key)), config_file
     )
-
-
-async def config_delete(
-    key: str,
-    *path: str,
-    missing_ok: bool = False,
-    config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION,
-) -> None:
-    """Set config's key by its path
-
-    ### Args:
-        * key (`str`): Key to delete
-        * *path (`str`): Path to the key of the target
-        * missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
-        * config_file (`Union[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`
-    """
-    config_data = await json_read(config_file)
-
-    try:
-        nested_delete(config_data, *(*path, key))
-    except KeyError as exc:
-        if not missing_ok:
-            raise exc from exc
-
-    await json_write(config_data, config_file)
+    return

src/libbot/_utils.py

@@ -1,22 +0,0 @@
-import inspect
-from typing import Callable
-
-
-def supports_argument(func: Callable, arg_name: str) -> bool:
-    """Check whether a function has a specific argument
-
-    ### Args:
-        * func (`Callable`): Function to be inspected
-        * arg_name (`str`): Argument to be checked
-
-    ### Returns:
-        * `bool`: `True` if argument is supported and `False` if not
-    """
-    if hasattr(func, "__code__"):
-        return arg_name in inspect.signature(func).parameters
-    elif hasattr(func, "__doc__"):
-        if doc := func.__doc__:
-            first_line = doc.splitlines()[0]
-            return arg_name in first_line
-
-    return False

src/libbot/errors/__init__.py

@@ -1 +0,0 @@
-from .config import ConfigKeyError, ConfigValueError

src/libbot/errors/config.py

@@ -1,37 +0,0 @@
-from typing import Any, List, Optional, Union
-
-
-class ConfigKeyError(Exception):
-    """Raised when config key is not found.
-
-    ### Attributes:
-        * key (`Union[str, List[str]]`): Missing config key.
-    """
-
-    def __init__(self, key: Union[str, List[str]]) -> None:
-        self.key: Union[str, List[str]] = key
-        super().__init__(
-            f"Config key {'.'.join(key) if isinstance(key, list) else key} is missing. Please set in your config file."
-        )
-
-    def __str__(self):
-        return f"Config key {'.'.join(self.key) if isinstance(self.key, list) else self.key} is missing. Please set in your config file."
-
-
-class ConfigValueError(Exception):
-    """Raised when config key's value is invalid.
-
-    ### Attributes:
-        * key (`Union[str, List[str]]`): Invalid config key.
-        * value (`Optional[Any]`): Key's correct value.
-    """
-
-    def __init__(self, key: Union[str, List[str]], value: Optional[Any] = None) -> None:
-        self.key: Union[str, List[str]] = key
-        self.value: Optional[Any] = value
-        super().__init__(
-            f"Config key {'.'.join(key) if isinstance(key, list) else key} has invalid value. {f'Must be {value}. ' if value else ''}Please set in your config file."
-        )
-
-    def __str__(self):
-        return f"Config key {'.'.join(self.key) if isinstance(self.key, list) else self.key} has invalid value. {f'Must be {self.value}. ' if self.value else ''}Please set in your config file."

src/libbot/pycord/classes/bot.py

@@ -1,6 +1,6 @@
 import logging
 from pathlib import Path
-from typing import Any, Dict, List, Union
+from typing import Any, Dict, Union
 
 try:
     from apscheduler.schedulers.asyncio import AsyncIOScheduler
@@ -29,7 +29,6 @@ class PycordBot(Bot):
         config_path: Union[str, Path] = Path("config.json"),
         locales_root: Union[str, Path, None] = None,
         scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
-        *args,
         **kwargs,
     ):
         if config is None:
@@ -39,11 +38,8 @@ class PycordBot(Bot):
             self.config = config
 
         super().__init__(
-            debug_guilds=(
-                self.config["bot"]["debug_guilds"] if self.config["debug"] else None
-            ),
+            debug_guilds=self.config["bot"]["debug_guilds"],
             owner_ids=self.config["bot"]["owners"],
-            *args,
             **kwargs,
         )
 
@@ -52,22 +48,10 @@ class PycordBot(Bot):
             locales_root=(Path("locale") if locales_root is None else locales_root),
         )
         self.default_locale: str = self.bot_locale.default
-        self.locales: Dict[str, Any] = self.bot_locale.locales
+        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
-
-    async def start(self, token: str, reconnect: bool = True, scheduler_start: bool = True) -> None:
-        if self.scheduler is not None and scheduler_start:
-            self.scheduler.start()
-
-        await super().start(token, reconnect=reconnect)
-
-    async def close(self, scheduler_shutdown: bool = True, scheduler_wait: bool = True) -> None:
-        if self.scheduler is not None and scheduler_shutdown:
-            self.scheduler.shutdown(scheduler_wait)
-
-        await super().close()

src/libbot/pyrogram/classes/client.py

@@ -46,7 +46,6 @@ 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,
@@ -59,8 +58,6 @@ 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,
     ):
@@ -96,16 +93,12 @@ class PyroClient(Client):
             else max_concurrent_transmissions,
             **kwargs,
         )
-        self.owner: int = self.config["bot"]["owner"] if owner is None else owner
+        self.owner: int = self.config["bot"]["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"]
-            if scoped_commands is None
-            else scoped_commands
-        )
+        self.scoped_commands: bool = self.config["bot"]["scoped_commands"]
         self.start_time: float = 0
 
         self.bot_locale: BotLocale = BotLocale(
@@ -123,9 +116,7 @@ class PyroClient(Client):
 
         self.scopes_placeholders: Dict[str, int] = {"owner": self.owner}
 
-        self.i18n_bot_info: bool = i18n_bot_info
-
-    async def start(self, register_commands: bool = True, scheduler_start: bool = True) -> None:
+    async def start(self, register_commands: bool = True) -> None:
         await super().start()
 
         self.start_time = time()
@@ -138,53 +129,51 @@ 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:
+        # 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(
-                    "Default locale %s has incorrect keys or values in bot section",
-                    self.default_locale,
+                    "Locale %s is missing metadata or metadata.codes key", locale_code
                 )
+                continue
 
-            # 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"]):
+            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.default_locale,
+                    )
+                except KeyError:
                     logger.warning(
-                        "Locale %s is missing metadata or metadata.codes key",
+                        "Locale %s has incorrect keys or values in bot section",
                         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:
@@ -209,12 +198,9 @@ class PyroClient(Client):
                 kwargs={"command_sets": await self.collect_commands()},
             )
 
-        if scheduler_start:
-            self.scheduler.start()
+        self.scheduler.start()
 
-    async def stop(
-        self, exit_completely: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
-    ) -> None:
+    async def stop(self, exit_completely: bool = True) -> None:
         try:
             await self.send_message(
                 chat_id=self.owner
@@ -226,9 +212,6 @@ class PyroClient(Client):
         except BadRequest:
             logger.warning("Unable to send message to report chat.")
 
-        if self.scheduler is not None and scheduler_shutdown:
-            self.scheduler.shutdown(scheduler_wait)
-
         await super().stop()
         logger.warning("Bot stopped with PID %s.", getpid())
 
@@ -364,8 +347,7 @@ class PyroClient(Client):
             ]
 
             logger.info(
-                "Registering commands %s with a default scope 'BotCommandScopeDefault'",
-                commands
+                "Registering commands %s with a default scope 'BotCommandScopeDefault'"
             )
 
             await self.set_bot_commands(commands)

src/libbot/sync/__init__.py

@@ -1 +1,116 @@
-from .__main__ import config_delete, config_get, config_set, json_read, json_write
+from pathlib import Path
+from typing import Any, Union
+
+try:
+    from ujson import dumps, loads
+except ImportError:
+    from json import dumps, loads
+
+
+def json_read(path: Union[str, Path]) -> Any:
+    """Read contents of a JSON file
+
+    ### Args:
+        * path (`Union[str, Path]`): Path-like object or path as a string
+
+    ### Returns:
+        * `Any`: File contents
+    """
+    with open(str(path), mode="r", encoding="utf-8") as f:
+        data = f.read()
+    return loads(data)
+
+
+def json_write(data: Any, path: Union[str, Path]) -> None:
+    """Write contents to a JSON file
+
+    ### Args:
+        * data (`Any`): Contents to write. Must be a JSON serializable
+        * 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)
+            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:
+    """Set the key by its path to the value
+
+    ### Args:
+        * target (`dict`): Dictionary to perform modifications on
+        * value (`Any`): Any data
+        * *path (`str`): Path to the key of the target
+        * create_missing (`bool`, *optional*): Create keys on the way if they're missing. Defaults to `True`
+
+    ### Returns:
+        * `dict`: Changed dictionary
+    """
+    d = target
+    for key in path[:-1]:
+        if key in d:
+            d = d[key]
+        elif create_missing:
+            d = d.setdefault(key, {})
+        else:
+            raise KeyError(
+                f"Key '{key}' is not found under path provided ({path}) and create_missing is False"
+            )
+    if path[-1] in d or create_missing:
+        d[path[-1]] = value
+    return target
+
+
+def config_get(
+    key: str, *path: str, config_file: Union[str, Path] = "config.json"
+) -> 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"`
+
+    ### Args:
+        * key (`str`): Key that contains the value
+        * *path (`str`): Path to the key that contains the value
+        * config_file (`Union[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
+
+    ### Example:
+    Get the "salary" of "Pete" from this JSON structure:
+    ```json
+    {
+        "users": {
+            "Pete": {
+                "salary": 10.0
+            }
+        }
+    }
+    ```
+
+    This can be easily done with the following code:
+    ```python
+    import libbot
+    salary = libbot.sync.config_get("salary", "users", "Pete")
+    ```
+    """
+    this_key = json_read(config_file)
+    for dict_key in path:
+        this_key = this_key[dict_key]
+    return this_key[key]
+
+
+def config_set(
+    key: str, value: Any, *path: str, config_file: Union[str, Path] = "config.json"
+) -> None:
+    """Set config's key by its path to the value
+
+    ### Args:
+        * key (`str`): Key that leads to the value
+        * value (`Any`): Any JSON serializable data
+        * *path (`str`): Path to the key of the target
+        * config_file (`Union[str, Path]`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
+    """
+    json_write(nested_set(json_read(config_file), value, *(*path, key)), config_file)
+    return

src/libbot/sync/__main__.py

@@ -1,127 +0,0 @@
-from pathlib import Path
-from typing import Any, Union
-
-from .._utils import supports_argument
-from ._nested import nested_delete, nested_set
-
-try:
-    from ujson import dumps, loads
-except ImportError:
-    from json import dumps, loads
-
-DEFAULT_CONFIG_LOCATION: str = "config.json"
-
-
-def json_read(path: Union[str, Path]) -> Any:
-    """Read contents of a JSON file
-
-    ### Args:
-        * path (`Union[str, Path]`): Path-like object or path as a string
-
-    ### Returns:
-        * `Any`: File contents
-    """
-    with open(str(path), mode="r", encoding="utf-8") as f:
-        data = f.read()
-
-    return loads(data)
-
-
-def json_write(data: Any, path: Union[str, Path]) -> None:
-    """Write contents to a JSON file
-
-    ### Args:
-        * data (`Any`): Contents to write. Must be a JSON serializable
-        * 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)
-            if supports_argument(dumps, "escape_forward_slashes")
-            else dumps(data, ensure_ascii=False, indent=4)
-        )
-
-
-def config_get(
-    key: str, *path: str, config_file: Union[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"`
-
-    ### Args:
-        * key (`str`): Key that contains the value
-        * *path (`str`): Path to the key that contains the value
-        * config_file (`Union[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
-
-    ### Example:
-    Get the "salary" of "Pete" from this JSON structure:
-    ```json
-    {
-        "users": {
-            "Pete": {
-                "salary": 10.0
-            }
-        }
-    }
-    ```
-
-    This can be easily done with the following code:
-    ```python
-    import libbot
-    salary = libbot.sync.config_get("salary", "users", "Pete")
-    ```
-    """
-    this_key = json_read(config_file)
-
-    for dict_key in path:
-        this_key = this_key[dict_key]
-
-    return this_key[key]
-
-
-def config_set(
-    key: str, value: Any, *path: str, config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION
-) -> None:
-    """Set config's key by its path to the value
-
-    ### Args:
-        * key (`str`): Key that leads to the value
-        * value (`Any`): Any JSON serializable data
-        * *path (`str`): Path to the key of the target
-        * config_file (`Union[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
-    """
-    json_write(nested_set(json_read(config_file), value, *(*path, key)), config_file)
-
-
-def config_delete(
-    key: str,
-    *path: str,
-    missing_ok: bool = False,
-    config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION,
-) -> None:
-    """Set config's key by its path
-
-    ### Args:
-        * key (`str`): Key to delete
-        * *path (`str`): Path to the key of the target
-        * missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
-        * config_file (`Union[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`
-    """
-    config_data = json_read(config_file)
-
-    try:
-        nested_delete(config_data, *(*path, key))
-    except KeyError as exc:
-        if not missing_ok:
-            raise exc from exc
-
-    json_write(config_data, config_file)

src/libbot/sync/_nested.py

@@ -1,64 +0,0 @@
-from typing import Any, Dict
-
-
-def nested_set(
-    target: dict, value: Any, *path: str, create_missing=True
-) -> Dict[str, Any]:
-    """Set the key by its path to the value
-
-    ### Args:
-        * target (`dict`): Dictionary to perform modifications on
-        * value (`Any`): Any data
-        * *path (`str`): Path to the key of the target
-        * create_missing (`bool`, *optional*): Create keys on the way if they're missing. Defaults to `True`
-
-    ### Raises:
-        * `KeyError`: Key is not found under path provided
-
-    ### Returns:
-        * `Dict[str, Any]`: Changed dictionary
-    """
-    d = target
-
-    for key in path[:-1]:
-        if key in d:
-            d = d[key]
-        elif create_missing:
-            d = d.setdefault(key, {})
-        else:
-            raise KeyError(
-                f"Key '{key}' is not found under path provided ({path}) and create_missing is False"
-            )
-
-    if path[-1] in d or create_missing:
-        d[path[-1]] = value
-
-    return target
-
-
-def nested_delete(target: dict, *path: str) -> Dict[str, Any]:
-    """Delete the key by its path
-
-    ### Args:
-        * target (`dict`): Dictionary to perform modifications on
-
-    ### Raises:
-        * `KeyError`: Key is not found under path provided
-
-    ### Returns:
-        `Dict[str, Any]`: Changed dictionary
-    """
-    d = target
-
-    for key in path[:-1]:
-        if key in d:
-            d = d[key]
-        else:
-            raise KeyError(f"Key '{key}' is not found under path provided ({path})")
-
-    if path[-1] in d:
-        del d[path[-1]]
-    else:
-        raise KeyError(f"Key '{path[-1]}' is not found under path provided ({path})")
-
-    return target

tests/conftest.py

@@ -1,7 +1,4 @@
-from json import dumps, loads
-from os import makedirs
 from pathlib import Path
-from uuid import uuid4
 
 import pytest
 
@@ -10,22 +7,7 @@ from libbot.i18n import BotLocale
 
 @pytest.fixture()
 def location_config() -> Path:
-    makedirs(Path("tests/.tmp"), exist_ok=True)
-
-    filename = str(uuid4())
-
-    with open(Path("tests/config.json"), "r", encoding="utf-8") as file:
-        config = loads(file.read())
-
-    with open(Path(f"tests/.tmp/{filename}.json"), "w", encoding="utf-8") as file:
-        file.write(
-            dumps(
-                config,
-                ensure_ascii=False,
-                indent=4,
-            )
-        )
-    return Path(f"tests/.tmp/{filename}.json")
+    return Path("tests/config.json")
 
 
 @pytest.fixture()

tests/test_config_async.py

@@ -3,7 +3,7 @@ from typing import Any, List
 
 import pytest
 
-from libbot import config_delete, config_get, config_set
+from libbot import config_get, config_set
 
 
 @pytest.mark.asyncio
@@ -46,29 +46,3 @@ async def test_config_get_invalid(
 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
-
-
-@pytest.mark.asyncio
-@pytest.mark.parametrize(
-    "key, path",
-    [
-        ("bot_token", ["bot"]),
-    ],
-)
-async def test_config_delete(key: str, path: List[str], location_config: Path):
-    await config_delete(key, *path, config_file=location_config)
-    assert key not in (await config_get(*path, config_file=location_config))
-
-
-@pytest.mark.asyncio
-@pytest.mark.parametrize(
-    "key, path",
-    [
-        ("bot_lol", ["bot"]),
-    ],
-)
-async def test_config_delete_missing(key: str, path: List[str], location_config: Path):
-    assert (
-        await config_delete(key, *path, missing_ok=True, config_file=location_config)
-        is None
-    )

tests/test_config_sync.py

@@ -40,27 +40,3 @@ def test_config_get_invalid(args: List[str], expected: Any, location_config: Pat
 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
-
-
-@pytest.mark.parametrize(
-    "key, path",
-    [
-        ("bot_token", ["bot"]),
-    ],
-)
-def test_config_delete(key: str, path: List[str], location_config: Path):
-    sync.config_delete(key, *path, config_file=location_config)
-    assert key not in sync.config_get(*path, config_file=location_config)
-
-
-@pytest.mark.parametrize(
-    "key, path",
-    [
-        ("bot_lol", ["bot"]),
-    ],
-)
-def test_config_delete_missing(key: str, path: List[str], location_config: Path):
-    assert (
-        sync.config_delete(key, *path, missing_ok=True, config_file=location_config)
-        is None
-    )

tests/test_nested_set.py

@@ -2,7 +2,7 @@ from typing import Any, Dict, List
 
 import pytest
 
-from libbot.sync._nested import nested_delete, nested_set
+from libbot import sync
 
 
 @pytest.mark.parametrize(
@@ -33,7 +33,9 @@ def test_nested_set_valid(
     create_missing: bool,
     expected: Any,
 ):
-    assert (nested_set(target, value, *path, create_missing=create_missing)) == expected
+    assert (
+        sync.nested_set(target, value, *path, create_missing=create_missing)
+    ) == expected
 
 
 @pytest.mark.parametrize(
@@ -57,25 +59,5 @@ def test_nested_set_invalid(
 ):
     with pytest.raises(expected):
         assert (
-            nested_set(target, value, *path, create_missing=create_missing)
+            sync.nested_set(target, value, *path, create_missing=create_missing)
         ) == expected
-
-
-@pytest.mark.parametrize(
-    "target, path, expected",
-    [
-        ({"foo": "bar"}, ["foo"], {}),
-        ({"foo": "bar", "bar": "foo"}, ["bar"], {"foo": "bar"}),
-        (
-            {"foo": {"bar": {}}},
-            ["foo", "bar"],
-            {"foo": {}},
-        ),
-    ],
-)
-def test_nested_delete(
-    target: Dict[str, Any],
-    path: List[str],
-    expected: Any,
-):
-    assert (nested_delete(target, *path)) == expected

tests/test_utils.py

@@ -1,26 +0,0 @@
-from typing import Callable
-
-import pytest
-
-from libbot._utils import supports_argument
-
-
-def func1(foo: str, bar: str):
-    """Dummy function with specific arguments"""
-    pass
-
-
-def func2(foo: str):
-    """Dummy function with specific arguments"""
-    pass
-
-
-@pytest.mark.parametrize(
-    "func, arg_name, result",
-    [
-        (func1, "foo", True),
-        (func2, "bar", False),
-    ],
-)
-def test_supports_argument(func: Callable, arg_name: str, result: bool):
-    assert supports_argument(func, arg_name) == result

tox.ini

@@ -1,14 +1,14 @@
 [tox]
-minversion = 3.9.0
-envlist = py39, py310, py311, py312
+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
-    3.12: py312
 
 [testenv]
 setenv =