Updated to 0.2.1
This commit is contained in:
parent
461642a529
commit
64aa2686ea
25
.gitea/workflows/tests.yml
Normal file
25
.gitea/workflows/tests.yml
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
name: Tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
- push
|
||||||
|
- pull_request
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
python-version: ["3.8", "3.9", "3.10", "3.11"]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Set up Python ${{ matrix.python-version }}
|
||||||
|
uses: actions/setup-python@v2
|
||||||
|
with:
|
||||||
|
python-version: ${{ matrix.python-version }}
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
pip install tox tox-gh-actions
|
||||||
|
- name: Test with tox
|
||||||
|
run: tox
|
@ -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.1.0
|
10
requirements/dev.txt
Normal file
10
requirements/dev.txt
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
black==23.7.0
|
||||||
|
isort==5.12.0
|
||||||
|
mypy==1.4.1
|
||||||
|
pylint==2.17.5
|
||||||
|
pytest-asyncio==0.21.1
|
||||||
|
pytest-cov==4.1.0
|
||||||
|
pytest==7.4.0
|
||||||
|
tox==4.6.4
|
||||||
|
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__ = "0.2.1"
|
||||||
__license__ = "GPL3"
|
__license__ = "GPL3"
|
||||||
__author__ = "Profitroll"
|
__author__ = "Profitroll"
|
||||||
|
|
@ -115,7 +115,7 @@ 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):
|
async def start(self, register_commands: bool = True) -> None:
|
||||||
await super().start()
|
await super().start()
|
||||||
|
|
||||||
self.start_time = time()
|
self.start_time = time()
|
||||||
@ -151,7 +151,7 @@ class PyroClient(Client):
|
|||||||
except BadRequest:
|
except BadRequest:
|
||||||
logger.warning("Unable to send message to report chat.")
|
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
|
||||||
@ -269,7 +269,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 +288,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 +317,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)
|
@ -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
|
||||||
|
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}
|
Loading…
Reference in New Issue
Block a user