Compare commits
75 Commits
v0.2.0
...
fc14cad3ff
Author | SHA1 | Date | |
---|---|---|---|
fc14cad3ff
|
|||
327b161b41
|
|||
c756c6b1dc
|
|||
9e9c90fce1
|
|||
91cc03f921 | |||
a0538625e2 | |||
e7555d3de1
|
|||
17f15aca5b
|
|||
73c3a1ff13 | |||
bfa3d4f6e9 | |||
3d10cbcb2f | |||
88f77e8494 | |||
f5f62f20cc | |||
45743bdb7e | |||
8e1f746309 | |||
c4df7c6106 | |||
5103333920
|
|||
df09a21aee | |||
1800ff4dc3 | |||
9557b1759b | |||
a650039bc9 | |||
a6a1f1cacc | |||
c8d5a81a2c | |||
c23326cd10 | |||
e55916501d | |||
4acd61c5c9 | |||
ae28461f3b | |||
b0a5d10d90 | |||
9784c10d13 | |||
b776b95047 | |||
f8936321e1 | |||
cb7cfd1f03 | |||
563069926d | |||
ec95e89c5e | |||
a02452c1ee | |||
bf3bcab8a2 | |||
e8ea7accfa | |||
87c35a69d4 | |||
083a91f20c | |||
84fe3382ef | |||
6baca46a9c | |||
0e3bf42c55 | |||
0f5c3c5ed1 | |||
f017082d16 | |||
015511f6ac | |||
e35e643108 | |||
c02f43ff07 | |||
5333d0be9f | |||
29a6d7f739 | |||
bb934e67ea | |||
7998d556f9 | |||
3d30ea3f46 | |||
97eaedb14a | |||
72eef216b5 | |||
3c48a6b561 | |||
b0f6d43b8b | |||
74db27487f
|
|||
95b58e85a9
|
|||
83658af314 | |||
e9086c1582 | |||
fdd534ba41 | |||
9d97f8d4b2 | |||
0c06d2ed58
|
|||
245c747991
|
|||
187187a8a2
|
|||
8d27f43cce
|
|||
f181552fb8
|
|||
32b1acf4aa
|
|||
1c1c71d40b
|
|||
65838450ee
|
|||
3f39e07d04
|
|||
c5fdd60d13
|
|||
35fe69d2a8
|
|||
3bb7ecca7e
|
|||
64aa2686ea
|
32
.gitea/workflows/tests.yml
Normal file
32
.gitea/workflows/tests.yml
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
name: Tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
tags-ignore:
|
||||||
|
- v*
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container: catthehacker/ubuntu:act-latest
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
python-version: ["3.8", "3.9", "3.10", "3.11"]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- name: Set up Python ${{ matrix.python-version }}
|
||||||
|
uses: actions/setup-python@v3
|
||||||
|
with:
|
||||||
|
python-version: ${{ matrix.python-version }}
|
||||||
|
env:
|
||||||
|
AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
pip install tox tox-gh-actions
|
||||||
|
- name: Test with tox
|
||||||
|
run: tox
|
@@ -3,6 +3,15 @@
|
|||||||
"extends": [
|
"extends": [
|
||||||
"config:base"
|
"config:base"
|
||||||
],
|
],
|
||||||
|
"baseBranches": [
|
||||||
|
"dev"
|
||||||
|
],
|
||||||
|
"pip_requirements": {
|
||||||
|
"fileMatch": [
|
||||||
|
"requirements/.*\\.txt$"
|
||||||
|
],
|
||||||
|
"enabled": true
|
||||||
|
},
|
||||||
"packageRules": [
|
"packageRules": [
|
||||||
{
|
{
|
||||||
"matchUpdateTypes": [
|
"matchUpdateTypes": [
|
||||||
|
21
examples/commands.json
Normal file
21
examples/commands.json
Normal 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
38
examples/config.json
Normal 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
23
examples/locale.json
Normal 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!"
|
||||||
|
}
|
||||||
|
}
|
@@ -1,10 +1,10 @@
|
|||||||
[build-system]
|
[build-system]
|
||||||
requires = ["setuptools>=62.6,<66"]
|
requires = ["setuptools>=62.6", "wheel"]
|
||||||
build-backend = "setuptools.build_meta"
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "libbot"
|
name = "libbot"
|
||||||
version = "0.2.0"
|
dynamic = ["version", "dependencies", "optional-dependencies"]
|
||||||
authors = [{ name = "Profitroll" }]
|
authors = [{ name = "Profitroll" }]
|
||||||
description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
|
description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
@@ -22,30 +22,24 @@ classifiers = [
|
|||||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||||
"Topic :: Utilities",
|
"Topic :: Utilities",
|
||||||
]
|
]
|
||||||
dependencies = ["aiofiles~=23.1.0"]
|
|
||||||
|
|
||||||
[project.optional-dependencies]
|
[tool.setuptools.dynamic]
|
||||||
pycord = ["py-cord~=2.4.1"]
|
version = { attr = "libbot.__version__" }
|
||||||
pyrogram = ["pyrogram~=2.0.106", "apscheduler~=3.10.1"]
|
dependencies = { file = "requirements/_.txt" }
|
||||||
speed = ["ujson~=5.8.0"]
|
|
||||||
|
[tool.setuptools.dynamic.optional-dependencies]
|
||||||
|
dev = { file = "requirements/dev.txt" }
|
||||||
|
pycord = { file = "requirements/pycord.txt" }
|
||||||
|
pyrogram = { file = "requirements/pyrogram.txt" }
|
||||||
|
speed = { file = "requirements/speed.txt" }
|
||||||
|
|
||||||
[project.urls]
|
[project.urls]
|
||||||
Source = "https://git.end-play.xyz/profitroll/LibBotUniversal"
|
Source = "https://git.end-play.xyz/profitroll/LibBotUniversal"
|
||||||
Documentation = "https://git.end-play.xyz/profitroll/LibBotUniversal/wiki"
|
Documentation = "https://git.end-play.xyz/profitroll/LibBotUniversal/wiki"
|
||||||
Tracker = "https://git.end-play.xyz/profitroll/LibBotUniversal/issues"
|
Tracker = "https://git.end-play.xyz/profitroll/LibBotUniversal/issues"
|
||||||
|
|
||||||
[tool.setuptools]
|
[tool.setuptools.packages.find]
|
||||||
packages = [
|
where = ["src"]
|
||||||
"libbot",
|
|
||||||
"libbot.sync",
|
|
||||||
"libbot.pyrogram",
|
|
||||||
"libbot.pyrogram.classes",
|
|
||||||
"libbot.i18n",
|
|
||||||
"libbot.i18n.sync",
|
|
||||||
"libbot.i18n.classes",
|
|
||||||
]
|
|
||||||
|
|
||||||
[tool.setuptools_scm]
|
|
||||||
|
|
||||||
[tool.black]
|
[tool.black]
|
||||||
target-version = ['py38', 'py39', 'py310', 'py311']
|
target-version = ['py38', 'py39', 'py310', 'py311']
|
||||||
@@ -58,3 +52,16 @@ minversion = "6.0"
|
|||||||
python_files = ["test_*.py"]
|
python_files = ["test_*.py"]
|
||||||
pythonpath = "."
|
pythonpath = "."
|
||||||
testpaths = ["tests"]
|
testpaths = ["tests"]
|
||||||
|
|
||||||
|
[tool.mypy]
|
||||||
|
namespace_packages = true
|
||||||
|
install_types = true
|
||||||
|
strict = true
|
||||||
|
show_error_codes = true
|
||||||
|
|
||||||
|
[tool.pylint.main]
|
||||||
|
extension-pkg-whitelist = ["ujson"]
|
||||||
|
py-version = 3.8
|
||||||
|
|
||||||
|
[tool.coverage.run]
|
||||||
|
source = ["libbot"]
|
||||||
|
1
requirements/_.txt
Normal file
1
requirements/_.txt
Normal file
@@ -0,0 +1 @@
|
|||||||
|
aiofiles>=23.0.0
|
11
requirements/dev.txt
Normal file
11
requirements/dev.txt
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
black==23.12.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
|
||||||
|
types-ujson==5.9.0.0
|
2
requirements/pycord.txt
Normal file
2
requirements/pycord.txt
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
apscheduler~=3.10.4
|
||||||
|
py-cord~=2.4.1
|
2
requirements/pyrogram.txt
Normal file
2
requirements/pyrogram.txt
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
apscheduler~=3.10.4
|
||||||
|
pyrofork~=2.3.16.post1
|
1
requirements/speed.txt
Normal file
1
requirements/speed.txt
Normal file
@@ -0,0 +1 @@
|
|||||||
|
ujson~=5.9.0
|
@@ -1,6 +1,6 @@
|
|||||||
__version__ = "0.2.0"
|
__version__ = "3.0.0"
|
||||||
__license__ = "GPL3"
|
__license__ = "GPL3"
|
||||||
__author__ = "Profitroll"
|
__author__ = "Profitroll"
|
||||||
|
|
||||||
from . import i18n, pyrogram, sync
|
from . import i18n, pycord, pyrogram, sync
|
||||||
from .__main__ import *
|
from .__main__ import *
|
1
src/libbot/pycord/classes/__init__.py
Normal file
1
src/libbot/pycord/classes/__init__.py
Normal file
@@ -0,0 +1 @@
|
|||||||
|
from .bot import PycordBot
|
57
src/libbot/pycord/classes/bot.py
Normal file
57
src/libbot/pycord/classes/bot.py
Normal file
@@ -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
|
@@ -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,16 +96,21 @@ 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(
|
||||||
(Path("locale") if locales_root is None else locales_root)
|
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.default_locale: str = self.bot_locale.default
|
||||||
self.locales: dict = self.bot_locale.locales
|
self.locales: dict = self.bot_locale.locales
|
||||||
@@ -115,7 +123,9 @@ class PyroClient(Client):
|
|||||||
|
|
||||||
self.scopes_placeholders: Dict[str, int] = {"owner": self.owner}
|
self.scopes_placeholders: Dict[str, int] = {"owner": self.owner}
|
||||||
|
|
||||||
async def start(self, register_commands: bool = True):
|
self.i18n_bot_info: bool = i18n_bot_info
|
||||||
|
|
||||||
|
async def start(self, register_commands: bool = True) -> None:
|
||||||
await super().start()
|
await super().start()
|
||||||
|
|
||||||
self.start_time = time()
|
self.start_time = time()
|
||||||
@@ -128,6 +138,55 @@ class PyroClient(Client):
|
|||||||
getpid(),
|
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.default_locale,
|
||||||
|
)
|
||||||
|
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:
|
try:
|
||||||
await self.send_message(
|
await self.send_message(
|
||||||
chat_id=self.owner
|
chat_id=self.owner
|
||||||
@@ -135,10 +194,13 @@ class PyroClient(Client):
|
|||||||
else self.config["reports"]["chat_id"],
|
else self.config["reports"]["chat_id"],
|
||||||
text=f"Bot started PID `{getpid()}`",
|
text=f"Bot started PID `{getpid()}`",
|
||||||
)
|
)
|
||||||
|
except BadRequest:
|
||||||
|
logger.warning("Unable to send message to report chat.")
|
||||||
|
|
||||||
if self.scheduler is None:
|
if self.scheduler is None:
|
||||||
return
|
return
|
||||||
|
|
||||||
|
# Schedule the task to register all commands
|
||||||
if register_commands:
|
if register_commands:
|
||||||
self.scheduler.add_job(
|
self.scheduler.add_job(
|
||||||
self.register_commands,
|
self.register_commands,
|
||||||
@@ -148,10 +210,8 @@ class PyroClient(Client):
|
|||||||
)
|
)
|
||||||
|
|
||||||
self.scheduler.start()
|
self.scheduler.start()
|
||||||
except BadRequest:
|
|
||||||
logger.warning("Unable to send message to report chat.")
|
|
||||||
|
|
||||||
async def stop(self, exit_completely: bool = True):
|
async def stop(self, exit_completely: bool = True) -> None:
|
||||||
try:
|
try:
|
||||||
await self.send_message(
|
await self.send_message(
|
||||||
chat_id=self.owner
|
chat_id=self.owner
|
||||||
@@ -169,16 +229,16 @@ class PyroClient(Client):
|
|||||||
if exit_completely:
|
if exit_completely:
|
||||||
try:
|
try:
|
||||||
exit()
|
exit()
|
||||||
except SystemExit as exp:
|
except SystemExit as exc:
|
||||||
raise SystemExit(
|
raise SystemExit(
|
||||||
"Bot has been shut down, this is not an application error!"
|
"Bot has been shut down, this is not an application error!"
|
||||||
) from exp
|
) from exc
|
||||||
|
|
||||||
async def collect_commands(self) -> Union[List[CommandSet], None]:
|
async def collect_commands(self) -> Union[List[CommandSet], None]:
|
||||||
"""Gather list of the bot's commands
|
"""Gather list of the bot's commands
|
||||||
|
|
||||||
### Returns:
|
### Returns:
|
||||||
* `List[CommandSet]`: List of the commands' sets
|
* `List[CommandSet]`: List of the commands' sets.
|
||||||
"""
|
"""
|
||||||
command_sets = None
|
command_sets = None
|
||||||
|
|
||||||
@@ -269,7 +329,7 @@ class PyroClient(Client):
|
|||||||
def add_command(
|
def add_command(
|
||||||
self,
|
self,
|
||||||
command: str,
|
command: str,
|
||||||
):
|
) -> None:
|
||||||
"""Add command to the bot's internal commands list
|
"""Add command to the bot's internal commands list
|
||||||
|
|
||||||
### Args:
|
### Args:
|
||||||
@@ -288,7 +348,7 @@ class PyroClient(Client):
|
|||||||
|
|
||||||
async def register_commands(
|
async def register_commands(
|
||||||
self, command_sets: Union[List[CommandSet], None] = None
|
self, command_sets: Union[List[CommandSet], None] = None
|
||||||
):
|
) -> None:
|
||||||
"""Register commands stored in bot's 'commands' attribute"""
|
"""Register commands stored in bot's 'commands' attribute"""
|
||||||
|
|
||||||
if command_sets is None:
|
if command_sets is None:
|
||||||
@@ -317,7 +377,9 @@ class PyroClient(Client):
|
|||||||
language_code=command_set.language_code,
|
language_code=command_set.language_code,
|
||||||
)
|
)
|
||||||
|
|
||||||
async def remove_commands(self, command_sets: Union[List[CommandSet], None] = None):
|
async def remove_commands(
|
||||||
|
self, command_sets: Union[List[CommandSet], None] = None
|
||||||
|
) -> None:
|
||||||
"""Remove commands stored in bot's 'commands' attribute"""
|
"""Remove commands stored in bot's 'commands' attribute"""
|
||||||
|
|
||||||
if command_sets is None:
|
if command_sets is None:
|
20
tests/conftest.py
Normal file
20
tests/conftest.py
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from libbot.i18n import BotLocale
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture()
|
||||||
|
def location_config() -> Path:
|
||||||
|
return Path("tests/config.json")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture()
|
||||||
|
def location_locale() -> Path:
|
||||||
|
return Path("tests/data/locale/")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture()
|
||||||
|
def bot_locale(location_locale: Path) -> BotLocale:
|
||||||
|
return BotLocale(locales_root=location_locale)
|
@@ -1,4 +1,16 @@
|
|||||||
{
|
{
|
||||||
|
"metadata": {
|
||||||
|
"flag": "🇬🇧",
|
||||||
|
"name": "English",
|
||||||
|
"codes": [
|
||||||
|
"en"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"bot": {
|
||||||
|
"name": "",
|
||||||
|
"about": "",
|
||||||
|
"description": ""
|
||||||
|
},
|
||||||
"foo": "bar",
|
"foo": "bar",
|
||||||
"messages": {
|
"messages": {
|
||||||
"example": "okay"
|
"example": "okay"
|
||||||
|
@@ -1,4 +1,16 @@
|
|||||||
{
|
{
|
||||||
|
"metadata": {
|
||||||
|
"flag": "🇺🇦",
|
||||||
|
"name": "Українська",
|
||||||
|
"codes": [
|
||||||
|
"uk"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"bot": {
|
||||||
|
"name": "",
|
||||||
|
"about": "",
|
||||||
|
"description": ""
|
||||||
|
},
|
||||||
"foo": "бар",
|
"foo": "бар",
|
||||||
"messages": {
|
"messages": {
|
||||||
"example": "окей"
|
"example": "окей"
|
||||||
|
@@ -5,8 +5,6 @@ import pytest
|
|||||||
|
|
||||||
from libbot.i18n import BotLocale
|
from libbot.i18n import BotLocale
|
||||||
|
|
||||||
bot_locale = BotLocale(Path("tests/data/locale"))
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
"key, args, locale, expected",
|
"key, args, locale, expected",
|
||||||
@@ -20,7 +18,11 @@ bot_locale = BotLocale(Path("tests/data/locale"))
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_bot_locale_get(
|
def test_bot_locale_get(
|
||||||
key: str, args: List[str], locale: Union[str, None], expected: Any
|
key: str,
|
||||||
|
args: List[str],
|
||||||
|
locale: Union[str, None],
|
||||||
|
expected: Any,
|
||||||
|
bot_locale: BotLocale,
|
||||||
):
|
):
|
||||||
assert (
|
assert (
|
||||||
bot_locale._(key, *args, locale=locale)
|
bot_locale._(key, *args, locale=locale)
|
||||||
@@ -37,7 +39,9 @@ def test_bot_locale_get(
|
|||||||
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
|
def test_i18n_in_all_locales(
|
||||||
|
key: str, args: List[str], expected: Any, bot_locale: BotLocale
|
||||||
|
):
|
||||||
assert (bot_locale.in_all_locales(key, *args)) == expected
|
assert (bot_locale.in_all_locales(key, *args)) == expected
|
||||||
|
|
||||||
|
|
||||||
@@ -49,5 +53,7 @@ def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
|
|||||||
("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
|
("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_i18n_in_every_locale(key: str, args: List[str], expected: Any):
|
def test_i18n_in_every_locale(
|
||||||
|
key: str, args: List[str], expected: Any, bot_locale: BotLocale
|
||||||
|
):
|
||||||
assert (bot_locale.in_every_locale(key, *args)) == expected
|
assert (bot_locale.in_every_locale(key, *args)) == expected
|
||||||
|
@@ -14,11 +14,8 @@ from libbot import config_get, config_set
|
|||||||
(["bot_token", "bot"], "sample_token"),
|
(["bot_token", "bot"], "sample_token"),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
async def test_config_get_valid(args: List[str], expected: str):
|
async def test_config_get_valid(args: List[str], expected: str, location_config: Path):
|
||||||
assert (
|
assert await config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||||
await config_get(args[0], *args[1:], config_file=Path("tests/config.json"))
|
|
||||||
== expected
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
@@ -28,10 +25,12 @@ async def test_config_get_valid(args: List[str], expected: str):
|
|||||||
(["bot_stonks", "bot"], pytest.raises(KeyError)),
|
(["bot_stonks", "bot"], pytest.raises(KeyError)),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
async def test_config_get_invalid(args: List[str], expected: Any):
|
async def test_config_get_invalid(
|
||||||
|
args: List[str], expected: Any, location_config: Path
|
||||||
|
):
|
||||||
with expected:
|
with expected:
|
||||||
assert (
|
assert (
|
||||||
await config_get(args[0], *args[1:], config_file=Path("tests/config.json"))
|
await config_get(args[0], *args[1:], config_file=location_config)
|
||||||
== expected
|
== expected
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -44,6 +43,6 @@ async def test_config_get_invalid(args: List[str], expected: Any):
|
|||||||
("bot_token", ["bot"], "sample_token"),
|
("bot_token", ["bot"], "sample_token"),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
async def test_config_set(key: str, path: List[str], value: Any):
|
async def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
|
||||||
await config_set(key, value, *path, config_file=Path("tests/config.json"))
|
await config_set(key, value, *path, config_file=location_config)
|
||||||
assert await config_get(key, *path, config_file=Path("tests/config.json")) == value
|
assert await config_get(key, *path, config_file=location_config) == value
|
||||||
|
@@ -13,11 +13,8 @@ from libbot import sync
|
|||||||
(["bot_token", "bot"], "sample_token"),
|
(["bot_token", "bot"], "sample_token"),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_config_get_valid(args: List[str], expected: str):
|
def test_config_get_valid(args: List[str], expected: str, location_config: Path):
|
||||||
assert (
|
assert sync.config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||||
sync.config_get(args[0], *args[1:], config_file=Path("tests/config.json"))
|
|
||||||
== expected
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -26,11 +23,10 @@ def test_config_get_valid(args: List[str], expected: str):
|
|||||||
(["bot_stonks", "bot"], pytest.raises(KeyError)),
|
(["bot_stonks", "bot"], pytest.raises(KeyError)),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_config_get_invalid(args: List[str], expected: Any):
|
def test_config_get_invalid(args: List[str], expected: Any, location_config: Path):
|
||||||
with expected:
|
with expected:
|
||||||
assert (
|
assert (
|
||||||
sync.config_get(args[0], *args[1:], config_file=Path("tests/config.json"))
|
sync.config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||||
== expected
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -41,6 +37,6 @@ def test_config_get_invalid(args: List[str], expected: Any):
|
|||||||
("bot_token", ["bot"], "sample_token"),
|
("bot_token", ["bot"], "sample_token"),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_config_set(key: str, path: List[str], value: Any):
|
def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
|
||||||
sync.config_set(key, value, *path, config_file=Path("tests/config.json"))
|
sync.config_set(key, value, *path, config_file=location_config)
|
||||||
assert sync.config_get(key, *path, config_file=Path("tests/config.json")) == value
|
assert sync.config_get(key, *path, config_file=location_config) == value
|
||||||
|
@@ -19,12 +19,16 @@ from libbot import i18n
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
async def test_i18n_get(
|
async def test_i18n_get(
|
||||||
key: str, args: List[str], locale: Union[str, None], expected: Any
|
key: str,
|
||||||
|
args: List[str],
|
||||||
|
locale: Union[str, None],
|
||||||
|
expected: Any,
|
||||||
|
location_locale: Path,
|
||||||
):
|
):
|
||||||
assert (
|
assert (
|
||||||
await i18n._(key, *args, locale=locale, locales_root=Path("tests/data/locale"))
|
await i18n._(key, *args, locale=locale, locales_root=location_locale)
|
||||||
if locale is not None
|
if locale is not None
|
||||||
else await i18n._(key, *args, locales_root=Path("tests/data/locale"))
|
else await i18n._(key, *args, locales_root=location_locale)
|
||||||
) == expected
|
) == expected
|
||||||
|
|
||||||
|
|
||||||
@@ -37,9 +41,11 @@ async def test_i18n_get(
|
|||||||
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
async def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
|
async def test_i18n_in_all_locales(
|
||||||
|
key: str, args: List[str], expected: Any, location_locale: Path
|
||||||
|
):
|
||||||
assert (
|
assert (
|
||||||
await i18n.in_all_locales(key, *args, locales_root=Path("tests/data/locale"))
|
await i18n.in_all_locales(key, *args, locales_root=location_locale)
|
||||||
) == expected
|
) == expected
|
||||||
|
|
||||||
|
|
||||||
@@ -52,7 +58,9 @@ async def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
|
|||||||
("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
|
("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
async def test_i18n_in_every_locale(key: str, args: List[str], expected: Any):
|
async def test_i18n_in_every_locale(
|
||||||
|
key: str, args: List[str], expected: Any, location_locale: Path
|
||||||
|
):
|
||||||
assert (
|
assert (
|
||||||
await i18n.in_every_locale(key, *args, locales_root=Path("tests/data/locale"))
|
await i18n.in_every_locale(key, *args, locales_root=location_locale)
|
||||||
) == expected
|
) == expected
|
||||||
|
@@ -17,11 +17,17 @@ from libbot.i18n import sync
|
|||||||
("nested", ["callbacks", "default"], "uk", "авжеж"),
|
("nested", ["callbacks", "default"], "uk", "авжеж"),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_i18n_get(key: str, args: List[str], locale: Union[str, None], expected: Any):
|
def test_i18n_get(
|
||||||
|
key: str,
|
||||||
|
args: List[str],
|
||||||
|
locale: Union[str, None],
|
||||||
|
expected: Any,
|
||||||
|
location_locale: Path,
|
||||||
|
):
|
||||||
assert (
|
assert (
|
||||||
sync._(key, *args, locale=locale, locales_root=Path("tests/data/locale"))
|
sync._(key, *args, locale=locale, locales_root=location_locale)
|
||||||
if locale is not None
|
if locale is not None
|
||||||
else sync._(key, *args, locales_root=Path("tests/data/locale"))
|
else sync._(key, *args, locales_root=location_locale)
|
||||||
) == expected
|
) == expected
|
||||||
|
|
||||||
|
|
||||||
@@ -33,10 +39,10 @@ def test_i18n_get(key: str, args: List[str], locale: Union[str, None], expected:
|
|||||||
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
|
def test_i18n_in_all_locales(
|
||||||
assert (
|
key: str, args: List[str], expected: Any, location_locale: Path
|
||||||
sync.in_all_locales(key, *args, locales_root=Path("tests/data/locale"))
|
):
|
||||||
) == expected
|
assert (sync.in_all_locales(key, *args, locales_root=location_locale)) == expected
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -47,7 +53,7 @@ def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
|
|||||||
("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
|
("nested", ["callbacks", "default"], {"en": "sure", "uk": "авжеж"}),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_i18n_in_every_locale(key: str, args: List[str], expected: Any):
|
def test_i18n_in_every_locale(
|
||||||
assert (
|
key: str, args: List[str], expected: Any, location_locale: Path
|
||||||
sync.in_every_locale(key, *args, locales_root=Path("tests/data/locale"))
|
):
|
||||||
) == expected
|
assert (sync.in_every_locale(key, *args, locales_root=location_locale)) == expected
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
from typing import Any, List
|
from typing import Any, Dict, List
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
@@ -27,7 +27,7 @@ from libbot import sync
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_nested_set_valid(
|
def test_nested_set_valid(
|
||||||
target: dict[str, Any],
|
target: Dict[str, Any],
|
||||||
value: Any,
|
value: Any,
|
||||||
path: List[str],
|
path: List[str],
|
||||||
create_missing: bool,
|
create_missing: bool,
|
||||||
@@ -51,7 +51,7 @@ def test_nested_set_valid(
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_nested_set_invalid(
|
def test_nested_set_invalid(
|
||||||
target: dict[str, Any],
|
target: Dict[str, Any],
|
||||||
value: Any,
|
value: Any,
|
||||||
path: List[str],
|
path: List[str],
|
||||||
create_missing: bool,
|
create_missing: bool,
|
||||||
|
23
tox.ini
Normal file
23
tox.ini
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
[tox]
|
||||||
|
minversion = 3.8.0
|
||||||
|
envlist = py38, py39, py310, py311
|
||||||
|
isolated_build = true
|
||||||
|
|
||||||
|
[gh-actions]
|
||||||
|
python =
|
||||||
|
3.8: py38
|
||||||
|
3.9: py39
|
||||||
|
3.10: py310
|
||||||
|
3.11: py311
|
||||||
|
|
||||||
|
[testenv]
|
||||||
|
setenv =
|
||||||
|
PYTHONPATH = {toxinidir}
|
||||||
|
deps =
|
||||||
|
-r{toxinidir}/requirements/_.txt
|
||||||
|
-r{toxinidir}/requirements/dev.txt
|
||||||
|
-r{toxinidir}/requirements/pycord.txt
|
||||||
|
-r{toxinidir}/requirements/pyrogram.txt
|
||||||
|
-r{toxinidir}/requirements/speed.txt
|
||||||
|
commands =
|
||||||
|
pytest --basetemp={envtmpdir} --cov=libbot
|
Reference in New Issue
Block a user