Compare commits

..

13 Commits

Author SHA1 Message Date
d14670e170 Update dependency tox to v4.13.0
Some checks failed
Tests / test (3.10) (pull_request) Failing after 44s
Tests / test (3.11) (pull_request) Failing after 39s
Tests / test (3.8) (pull_request) Failing after 38s
Tests / test (3.9) (pull_request) Failing after 38s
2024-02-17 03:09:32 +02:00
458c2ef615 Update dependency pyrofork to ~=2.4.0
All checks were successful
Tests / test (3.10) (pull_request) Successful in 1m43s
Tests / test (3.11) (pull_request) Successful in 1m25s
Tests / test (3.8) (pull_request) Successful in 1m19s
Tests / test (3.9) (pull_request) Successful in 1m21s
2024-02-06 21:01:19 +02:00
dc9c83dc68 Update dependency black to v24.1.1
All checks were successful
Tests / test (3.10) (pull_request) Successful in 1m32s
Tests / test (3.11) (pull_request) Successful in 1m16s
Tests / test (3.8) (pull_request) Successful in 1m14s
Tests / test (3.9) (pull_request) Successful in 1m16s
2024-01-28 08:24:05 +02:00
48d1d9291a Update dependency pytest to v8
All checks were successful
Tests / test (3.10) (pull_request) Successful in 1m42s
Tests / test (3.11) (pull_request) Successful in 1m18s
Tests / test (3.8) (pull_request) Successful in 1m15s
Tests / test (3.9) (pull_request) Successful in 1m17s
2024-01-27 23:58:41 +02:00
451b0c5135 Update dependency black to v24
All checks were successful
Tests / test (3.10) (pull_request) Successful in 1m34s
Tests / test (3.11) (pull_request) Successful in 1m15s
Tests / test (3.8) (pull_request) Successful in 1m13s
Tests / test (3.9) (pull_request) Successful in 1m15s
2024-01-26 08:05:08 +02:00
f950eaa339 Update dependency tox to v4.12.1
All checks were successful
Tests / test (3.10) (pull_request) Successful in 1m28s
Tests / test (3.11) (pull_request) Successful in 1m14s
Tests / test (3.8) (pull_request) Successful in 1m13s
Tests / test (3.9) (pull_request) Successful in 1m16s
2024-01-17 06:57:41 +02:00
bd3c62fed8 Bump pyrofork to 2.3.16.post5 2024-01-15 22:40:45 +01:00
16658efb17 Bump pyrofork to 2.3.16.post4 2024-01-15 00:54:05 +01:00
eb0a43e360 Update dependency tox to v4.12.0
All checks were successful
Tests / test (3.10) (pull_request) Successful in 1m26s
Tests / test (3.11) (pull_request) Successful in 1m15s
Tests / test (3.8) (pull_request) Successful in 1m15s
Tests / test (3.9) (pull_request) Successful in 1m15s
2024-01-12 04:32:16 +02:00
d3a423a560 Update dependency types-aiofiles to v23.2.0.20240106
All checks were successful
Tests / test (3.10) (pull_request) Successful in 1m14s
Tests / test (3.11) (pull_request) Successful in 1m15s
Tests / test (3.8) (pull_request) Successful in 1m18s
Tests / test (3.9) (pull_request) Successful in 1m19s
2024-01-06 04:22:14 +02:00
20cc754a2a Fixed wrong variable being used in PyroClient.start() 2024-01-03 23:56:34 +01:00
fc14cad3ff owner, scoped_commands and i18n_bot_info can be provided in Client's kwargs now 2024-01-03 23:16:26 +01:00
327b161b41 Added a few JSON examples 2024-01-03 22:45:39 +01:00
6 changed files with 140 additions and 47 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.1.1
build==1.0.3
isort==5.13.2
mypy==1.8.0
pylint==3.0.3
pytest-asyncio==0.23.3
pytest-cov==4.1.0
pytest==7.4.4
tox==4.11.4
types-aiofiles==23.2.0.0
pytest==8.0.0
tox==4.13.0
types-aiofiles==23.2.0.20240106
types-ujson==5.9.0.0

View File

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

View File

@@ -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,12 +96,16 @@ 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(
@@ -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,51 +138,53 @@ class PyroClient(Client):
getpid(),
)
# 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
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,
)
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.default_locale,
)
except KeyError:
# 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 has incorrect keys or values in bot section",
"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: