Added device info and bot prefix

.gitea/workflows/analysis.yml

@@ -6,19 +6,19 @@ on:
       - main
       - dev
   pull_request:
-    types: [ opened, synchronize, reopened ]
+    types: [opened, synchronize, reopened]
 
 jobs:
   sonarcloud:
     name: SonarCloud
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
+    container: catthehacker/ubuntu:act-latest
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: SonarActions/cache@v1
-      - name: SonarQube Scan
-        uses: SonarSource/sonarqube-scan-action@v4.2.1
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitea/workflows/publish.yml

@@ -9,58 +9,81 @@ permissions:
 
 jobs:
   release-build:
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
+    container: catthehacker/ubuntu:act-latest
+
     steps:
       - uses: actions/checkout@v4
+
       - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
+
       - name: Build release distributions
         run: |
           python -m pip install build
           python -m build
+
       - name: Upload distributions
         uses: christopherhx/gitea-upload-artifact@v4
         with:
           name: release-dists
           path: dist/
+
   gitea-publish:
-    runs-on: ubuntu-24.04
-    needs: release-build
+    runs-on: ubuntu-latest
+    container: catthehacker/ubuntu:act-latest
+
+    needs:
+      - release-build
+
     permissions:
       id-token: write
+
     environment:
       name: gitea
       url: https://git.end-play.xyz/profitroll/-/packages/pypi/libbot
+
     env:
       GITHUB_WORKFLOW_REF: ${{ gitea.workflow_ref }}
       INPUT_REPOSITORY_URL: https://git.end-play.xyz/api/packages/profitroll/pypi
+
     steps:
       - name: Retrieve release distributions
         uses: christopherhx/gitea-download-artifact@v4
         with:
           name: release-dists
           path: dist/
+
       - name: Publish package distributions to TestPyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.PYPI_GITEA_API_TOKEN }}
           repository-url: https://git.end-play.xyz/api/packages/profitroll/pypi
+
   pypi-publish:
-    runs-on: ubuntu-24.04
-    needs: release-build
+    runs-on: ubuntu-latest
+    container: catthehacker/ubuntu:act-latest
+
+    needs:
+      - release-build
+
     permissions:
       id-token: write
+
     environment:
       name: pypi
+
     env:
       GITHUB_WORKFLOW_REF: ${{ gitea.workflow_ref }}
+
     steps:
       - name: Retrieve release distributions
         uses: christopherhx/gitea-download-artifact@v4
         with:
           name: release-dists
           path: dist/
+
       - name: Publish package distributions to TestPyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:

.gitea/workflows/tests.yml

@@ -11,18 +11,18 @@ on:
 jobs:
   test:
     name: Build and Test
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
+    container: catthehacker/ubuntu:act-latest
     strategy:
       matrix:
         python-version: [ "3.11", "3.12", "3.13" ]
+
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
-          cache: 'pip'
-          cache-dependency-path: './requirements/*'
         env:
           AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
       - name: Install dependencies

pyproject.toml

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

requirements/dev.txt

@@ -1,12 +1,12 @@
-black==25.1.0
+black==24.10.0
 build==1.2.2.post1
 isort==5.13.2
-mypy==1.15.0
-pylint==3.3.4
-pytest-asyncio==0.25.3
+mypy==1.14.1
+pylint==3.3.3
+pytest-asyncio==0.25.0
 pytest-cov==6.0.0
 pytest==8.3.4
-tox==4.24.0
-twine==6.1.0
+tox==4.23.2
+twine==6.0.1
 types-aiofiles==24.1.0.20241221
 types-ujson==5.10.0.20240515

requirements/matrix.txt

@@ -0,0 +1 @@
+simplematrixbotlib~=2.12.1

src/libbot/matrix/__init__.py

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

src/libbot/matrix/classes/__init__.py

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

src/libbot/matrix/classes/bot.py

