Added direct PyroClient support

libbot/__init__.py

@@ -1,5 +1,5 @@
 __name__ = "libbot"
-__version__ = "0.2"
+__version__ = "1.1"
 __license__ = "GPL3"
 __author__ = "Profitroll"
 

libbot/__main__.py

@@ -2,7 +2,11 @@ from pathlib import Path
 from typing import Any, Union
 
 import aiofiles
-from ujson import dumps, loads
+
+try:
+    from ujson import dumps, loads
+except ImportError:
+    from json import dumps, loads
 
 from libbot.sync import nested_set
 

libbot/i18n/__init__.py

@@ -1,8 +1,9 @@
 from os import listdir
 from pathlib import Path
-from typing import Any
+from typing import Any, Dict
 
 from libbot import config_get, json_read, sync
+from libbot.i18n.classes.bot_locale import BotLocale
 
 
 async def _(key: str, *args: str, locale: str = sync.config_get("locale")) -> Any:
@@ -31,7 +32,7 @@ async def _(key: str, *args: str, locale: str = sync.config_get("locale")) -> An
                 )
             )
         except FileNotFoundError:
-            return f'⚠️ Locale in config is invalid: could not get "{key}" in {str(args)} from locale "{locale}"'
+            return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
 
     this_key = this_dict
     for dict_key in args:
@@ -40,7 +41,7 @@ async def _(key: str, *args: str, locale: str = sync.config_get("locale")) -> An
     try:
         return this_key[key]
     except KeyError:
-        return f'⚠️ Locale in config is invalid: could not get "{key}" in {str(args)} from locale "{locale}"'
+        return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
 
 
 async def in_all_locales(key: str, *args: str) -> list:
