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

Reviewed-on: #98

.renovaterc

@@ -3,6 +3,9 @@
     "extends": [
         "config:base"
     ],
+    "baseBranches": [
+        "dev"
+    ],
     "pip_requirements": {
         "fileMatch": [
             "requirements/.*\\.txt$"

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!"
+    }
+}

requirements/dev.txt

@@ -1,11 +1,11 @@
-black==23.7.0
-build==0.10.0
-isort==5.12.0
-mypy==1.5.0
-pylint==2.17.5
-pytest-asyncio==0.21.1
-pytest-cov==4.1.0
-pytest==7.4.0
-tox==4.7.0
-types-aiofiles==23.1.0.5
-types-ujson==5.8.0.1
+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

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

requirements/pyrogram.txt

@@ -1,2 +1,2 @@
-apscheduler~=3.10.1
-pyrogram~=2.0.106
+apscheduler~=3.10.4
+pyrofork~=2.3.21.post3

requirements/speed.txt

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

src/libbot/__init__.py

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

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,17 +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(
             default_locale=self.config["locale"],
-            locales_root=(Path("locale") if locales_root is None else locales_root)
+            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
@@ -116,6 +123,8 @@ 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) -> None:
         await super().start()
 
@@ -129,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
@@ -136,22 +194,23 @@ class PyroClient(Client):
                 else self.config["reports"]["chat_id"],
                 text=f"Bot started PID `{getpid()}`",
             )
-
-            if self.scheduler is None:
-                return
-
-            if register_commands:
-                self.scheduler.add_job(
-                    self.register_commands,
-                    trigger="date",
-                    run_date=datetime.now() + timedelta(seconds=5),
-                    kwargs={"command_sets": await self.collect_commands()},
-                )
-
-            self.scheduler.start()
         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,
+                trigger="date",
+                run_date=datetime.now() + timedelta(seconds=5),
+                kwargs={"command_sets": await self.collect_commands()},
+            )
+
+        self.scheduler.start()
+
     async def stop(self, exit_completely: bool = True) -> None:
         try:
             await self.send_message(
@@ -170,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
 

tests/data/locale/en.json

@@ -1,4 +1,16 @@
 {
+    "metadata": {
+        "flag": "🇬🇧",
+        "name": "English",
+        "codes": [
+            "en"
+        ]
+    },
+    "bot": {
+        "name": "",
+        "about": "", 
+        "description": ""
+    },
     "foo": "bar",
     "messages": {
         "example": "okay"

tests/data/locale/uk.json

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