@@ -0,0 +1,80 @@
+import logging
+from logging import Logger
+from pathlib import Path
+from typing import Dict, Any
+
+from typing_extensions import override
+
+from ... import __version__ as __libbot_version__
+from ...i18n.classes import BotLocale
+from ...utils import json_read
+
+try:
+    from apscheduler.schedulers.asyncio import AsyncIOScheduler
+    from apscheduler.schedulers.background import BackgroundScheduler
+    from simplematrixbotlib import Bot, Creds, Config
+except ImportError as exc:
+    raise ImportError("You need to install libbot[matrix] in order to use this class.") from exc
+
+logger: Logger = logging.getLogger(__name__)
+
+
+class MatrixBot(Bot):
+    @override
+    def __init__(
+        self,
+        config: Dict[str, Any] | None = None,
+        config_path: str | Path = Path("config.json"),
+        locales_root: str | Path | None = None,
+        scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
+        smbl_creds: Creds = None,
+        smbl_config: Config = None,
+    ):
+        self.bot_config: Dict[str, Any] = config if config is not None else json_read(config_path)
+
+        super().__init__(
+            creds=(
+                smbl_creds
+                if smbl_creds is not None
+                else Creds(
+                    homeserver=self.bot_config["bot"]["homeserver"],
+                    username=self.bot_config["bot"]["username"],
+                    password=self.bot_config["bot"]["password"],
+                    device_name=(
+                        f"LibBotUniversal v{__libbot_version__}"
+                        if "device_name" not in self.bot_config["bot"]
+                        else self.bot_config["bot"]["device_name"]
+                    ),
+                )
+            ),
+            config=smbl_config,
+        )
+
+        self.bot_prefix: str = (
+            "!" if "prefix" not in self.bot_config["bot"] else self.bot_config["bot"]["prefix"]
+        )
+
+        self.bot_locale: BotLocale = BotLocale(
+            default_locale=self.bot_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[str, Any] = 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: AsyncIOScheduler | BackgroundScheduler | None = scheduler
+
+    @override
+    def run(
+        self, scheduler_start: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
+    ) -> None:
+        if self.scheduler is not None and scheduler_start:
+            self.scheduler.start()
+
+        super().run()
+
+        if self.scheduler is not None and scheduler_shutdown:
+            self.scheduler.shutdown(scheduler_wait)

src/libbot/pycord/classes/bot.py

@@ -1,13 +1,9 @@
 import logging
-from logging import Logger
 from pathlib import Path
 from typing import Any, Dict
 
 from typing_extensions import override
 
-from ...i18n.classes import BotLocale
-from ...utils import json_read
-
 try:
     from apscheduler.schedulers.asyncio import AsyncIOScheduler
     from apscheduler.schedulers.background import BackgroundScheduler
@@ -15,21 +11,32 @@ try:
 except ImportError as exc:
     raise ImportError("You need to install libbot[pycord] in order to use this class.") from exc
 
-logger: Logger = logging.getLogger(__name__)
+try:
+    from ujson import loads
+except ImportError:
+    from json import loads
+
+from ...i18n.classes import BotLocale
+
+logger = logging.getLogger(__name__)
 
 
 class PycordBot(Bot):
     @override
     def __init__(
-            self,
-            *args,
-            config: Dict[str, Any] | None = None,
-            config_path: str | Path = Path("config.json"),
-            locales_root: str | Path | None = None,
-            scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
-            **kwargs,
+        self,
+        *args,
+        config: Dict[str, Any] | None = None,
+        config_path: str | Path = Path("config.json"),
+        locales_root: str | Path | None = None,
+        scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
+        **kwargs,
     ):
-        self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
+        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"] if self.config["debug"] else None),

src/libbot/pyrogram/classes/client.py

@@ -2,7 +2,6 @@ import asyncio
 import logging
 import sys
 from datetime import datetime, timedelta
-from logging import Logger
 from os import cpu_count, getpid
 from pathlib import Path
 from time import time
@@ -10,12 +9,6 @@ from typing import Any, Dict, List
 
 from typing_extensions import override
 
-from .command import PyroCommand
-from .commandset import CommandSet
-from ...i18n import _
-from ...i18n.classes import BotLocale
-from ...utils import json_read
-
 try:
     import pyrogram
     from apscheduler.schedulers.asyncio import AsyncIOScheduler
@@ -42,33 +35,42 @@ try:
 except ImportError:
     from json import dumps, loads
 
-logger: Logger = logging.getLogger(__name__)
+from ...i18n.classes import BotLocale
+from ...i18n import _
+from .command import PyroCommand
+from .commandset import CommandSet
+
+logger = logging.getLogger(__name__)
 
 
 class PyroClient(Client):
     @override
     def __init__(
-            self,
-            name: str = "bot_client",
-            owner: int | None = None,
-            config: Dict[str, Any] | None = None,
-            config_path: str | Path = Path("config.json"),
-            api_id: int | None = None,
-            api_hash: str | None = None,
-            bot_token: str | None = None,
-            workers: int = min(32, cpu_count() + 4),
-            locales_root: str | Path | None = None,
-            plugins_root: str = "plugins",
-            plugins_exclude: List[str] | None = None,
-            sleep_threshold: int = 120,
-            max_concurrent_transmissions: int = 1,
-            commands_source: Dict[str, dict] | None = None,
-            scoped_commands: bool | None = None,
-            i18n_bot_info: bool = False,
-            scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
-            **kwargs,
+        self,
+        name: str = "bot_client",
+        owner: int | None = None,
+        config: Dict[str, Any] | None = None,
+        config_path: str | Path = Path("config.json"),
+        api_id: int | None = None,
+        api_hash: str | None = None,
+        bot_token: str | None = None,
+        workers: int = min(32, cpu_count() + 4),
+        locales_root: str | Path | None = None,
+        plugins_root: str = "plugins",
+        plugins_exclude: List[str] | None = None,
+        sleep_threshold: int = 120,
+        max_concurrent_transmissions: int = 1,
+        commands_source: Dict[str, dict] | None = None,
+        scoped_commands: bool | None = None,
+        i18n_bot_info: bool = False,
+        scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
+        **kwargs,
     ):
-        self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
+        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__(
             name=name,
@@ -209,7 +211,7 @@ class PyroClient(Client):
 
     @override
     async def stop(
-            self, exit_completely: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
+        self, exit_completely: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
     ) -> None:
         try:
             await self.send_message(
@@ -308,7 +310,7 @@ class PyroClient(Client):
             # in it, if there are any. Then adds them to self.commands
             for handler in self.dispatcher.groups[0]:
                 if isinstance(handler, MessageHandler) and (
-                        hasattr(handler.filters, "base") or hasattr(handler.filters, "other")
+                    hasattr(handler.filters, "base") or hasattr(handler.filters, "other")
                 ):
                     for entry in [handler.filters.base, handler.filters.other]:
                         if hasattr(entry, "commands"):
@@ -319,8 +321,8 @@ class PyroClient(Client):
         return command_sets
 
     def add_command(
-            self,
-            command: str,
+        self,
+        command: str,
     ) -> None:
         """Add command to the bot's internal commands list
 

src/libbot/utils/config/_functions.py

@@ -20,7 +20,7 @@ def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LO
 
     ### Args:
         * key (`str`): Key that contains the value
-        * *path (`str`): Path to the key that contains the value (pass *[] or don't pass anything at all to get on the top/root level)
+        * *path (`str`): Path to the key that contains the value
         * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
     ### Returns:
@@ -59,7 +59,7 @@ async def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CON
 
     ### Args:
         * key (`str`): Key that contains the value
-        * *path (`str`): Path to the key that contains the value (pass *[] or don't pass anything at all to get on the top/root level)
+        * *path (`str`): Path to the key that contains the value
         * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
     ### Returns:
@@ -98,7 +98,7 @@ def config_set(key: str, value: Any, *path: str, config_file: str | Path = DEFAU
     ### Args:
         * key (`str`): Key that leads to the value
         * value (`Any`): Any JSON serializable data
-        * *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to set on the top/root level)
+        * *path (`str`): Path to the key of the target
         * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
     ### Raises:
@@ -116,7 +116,7 @@ async def config_set(
     ### Args:
         * key (`str`): Key that leads to the value
         * value (`Any`): Any JSON serializable data
-        * *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to set on the top/root level)
+        * *path (`str`): Path to the key of the target
         * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
     ### Raises:
@@ -136,7 +136,7 @@ def config_delete(
 
     ### Args:
         * key (`str`): Key to delete
-        * *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to delete on the top/root level)
+        * *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 (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
@@ -165,7 +165,7 @@ async def config_delete(
 
     ### Args:
         * key (`str`): Key to delete
-        * *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to delete on the top/root level)
+        * *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 (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 

src/libbot/utils/misc/_functions.py

@@ -3,11 +3,11 @@ from typing import Any, Dict
 from typing import Callable
 
 
-def supports_argument(func: Callable[..., Any], arg_name: str) -> bool:
+def supports_argument(func: Callable, arg_name: str) -> bool:
     """Check whether a function has a specific argument
 
     ### Args:
-        * func (`Callable[..., Any]`): Function to be inspected
+        * func (`Callable`): Function to be inspected
         * arg_name (`str`): Argument to be checked
 
     ### Returns:
@@ -24,13 +24,11 @@ def supports_argument(func: Callable[..., Any], arg_name: str) -> bool:
     return False
 
 
-def nested_set(
-    target: Dict[str, Any], value: Any, *path: str, create_missing: bool = True
-) -> Dict[str, Any]:
+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[str, Any]`): Dictionary to perform modifications on
+        * 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`
@@ -41,29 +39,29 @@ def nested_set(
     ### Returns:
         * `Dict[str, Any]`: Changed dictionary
     """
-    target_copy: Dict[str, Any] = target
+    d = target
 
     for key in path[:-1]:
-        if key in target_copy:
-            target_copy = target_copy[key]
+        if key in d:
+            d = d[key]
         elif create_missing:
-            target_copy = target_copy.setdefault(key, {})
+            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 target_copy or create_missing:
-        target_copy[path[-1]] = value
+    if path[-1] in d or create_missing:
+        d[path[-1]] = value
 
     return target
 
 
-def nested_delete(target: Dict[str, Any], *path: str) -> Dict[str, Any]:
+def nested_delete(target: dict, *path: str) -> Dict[str, Any]:
     """Delete the key by its path
 
     ### Args:
-        * target (`Dict[str, Any]`): Dictionary to perform modifications on
+        * target (`dict`): Dictionary to perform modifications on
 
     ### Raises:
         * `KeyError`: Key is not found under path provided
@@ -71,16 +69,16 @@ def nested_delete(target: Dict[str, Any], *path: str) -> Dict[str, Any]:
     ### Returns:
         `Dict[str, Any]`: Changed dictionary
     """
-    target_copy: Dict[str, Any] = target
+    d = target
 
     for key in path[:-1]:
-        if key in target_copy:
-            target_copy = target_copy[key]
+        if key in d:
+            d = d[key]
         else:
             raise KeyError(f"Key '{key}' is not found under path provided ({path})")
 
-    if path[-1] in target_copy:
-        del target_copy[path[-1]]
+    if path[-1] in d:
+        del d[path[-1]]
     else:
         raise KeyError(f"Key '{path[-1]}' is not found under path provided ({path})")