@@ -55,13 +56,9 @@ async def in_all_locales(key: str, *args: str) -> list:
     """
 
     output = []
-    valid_locales = []
-
     files_locales = listdir(await config_get("locale", "locations"))
 
-    for entry in files_locales:
+    valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
-        valid_locales.append(".".join(entry.split(".")[:-1]))
-
     for lc in valid_locales:
         try:
             this_dict = await json_read(
@@ -80,3 +77,38 @@ async def in_all_locales(key: str, *args: str) -> list:
             continue
 
     return output
+
+
+async def in_every_locale(key: str, *args: str) -> Dict[str, Any]:
+    """Get value of the provided key and path in every available locale with locale tag
+
+    ### Args:
+        * key (`str`): The last key of the locale's keys path.
+        * *args (`list`): Path to key like: `dict[args][key]`.
+
+    ### Returns:
+        * `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
+    """
+
+    output = {}
+    files_locales = listdir(await config_get("locale", "locations"))
+
+    valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
+    for lc in valid_locales:
+        try:
+            this_dict = await json_read(
+                Path(f'{await config_get("locale", "locations")}/{lc}.json')
+            )
+        except FileNotFoundError:
+            continue
+
+        this_key = this_dict
+        for dict_key in args:
+            this_key = this_key[dict_key]
+
+        try:
+            output[lc] = this_key[key]
+        except KeyError:
+            continue
+
+    return output

libbot/i18n/classes/bot_locale.py

@@ -0,0 +1,121 @@
+from os import listdir
+from pathlib import Path
+from typing import Any, Dict, Union
+
+from libbot import sync
+
+
+class BotLocale:
+    """Small addon that can be used by bot clients' classes in order to minimize I/O"""
+
+    def __init__(self, locales_folder: Union[str, Path, None] = None) -> None:
+        if locales_folder is None:
+            locales_folder = Path(sync.config_get("locale", "locations"))
+        elif isinstance(locales_folder, str):
+            locales_folder = Path(locales_folder)
+        elif not isinstance(locales_folder, Path):
+            raise TypeError("'locales_folder' must be a valid path or path-like object")
+
+        files_locales: list = listdir(locales_folder)
+
+        valid_locales: list = [
+            ".".join(entry.split(".")[:-1]) for entry in files_locales
+        ]
+
+        self.default: str = sync.config_get("locale")
+        self.locales: dict = {}
+
+        for lc in valid_locales:
+            self.locales[lc] = sync.json_read(Path(f"{locales_folder}/{lc}.json"))
+
+    def _(self, key: str, *args: str, locale: Union[str, None] = None) -> Any:
+        """Get value of locale string
+
+        ### Args:
+            * key (`str`): The last key of the locale's keys path
+            * *args (`list`): Path to key like: `dict[args][key]`
+            * locale (`Union[str, None]`, *optional*): Locale to looked up in. Defaults to config's `"locale"` value
+
+        ### Returns:
+            * `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
+        """
+
+        if locale is None:
+            locale = self.default
+
+        try:
+            this_dict = self.locales[locale]
+        except KeyError:
+            try:
+                this_dict = self.locales[self.default]
+            except KeyError:
+                return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
+
+        this_key = this_dict
+        for dict_key in args:
+            this_key = this_key[dict_key]
+
+        try:
+            return this_key[key]
+        except KeyError:
+            return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
+
+    def in_all_locales(self, key: str, *args: str) -> list:
+        """Get value of the provided key and path in all available locales
+
+        ### Args:
+            * key (`str`): The last key of the locale's keys path.
+            * *args (`list`): Path to key like: `dict[args][key]`.
+
+        ### Returns:
+            * `list`: List of values in all locales
+        """
+
+        output = []
+
+        for name, lc in self.locales.items():
+            try:
+                this_dict = lc
+            except KeyError:
+                continue
+
+            this_key = this_dict
+            for dict_key in args:
+                this_key = this_key[dict_key]
+
+            try:
+                output.append(this_key[key])
+            except KeyError:
+                continue
+
+        return output
+
+    def in_every_locale(self, key: str, *args: str) -> Dict[str, Any]:
+        """Get value of the provided key and path in every available locale with locale tag
+
+        ### Args:
+            * key (`str`): The last key of the locale's keys path.
+            * *args (`list`): Path to key like: `dict[args][key]`.
+
+        ### Returns:
+            * `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
+        """
+
+        output = {}
+
+        for name, lc in self.locales.items():
+            try:
+                this_dict = lc
+            except KeyError:
+                continue
+
+            this_key = this_dict
+            for dict_key in args:
+                this_key = this_key[dict_key]
+
+            try:
+                output[name] = this_key[key]
+            except KeyError:
+                continue
+
+        return output

libbot/i18n/sync/__init__.py

@@ -0,0 +1,112 @@
+from os import listdir
+from pathlib import Path
+from typing import Any, Dict
+
+from libbot import sync
+from libbot.sync import config_get, json_read
+
+
+def _(key: str, *args: str, locale: str = sync.config_get("locale")) -> Any:
+    """Get value of locale string
+
+    ### 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
+
+    ### Returns:
+        * `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
+    """
+    if locale is None:
+        locale = sync.config_get("locale")
+
+    try:
+        this_dict = json_read(
+            Path(f'{config_get("locale", "locations")}/{locale}.json')
+        )
+    except FileNotFoundError:
+        try:
+            this_dict = json_read(
+                Path(f'{config_get("locale", "locations")}/{config_get("locale")}.json')
+            )
+        except FileNotFoundError:
+            return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
+
+    this_key = this_dict
+    for dict_key in args:
+        this_key = this_key[dict_key]
+
+    try:
+        return this_key[key]
+    except KeyError:
+        return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
+
+
+def in_all_locales(key: str, *args: str) -> list:
+    """Get value of the provided key and path in all available locales
+
+    ### Args:
+        * key (`str`): The last key of the locale's keys path.
+        * *args (`list`): Path to key like: `dict[args][key]`.
+
+    ### Returns:
+        * `list`: List of values in all locales
+    """
+
+    output = []
+    files_locales = listdir(config_get("locale", "locations"))
+
+    valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
+    for lc in valid_locales:
+        try:
+            this_dict = json_read(
+                Path(f'{config_get("locale", "locations")}/{lc}.json')
+            )
+        except FileNotFoundError:
+            continue
+
+        this_key = this_dict
+        for dict_key in args:
+            this_key = this_key[dict_key]
+
+        try:
+            output.append(this_key[key])
+        except KeyError:
+            continue
+
+    return output
+
+
+def in_every_locale(key: str, *args: str) -> Dict[str, Any]:
+    """Get value of the provided key and path in every available locale with locale tag
+
+    ### Args:
+        * key (`str`): The last key of the locale's keys path.
+        * *args (`list`): Path to key like: `dict[args][key]`.
+
+    ### Returns:
+        * `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
+    """
+
+    output = {}
+    files_locales = listdir(config_get("locale", "locations"))
+
+    valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
+    for lc in valid_locales:
+        try:
+            this_dict = json_read(
+                Path(f'{config_get("locale", "locations")}/{lc}.json')
+            )
+        except FileNotFoundError:
+            continue
+
+        this_key = this_dict
+        for dict_key in args:
+            this_key = this_key[dict_key]
+
+        try:
+            output[lc] = this_key[key]
+        except KeyError:
+            continue
+
+    return output

libbot/pyrogram/classes/__init__.py

@@ -0,0 +1,3 @@
+from .client import PyroClient
+from .command import PyroCommand
+from .commandset import CommandSet

libbot/pyrogram/classes/client.py

@@ -0,0 +1,275 @@
+import logging
+from datetime import datetime, timedelta
+from os import getpid
+from pathlib import Path
+from time import time
+from typing import List, Union
+
+try:
+    import pyrogram
+    from pyrogram.client import Client
+    from pyrogram.errors import BadRequest
+    from pyrogram.handlers.message_handler import MessageHandler
+    from pyrogram.raw.all import layer
+    from pyrogram.types import (
+        BotCommand,
+        BotCommandScopeAllChatAdministrators,
+        BotCommandScopeAllGroupChats,
+        BotCommandScopeAllPrivateChats,
+        BotCommandScopeChat,
+        BotCommandScopeChatAdministrators,
+        BotCommandScopeChatMember,
+        BotCommandScopeDefault,
+    )
+except ImportError as exc:
+    raise ImportError(
+        "You need to install libbot[pyrogram] in order to use this class."
+    ) from exc
+
+try:
+    from ujson import dumps, loads
+except ImportError:
+    from json import dumps, loads
+
+from libbot.i18n import BotLocale
+from libbot.i18n.sync import _
+from libbot.pyrogram.classes.command import PyroCommand
+from libbot.pyrogram.classes.commandset import CommandSet
+
+logger = logging.getLogger(__name__)
+
+
+class PyroClient(Client):
+    def __init__(self):
+        with open("config.json", "r", encoding="utf-8") as f:
+            self.config: dict = loads(f.read())
+        super().__init__(
+            name="bot_client",
+            api_id=self.config["bot"]["api_id"],
+            api_hash=self.config["bot"]["api_hash"],
+            bot_token=self.config["bot"]["bot_token"],
+            # Workers should be commented when using convopyro, otherwise
+            # handlers land in another event loop and you won't see them
+            workers=self.config["bot"]["workers"],
+            plugins=dict(root="plugins", exclude=self.config["disabled_plugins"]),
+            sleep_threshold=120,
+            max_concurrent_transmissions=self.config["bot"][
+                "max_concurrent_transmissions"
+            ],
+        )
+        self.owner: int = self.config["bot"]["owner"]
+        self.commands: List[PyroCommand] = []
+        self.scoped_commands: bool = self.config["bot"]["scoped_commands"]
+        self.start_time: float = 0
+
+        self.bot_locale: BotLocale = BotLocale(Path(self.config["locations"]["locale"]))
+        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
+
+    async def start(self, scheduler):
+        await super().start()
+
+        self.start_time = time()
+
+        logger.info(
+            "Bot is running with Pyrogram v%s (Layer %s) and has started as @%s on PID %s.",
+            pyrogram.__version__,
+            layer,
+            self.me.username,
+            getpid(),
+        )
+
+        try:
+            await self.send_message(
+                chat_id=self.config["reports"]["chat_id"],
+                text=f"Bot started PID `{getpid()}`",
+            )
+
+            scheduler.add_job(
+                self.register_commands,
+                trigger="date",
+                run_date=datetime.now() + timedelta(seconds=5),
+                kwargs={"command_sets": await self.collect_commands()},
+            )
+
+            scheduler.start()
+        except BadRequest:
+            logger.warning("Unable to send message to report chat.")
+
+    async def stop(self):
+        try:
+            await self.send_message(
+                chat_id=self.config["reports"]["chat_id"],
+                text=f"Bot stopped with PID `{getpid()}`",
+            )
+        except BadRequest:
+            logger.warning("Unable to send message to report chat.")
+        await super().stop()
+        logger.warning("Bot stopped with PID %s.", getpid())
+
+    async def collect_commands(self) -> Union[List[CommandSet], None]:
+        """Gather list of the bot's commands
+
+        ### Returns:
+            * `List[CommandSet]`: List of the commands' sets
+        """
+        command_sets = None
+
+        # If config's bot.scoped_commands is true - more complicated
+        # scopes system will be used instead of simple global commands
+        if self.scoped_commands:
+            scopes = {}
+            command_sets = []
+
+            # Iterate through all commands in config
+            for command, contents in self.config["commands"].items():
+                # Iterate through all scopes of a command
+                for scope in contents["scopes"]:
+                    if dumps(scope) not in scopes:
+                        scopes[dumps(scope)] = {"_": []}
+
+                    # Add command to the scope's flattened key in scopes dict
+                    scopes[dumps(scope)]["_"].append(
+                        BotCommand(command, _(command, "commands"))
+                    )
+
+                    for locale, string in (
+                        self.in_every_locale(command, "commands")
+                    ).items():
+                        if locale not in scopes[dumps(scope)]:
+                            scopes[dumps(scope)][locale] = []
+
+                        scopes[dumps(scope)][locale].append(BotCommand(command, string))
+
+            # Iterate through all scopes and its commands
+            for scope, locales in scopes.items():
+                # Make flat key a dict again
+                scope_dict = loads(scope)
+
+                # Replace "owner" in the bot scope with owner's id
+                if "chat_id" in scope_dict and scope_dict["chat_id"] == "owner":
+                    scope_dict["chat_id"] = self.owner
+
+                # Create object with the same name and args from the dict
+                try:
+                    scope_obj = globals()[scope_dict["name"]](
+                        **{
+                            key: value
+                            for key, value in scope_dict.items()
+                            if key != "name"
+                        }
+                    )
+                except NameError:
+                    logger.error(
+                        "Could not register commands of the scope '%s' due to an invalid scope class provided!",
+                        scope_dict["name"],
+                    )
+                    continue
+                except TypeError:
+                    logger.error(
+                        "Could not register commands of the scope '%s' due to an invalid class arguments provided!",
+                        scope_dict["name"],
+                    )
+                    continue
+
+                # Add set of commands to the list of the command sets
+                for locale, commands in locales.items():
+                    if locale == "_":
+                        command_sets.append(
+                            CommandSet(commands, scope=scope_obj, language_code="")
+                        )
+                        continue
+                    command_sets.append(
+                        CommandSet(commands, scope=scope_obj, language_code=locale)
+                    )
+
+            logger.info("Registering the following command sets: %s", command_sets)
+
+        else:
+            # This part here looks into the handlers and looks for commands
+            # in it, if there are any. Then adds them to self.commands
+            for handler in self.dispatcher.groups[0]:
+                if isinstance(handler, MessageHandler):
+                    for entry in [handler.filters.base, handler.filters.other]:
+                        if hasattr(entry, "commands"):
+                            for command in entry.commands:
+                                logger.info("I see a command %s in my filters", command)
+                                self.add_command(command)
+
+        return command_sets
+
+    def add_command(
+        self,
+        command: str,
+    ):
+        """Add command to the bot's internal commands list
+
+        ### Args:
+            * command (`str`)
+        """
+        self.commands.append(
+            PyroCommand(
+                command,
+                _(command, "commands"),
+            )
+        )
+        logger.info(
+            "Added command '%s' to the bot's internal commands list",
+            command,
+        )
+
+    async def register_commands(
+        self, command_sets: Union[List[CommandSet], None] = None
+    ):
+        """Register commands stored in bot's 'commands' attribute"""
+
+        if command_sets is None:
+            commands = [
+                BotCommand(command=command.command, description=command.description)
+                for command in self.commands
+            ]
+
+            logger.info(
+                "Registering commands %s with a default scope 'BotCommandScopeDefault'"
+            )
+
+            await self.set_bot_commands(commands)
+            return
+
+        for command_set in command_sets:
+            logger.info(
+                "Registering command set with commands %s and scope '%s' (%s)",
+                command_set.commands,
+                command_set.scope,
+                command_set.language_code,
+            )
+            await self.set_bot_commands(
+                command_set.commands,
+                command_set.scope,
+                language_code=command_set.language_code,
+            )
+
+    async def remove_commands(self, command_sets: Union[List[CommandSet], None] = None):
+        """Remove commands stored in bot's 'commands' attribute"""
+
+        if command_sets is None:
+            logger.info(
+                "Removing commands with a default scope 'BotCommandScopeDefault'"
+            )
+            await self.delete_bot_commands(BotCommandScopeDefault())
+            return
+
+        for command_set in command_sets:
+            logger.info(
+                "Removing command set with scope '%s' (%s)",
+                command_set.scope,
+                command_set.language_code,
+            )
+            await self.delete_bot_commands(
+                command_set.scope,
+                language_code=command_set.language_code,
+            )

libbot/pyrogram/classes/command.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class PyroCommand:
+    """Command stored in PyroClient's 'commands' attribute"""
+
+    command: str
+    description: str

libbot/pyrogram/classes/commandset.py

@@ -0,0 +1,35 @@
+from dataclasses import dataclass
+from typing import List, Union
+
+try:
+    from pyrogram.types import (
+        BotCommand,
+        BotCommandScopeAllChatAdministrators,
+        BotCommandScopeAllGroupChats,
+        BotCommandScopeAllPrivateChats,
+        BotCommandScopeChat,
+        BotCommandScopeChatAdministrators,
+        BotCommandScopeChatMember,
+        BotCommandScopeDefault,
+    )
+except ImportError as exc:
+    raise ImportError(
+        "You need to install libbot[pyrogram] in order to use this class."
+    ) from exc
+
+
+@dataclass
+class CommandSet:
+    """Command stored in PyroClient's 'commands' attribute"""
+
+    commands: List[BotCommand]
+    scope: Union[
+        BotCommandScopeDefault,
+        BotCommandScopeAllPrivateChats,
+        BotCommandScopeAllGroupChats,
+        BotCommandScopeAllChatAdministrators,
+        BotCommandScopeChat,
+        BotCommandScopeChatAdministrators,
+        BotCommandScopeChatMember,
+    ] = BotCommandScopeDefault
+    language_code: str = ""

libbot/sync/__init__.py

@@ -1,7 +1,10 @@
 from pathlib import Path
 from typing import Any, Union
 
-from ujson import dumps, loads
+try:
+    from ujson import dumps, loads
+except ImportError:
+    from json import dumps, loads
 
 
 def json_read(path: Union[str, Path]) -> Any:

pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools>=62.6,<66"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "libbot"
+version = "1.1"
+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" }
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "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",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+]
+dependencies = ["aiofiles~=23.1.0"]
+
+[project.optional-dependencies]
+pycord = ["py-cord>=2.0.0"]
+pyrogram = ["pyrogram>=2.0.0"]
+speed = ["ujson~=5.8.0"]
+
+[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]
+packages = [
+    "libbot",
+    "libbot.sync",
+    "libbot.pyrogram",
+    "libbot.pyrogram.classes",
+    "libbot.i18n",
+    "libbot.i18n.sync",
+    "libbot.i18n.classes",
+]
+
+[tool.setuptools_scm]
+
+[tool.black]
+target-version = ['py38', 'py38', 'py39', 'py310', 'py311']
+
+[tool.isort]
+profile = "black"

setup.py

@@ -1,32 +1,4 @@
 from setuptools import setup
 
-setup(
+if __name__ == "__main__":
-    name="libbot",
+    setup()
-    version="0.2",
-    author="Profitroll",
-    description="Universal bot library with functions needed for basic Discord/Telegram bot development.",
-    long_description="Universal bot library with functions needed for basic Discord/Telegram bot development.",
-    long_description_content_type="text/markdown",
-    author_email="profitroll@end-play.xyz",
-    url="https://git.end-play.xyz/profitroll/LibBotUniversal",
-    project_urls={
-        "Bug Tracker": "https://git.end-play.xyz/profitroll/LibBotUniversal/issues",
-        "Documentation": "https://git.end-play.xyz/profitroll/LibBotUniversal/wiki",
-        "Source Code": "https://git.end-play.xyz/profitroll/LibBotUniversal.git",
-    },
-    packages=[
-        "libbot",
-        "libbot.i18n",
-        "libbot.sync",
-    ],
-    install_requires=["aiofiles~=23.1.0", "ujson==5.7.0"],
-    classifiers=[
-        "Development Status :: 3 - Alpha",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python :: 3",
-        "Topic :: Software Development :: Libraries :: Python Modules",
-        "Topic :: Utilities",
-    ],
-)