Compare commits
19 Commits
Author | SHA1 | Date | |
---|---|---|---|
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,12 @@
|
||||
"extends": [
|
||||
"config:base"
|
||||
],
|
||||
"pip_requirements": {
|
||||
"fileMatch": [
|
||||
"requirements/.*\\.txt$"
|
||||
],
|
||||
"enabled": true
|
||||
},
|
||||
"packageRules": [
|
||||
{
|
||||
"matchUpdateTypes": [
|
||||
|
@@ -1,10 +1,10 @@
|
||||
[build-system]
|
||||
requires = ["setuptools>=62.6,<66"]
|
||||
requires = ["setuptools>=62.6", "wheel"]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "libbot"
|
||||
version = "0.2.0"
|
||||
dynamic = ["version", "dependencies", "optional-dependencies"]
|
||||
authors = [{ name = "Profitroll" }]
|
||||
description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
|
||||
readme = "README.md"
|
||||
@@ -22,30 +22,24 @@ classifiers = [
|
||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||
"Topic :: Utilities",
|
||||
]
|
||||
dependencies = ["aiofiles~=23.1.0"]
|
||||
|
||||
[project.optional-dependencies]
|
||||
pycord = ["py-cord~=2.4.1"]
|
||||
pyrogram = ["pyrogram~=2.0.106", "apscheduler~=3.10.1"]
|
||||
speed = ["ujson~=5.8.0"]
|
||||
[tool.setuptools.dynamic]
|
||||
version = { attr = "libbot.__version__" }
|
||||
dependencies = { file = "requirements/_.txt" }
|
||||
|
||||
[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]
|
||||
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.setuptools.packages.find]
|
||||
where = ["src"]
|
||||
|
||||
[tool.black]
|
||||
target-version = ['py38', 'py39', 'py310', 'py311']
|
||||
@@ -58,3 +52,16 @@ minversion = "6.0"
|
||||
python_files = ["test_*.py"]
|
||||
pythonpath = "."
|
||||
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.7.0
|
||||
build==0.10.0
|
||||
isort==5.12.0
|
||||
mypy==1.5.0
|
||||
pylint==2.17.5
|
||||
pytest-asyncio==0.21.1
|
||||
pytest-cov==4.1.0
|
||||
pytest==7.4.0
|
||||
tox==4.7.0
|
||||
types-aiofiles==23.1.0.5
|
||||
types-ujson==5.8.0.1
|
1
requirements/pycord.txt
Normal file
1
requirements/pycord.txt
Normal file
@@ -0,0 +1 @@
|
||||
py-cord~=2.4.1
|
2
requirements/pyrogram.txt
Normal file
2
requirements/pyrogram.txt
Normal file
@@ -0,0 +1,2 @@
|
||||
apscheduler~=3.10.1
|
||||
pyrogram~=2.0.106
|
1
requirements/speed.txt
Normal file
1
requirements/speed.txt
Normal file
@@ -0,0 +1 @@
|
||||
ujson~=5.8.0
|
@@ -1,4 +1,4 @@
|
||||
__version__ = "0.2.0"
|
||||
__version__ = "2.0.1"
|
||||
__license__ = "GPL3"
|
||||
__author__ = "Profitroll"
|
||||
|
@@ -102,7 +102,8 @@ class PyroClient(Client):
|
||||
self.start_time: float = 0
|
||||
|
||||
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.locales: dict = self.bot_locale.locales
|
||||
@@ -115,7 +116,7 @@ class PyroClient(Client):
|
||||
|
||||
self.scopes_placeholders: Dict[str, int] = {"owner": self.owner}
|
||||
|
||||
async def start(self, register_commands: bool = True):
|
||||
async def start(self, register_commands: bool = True) -> None:
|
||||
await super().start()
|
||||
|
||||
self.start_time = time()
|
||||
@@ -151,7 +152,7 @@ class PyroClient(Client):
|
||||
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:
|
||||
await self.send_message(
|
||||
chat_id=self.owner
|
||||
@@ -269,7 +270,7 @@ class PyroClient(Client):
|
||||
def add_command(
|
||||
self,
|
||||
command: str,
|
||||
):
|
||||
) -> None:
|
||||
"""Add command to the bot's internal commands list
|
||||
|
||||
### Args:
|
||||
@@ -288,7 +289,7 @@ class PyroClient(Client):
|
||||
|
||||
async def register_commands(
|
||||
self, command_sets: Union[List[CommandSet], None] = None
|
||||
):
|
||||
) -> None:
|
||||
"""Register commands stored in bot's 'commands' attribute"""
|
||||
|
||||
if command_sets is None:
|
||||
@@ -317,7 +318,9 @@ class PyroClient(Client):
|
||||
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"""
|
||||
|
||||
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)
|
@@ -5,8 +5,6 @@ import pytest
|
||||
|
||||
from libbot.i18n import BotLocale
|
||||
|
||||
bot_locale = BotLocale(Path("tests/data/locale"))
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"key, args, locale, expected",
|
||||
@@ -20,7 +18,11 @@ bot_locale = BotLocale(Path("tests/data/locale"))
|
||||
],
|
||||
)
|
||||
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 (
|
||||
bot_locale._(key, *args, locale=locale)
|
||||
@@ -37,7 +39,9 @@ def test_bot_locale_get(
|
||||
("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
|
||||
|
||||
|
||||
@@ -49,5 +53,7 @@ def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
|
||||
("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
|
||||
|
@@ -14,11 +14,8 @@ from libbot import config_get, config_set
|
||||
(["bot_token", "bot"], "sample_token"),
|
||||
],
|
||||
)
|
||||
async def test_config_get_valid(args: List[str], expected: str):
|
||||
assert (
|
||||
await config_get(args[0], *args[1:], config_file=Path("tests/config.json"))
|
||||
== expected
|
||||
)
|
||||
async def test_config_get_valid(args: List[str], expected: str, location_config: Path):
|
||||
assert await config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@@ -28,10 +25,12 @@ async def test_config_get_valid(args: List[str], expected: str):
|
||||
(["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:
|
||||
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
|
||||
)
|
||||
|
||||
@@ -44,6 +43,6 @@ async def test_config_get_invalid(args: List[str], expected: Any):
|
||||
("bot_token", ["bot"], "sample_token"),
|
||||
],
|
||||
)
|
||||
async def test_config_set(key: str, path: List[str], value: Any):
|
||||
await config_set(key, value, *path, config_file=Path("tests/config.json"))
|
||||
assert await config_get(key, *path, config_file=Path("tests/config.json")) == value
|
||||
async def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
|
||||
await config_set(key, value, *path, config_file=location_config)
|
||||
assert await config_get(key, *path, config_file=location_config) == value
|
||||
|
@@ -13,11 +13,8 @@ from libbot import sync
|
||||
(["bot_token", "bot"], "sample_token"),
|
||||
],
|
||||
)
|
||||
def test_config_get_valid(args: List[str], expected: str):
|
||||
assert (
|
||||
sync.config_get(args[0], *args[1:], config_file=Path("tests/config.json"))
|
||||
== expected
|
||||
)
|
||||
def test_config_get_valid(args: List[str], expected: str, location_config: Path):
|
||||
assert sync.config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -26,11 +23,10 @@ def test_config_get_valid(args: List[str], expected: str):
|
||||
(["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:
|
||||
assert (
|
||||
sync.config_get(args[0], *args[1:], config_file=Path("tests/config.json"))
|
||||
== expected
|
||||
sync.config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||
)
|
||||
|
||||
|
||||
@@ -41,6 +37,6 @@ def test_config_get_invalid(args: List[str], expected: Any):
|
||||
("bot_token", ["bot"], "sample_token"),
|
||||
],
|
||||
)
|
||||
def test_config_set(key: str, path: List[str], value: Any):
|
||||
sync.config_set(key, value, *path, config_file=Path("tests/config.json"))
|
||||
assert sync.config_get(key, *path, config_file=Path("tests/config.json")) == value
|
||||
def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
|
||||
sync.config_set(key, value, *path, config_file=location_config)
|
||||
assert sync.config_get(key, *path, config_file=location_config) == value
|
||||
|
@@ -19,12 +19,16 @@ from libbot import i18n
|
||||
],
|
||||
)
|
||||
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 (
|
||||
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
|
||||
else await i18n._(key, *args, locales_root=Path("tests/data/locale"))
|
||||
else await i18n._(key, *args, locales_root=location_locale)
|
||||
) == expected
|
||||
|
||||
|
||||
@@ -37,9 +41,11 @@ async def test_i18n_get(
|
||||
("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 (
|
||||
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
|
||||
|
||||
|
||||
@@ -52,7 +58,9 @@ async def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
|
||||
("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 (
|
||||
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
|
||||
|
@@ -17,11 +17,17 @@ from libbot.i18n import sync
|
||||
("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 (
|
||||
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
|
||||
else sync._(key, *args, locales_root=Path("tests/data/locale"))
|
||||
else sync._(key, *args, locales_root=location_locale)
|
||||
) == expected
|
||||
|
||||
|
||||
@@ -33,10 +39,10 @@ def test_i18n_get(key: str, args: List[str], locale: Union[str, None], expected:
|
||||
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
||||
],
|
||||
)
|
||||
def test_i18n_in_all_locales(key: str, args: List[str], expected: Any):
|
||||
assert (
|
||||
sync.in_all_locales(key, *args, locales_root=Path("tests/data/locale"))
|
||||
) == expected
|
||||
def test_i18n_in_all_locales(
|
||||
key: str, args: List[str], expected: Any, location_locale: Path
|
||||
):
|
||||
assert (sync.in_all_locales(key, *args, locales_root=location_locale)) == expected
|
||||
|
||||
|
||||
@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": "авжеж"}),
|
||||
],
|
||||
)
|
||||
def test_i18n_in_every_locale(key: str, args: List[str], expected: Any):
|
||||
assert (
|
||||
sync.in_every_locale(key, *args, locales_root=Path("tests/data/locale"))
|
||||
) == expected
|
||||
def test_i18n_in_every_locale(
|
||||
key: str, args: List[str], expected: Any, location_locale: Path
|
||||
):
|
||||
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
|
||||
|
||||
@@ -27,7 +27,7 @@ from libbot import sync
|
||||
],
|
||||
)
|
||||
def test_nested_set_valid(
|
||||
target: dict[str, Any],
|
||||
target: Dict[str, Any],
|
||||
value: Any,
|
||||
path: List[str],
|
||||
create_missing: bool,
|
||||
@@ -51,7 +51,7 @@ def test_nested_set_valid(
|
||||
],
|
||||
)
|
||||
def test_nested_set_invalid(
|
||||
target: dict[str, Any],
|
||||
target: Dict[str, Any],
|
||||
value: Any,
|
||||
path: List[str],
|
||||
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