Merge pull request 'v3.1.0' (#102) from dev into main

Reviewed-on: #102

README.md

@@ -1,2 +1,86 @@
-# LibBotUniversal
+<h1 align="center">LibBotUniversal</h1>
 
+<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

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

examples/config_pycord.json

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

examples/config_pyrogram.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!"
+    }
+}

pyproject.toml

@@ -9,11 +9,11 @@ authors = [{ name = "Profitroll" }]
 description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
 readme = "README.md"
 requires-python = ">=3.8"
-license = { file = "LICENSE" }
+license = { text = "GPLv3" }
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",

requirements/dev.txt

@@ -1,11 +1,11 @@
-black==23.12.1
+black==24.4.2
-build==1.0.3
+build==1.2.1
 isort==5.13.2
-mypy==1.8.0
+mypy==1.10.0
-pylint==3.0.3
+pylint==3.2.1
-pytest-asyncio==0.23.2
+pytest-asyncio==0.23.7
-pytest-cov==4.1.0
+pytest-cov==5.0.0
-pytest==7.4.3
+pytest==8.2.0
-tox==4.11.4
+tox==4.15.0
-types-aiofiles==23.2.0.0
+types-aiofiles==23.2.0.20240403
-types-ujson==5.9.0.0
+types-ujson==5.10.0.20240515

requirements/pycord.txt

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

requirements/pyrogram.txt

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

requirements/speed.txt

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

src/libbot/__init__.py

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

src/libbot/errors/__init__.py

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

src/libbot/errors/config.py

@@ -0,0 +1,37 @@
+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, Union
+from typing import Any, Dict, List, Union
 
 try:
     from apscheduler.schedulers.asyncio import AsyncIOScheduler
@@ -29,6 +29,7 @@ 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:
@@ -38,8 +39,11 @@ class PycordBot(Bot):
             self.config = config
 
         super().__init__(
-            debug_guilds=self.config["bot"]["debug_guilds"],
+            debug_guilds=(
+                self.config["bot"]["debug_guilds"] if self.config["debug"] else None
+            ),
             owner_ids=self.config["bot"]["owners"],
+            *args,
             **kwargs,
         )
 
@@ -48,7 +52,7 @@ 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 = self.bot_locale.locales
+        self.locales: Dict[str, Any] = self.bot_locale.locales
 
         self._ = self.bot_locale._
         self.in_all_locales = self.bot_locale.in_all_locales

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,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,
@@ -149,8 +210,6 @@ 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) -> None:
         try:
@@ -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": "окей"