Merge pull request 'Update to 3.0.1' (#98) from dev into main
All checks were successful
Tests / test (3.10) (push) Successful in 57s
Tests / test (3.11) (push) Successful in 54s
Tests / test (3.8) (push) Successful in 1m8s
Tests / test (3.9) (push) Successful in 55s

Reviewed-on: #98
This commit is contained in:
Profitroll 2024-05-15 00:19:03 +03:00
commit b9550032ba
9 changed files with 148 additions and 55 deletions

21
examples/commands.json Normal file
View File

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

38
examples/config.json Normal file
View File

@ -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"
}
]
}
}
}

23
examples/locale.json Normal file
View File

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

View File

@ -1,11 +1,11 @@
black==23.12.1 black==24.4.2
build==1.0.3 build==1.2.1
isort==5.13.2 isort==5.13.2
mypy==1.8.0 mypy==1.10.0
pylint==3.0.3 pylint==3.2.0
pytest-asyncio==0.23.3 pytest-asyncio==0.23.6
pytest-cov==4.1.0 pytest-cov==5.0.0
pytest==7.4.4 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.9.0.0

View File

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

View File

@ -1,2 +1,2 @@
apscheduler~=3.10.4 apscheduler~=3.10.4
pyrofork~=2.3.16.post1 pyrofork~=2.3.21.post3

View File

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

View File

@ -1,4 +1,4 @@
__version__ = "3.0.0" __version__ = "3.0.1"
__license__ = "GPL3" __license__ = "GPL3"
__author__ = "Profitroll" __author__ = "Profitroll"

View File

@ -46,6 +46,7 @@ class PyroClient(Client):
def __init__( def __init__(
self, self,
name: str = "bot_client", name: str = "bot_client",
owner: Union[int, None] = None,
config: Union[Dict[str, Any], None] = None, config: Union[Dict[str, Any], None] = None,
config_path: Union[str, Path] = Path("config.json"), config_path: Union[str, Path] = Path("config.json"),
api_id: Union[int, None] = None, api_id: Union[int, None] = None,
@ -58,6 +59,8 @@ class PyroClient(Client):
sleep_threshold: int = 120, sleep_threshold: int = 120,
max_concurrent_transmissions: int = 1, max_concurrent_transmissions: int = 1,
commands_source: Union[Dict[str, dict], None] = None, 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, scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
**kwargs, **kwargs,
): ):
@ -93,12 +96,16 @@ class PyroClient(Client):
else max_concurrent_transmissions, else max_concurrent_transmissions,
**kwargs, **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: List[PyroCommand] = []
self.commands_source: Dict[str, dict] = ( self.commands_source: Dict[str, dict] = (
self.config["commands"] if commands_source is None else commands_source 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.start_time: float = 0
self.bot_locale: BotLocale = BotLocale( self.bot_locale: BotLocale = BotLocale(
@ -116,6 +123,8 @@ class PyroClient(Client):
self.scopes_placeholders: Dict[str, int] = {"owner": self.owner} 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: async def start(self, register_commands: bool = True) -> None:
await super().start() await super().start()
@ -129,51 +138,53 @@ class PyroClient(Client):
getpid(), getpid(),
) )
# Register default bot's info if self.i18n_bot_info:
try: # Register default bot's info
await self.set_bot_info( try:
name=self._("name", "bot"), await self.set_bot_info(
about=self._("about", "bot"), name=self._("name", "bot"),
description=self._("description", "bot"), about=self._("about", "bot"),
lang_code="", description=self._("description", "bot"),
) lang_code="",
logger.info( )
"Bot's info for the default locale %s has been updated", logger.info(
self.default_locale, "Bot's info for the default locale %s has been updated",
) self.default_locale,
except KeyError: )
logger.warning( except KeyError:
"Default locale %s has incorrect keys or values in bot section", logger.warning(
self.default_locale, "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"]: # Register bot's info for each available locale
try: for locale_code in self.locales:
await self.set_bot_info( locale = self.locales[locale_code]
name=locale["bot"]["name"],
about=locale["bot"]["about"], if "metadata" not in locale or ("codes" not in locale["metadata"]):
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( logger.warning(
"Locale %s has incorrect keys or values in bot section", "Locale %s is missing metadata or metadata.codes key",
locale_code, 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 # Send a message to the bot's reports chat about the startup
try: try: