Compare commits
9 Commits
37d2d4e215
...
v3.3.0
Author | SHA1 | Date | |
---|---|---|---|
1b60257bc5 | |||
171e36a491 | |||
c419c684aa | |||
748b2b2abb | |||
52c2e5cc13 | |||
55c61e3fce | |||
b9550032ba | |||
5ba763246b | |||
f0ffdf096d |
@@ -6,18 +6,19 @@ on:
|
|||||||
- main
|
- main
|
||||||
- dev
|
- dev
|
||||||
pull_request:
|
pull_request:
|
||||||
types: [ opened, synchronize, reopened ]
|
types: [opened, synchronize, reopened]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
sonarcloud:
|
sonarcloud:
|
||||||
name: SonarCloud
|
name: SonarCloud
|
||||||
runs-on: ubuntu-24.04
|
runs-on: ubuntu-latest
|
||||||
|
container: catthehacker/ubuntu:act-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- name: SonarQube Scan
|
- name: SonarCloud Scan
|
||||||
uses: SonarSource/sonarqube-scan-action@v4.2.1
|
uses: SonarSource/sonarcloud-github-action@master
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
@@ -1,67 +0,0 @@
|
|||||||
name: Upload Python Package
|
|
||||||
|
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types: [ published ]
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
release-build:
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-python@v5
|
|
||||||
with:
|
|
||||||
python-version: "3.x"
|
|
||||||
- name: Build release distributions
|
|
||||||
run: |
|
|
||||||
python -m pip install build
|
|
||||||
python -m build
|
|
||||||
- name: Upload distributions
|
|
||||||
uses: christopherhx/gitea-upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: release-dists
|
|
||||||
path: dist/
|
|
||||||
gitea-publish:
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
needs: release-build
|
|
||||||
permissions:
|
|
||||||
id-token: write
|
|
||||||
environment:
|
|
||||||
name: gitea
|
|
||||||
url: https://git.end-play.xyz/profitroll/-/packages/pypi/libbot
|
|
||||||
env:
|
|
||||||
GITHUB_WORKFLOW_REF: ${{ gitea.workflow_ref }}
|
|
||||||
INPUT_REPOSITORY_URL: https://git.end-play.xyz/api/packages/profitroll/pypi
|
|
||||||
steps:
|
|
||||||
- name: Retrieve release distributions
|
|
||||||
uses: christopherhx/gitea-download-artifact@v4
|
|
||||||
with:
|
|
||||||
name: release-dists
|
|
||||||
path: dist/
|
|
||||||
- name: Publish package distributions to TestPyPI
|
|
||||||
uses: pypa/gh-action-pypi-publish@release/v1
|
|
||||||
with:
|
|
||||||
password: ${{ secrets.PYPI_GITEA_API_TOKEN }}
|
|
||||||
repository-url: https://git.end-play.xyz/api/packages/profitroll/pypi
|
|
||||||
pypi-publish:
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
needs: release-build
|
|
||||||
permissions:
|
|
||||||
id-token: write
|
|
||||||
environment:
|
|
||||||
name: pypi
|
|
||||||
env:
|
|
||||||
GITHUB_WORKFLOW_REF: ${{ gitea.workflow_ref }}
|
|
||||||
steps:
|
|
||||||
- name: Retrieve release distributions
|
|
||||||
uses: christopherhx/gitea-download-artifact@v4
|
|
||||||
with:
|
|
||||||
name: release-dists
|
|
||||||
path: dist/
|
|
||||||
- name: Publish package distributions to TestPyPI
|
|
||||||
uses: pypa/gh-action-pypi-publish@release/v1
|
|
||||||
with:
|
|
||||||
password: ${{ secrets.PYPI_PYPI_API_TOKEN }}
|
|
@@ -11,18 +11,18 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
test:
|
test:
|
||||||
name: Build and Test
|
name: Build and Test
|
||||||
runs-on: ubuntu-24.04
|
runs-on: ubuntu-latest
|
||||||
|
container: catthehacker/ubuntu:act-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
python-version: [ "3.11", "3.12", "3.13" ]
|
python-version: ["3.9", "3.10", "3.11", "3.12"]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
- name: Set up Python ${{ matrix.python-version }}
|
- name: Set up Python ${{ matrix.python-version }}
|
||||||
uses: actions/setup-python@v3
|
uses: actions/setup-python@v3
|
||||||
with:
|
with:
|
||||||
python-version: ${{ matrix.python-version }}
|
python-version: ${{ matrix.python-version }}
|
||||||
cache: 'pip'
|
|
||||||
cache-dependency-path: './requirements/*'
|
|
||||||
env:
|
env:
|
||||||
AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
|
AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
|
32
README.md
32
README.md
@@ -16,7 +16,6 @@ There are different sub-packages available:
|
|||||||
* pyrogram - Telegram bots with Pyrogram's fork "Pyrofork"
|
* pyrogram - Telegram bots with Pyrogram's fork "Pyrofork"
|
||||||
* pycord - Discord bots with Pycord
|
* pycord - Discord bots with Pycord
|
||||||
* speed - Performance improvements
|
* speed - Performance improvements
|
||||||
* cache - Support for Redis and Memcached
|
|
||||||
* dev - Dependencies for package development purposes
|
* dev - Dependencies for package development purposes
|
||||||
|
|
||||||
You can freely choose any sub-package you want, as well as add multiple (comma-separated) or none at all.
|
You can freely choose any sub-package you want, as well as add multiple (comma-separated) or none at all.
|
||||||
@@ -37,20 +36,19 @@ pip install libbot[pycord,speed]
|
|||||||
### Pyrogram
|
### Pyrogram
|
||||||
|
|
||||||
```python
|
```python
|
||||||
import sys
|
from libbot.pyrogram import PyroClient
|
||||||
|
|
||||||
from libbot.pyrogram.classes import PyroClient
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
client: PyroClient = PyroClient()
|
client = PyroClient(scheduler=scheduler)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
client.run()
|
client.run()
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
print("Shutting down...")
|
print("Shutting down...")
|
||||||
finally:
|
finally:
|
||||||
sys.exit()
|
if client.scheduler is not None:
|
||||||
|
client.scheduler.shutdown()
|
||||||
|
exit()
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
@@ -60,33 +58,29 @@ if __name__ == "__main__":
|
|||||||
### Pycord
|
### Pycord
|
||||||
|
|
||||||
```python
|
```python
|
||||||
import asyncio
|
|
||||||
from asyncio import AbstractEventLoop
|
|
||||||
|
|
||||||
from discord import Intents
|
from discord import Intents
|
||||||
from libbot.utils import config_get
|
from libbot import sync
|
||||||
from libbot.pycord.classes import PycordBot
|
from libbot.pycord import PycordBot
|
||||||
|
|
||||||
|
|
||||||
async def main():
|
async def main():
|
||||||
intents: Intents = Intents.default()
|
intents = Intents.default()
|
||||||
bot: PycordBot = PycordBot(intents=intents)
|
bot = PycordBot(intents=intents)
|
||||||
|
|
||||||
bot.load_extension("cogs")
|
bot.load_extension("cogs")
|
||||||
|
|
||||||
try:
|
try:
|
||||||
await bot.start(config_get("bot_token", "bot"))
|
await bot.start(sync.config_get("bot_token", "bot"))
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
print("Shutting down...")
|
logger.warning("Shutting down...")
|
||||||
await bot.close()
|
await bot.close()
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
loop: AbstractEventLoop = asyncio.get_event_loop()
|
loop = asyncio.get_event_loop()
|
||||||
loop.run_until_complete(main())
|
loop.run_until_complete(main())
|
||||||
```
|
```
|
||||||
|
|
||||||
## Config examples
|
## Config examples
|
||||||
|
|
||||||
For bot config examples please check the examples directory. Without a valid config file, the bot won't start at all, so
|
For bot config examples please check the examples directory. Without a valid config file, the bot won't start at all, so you need to make sure the correct config file is used.
|
||||||
you need to make sure the correct config file is used.
|
|
||||||
|
@@ -1,4 +0,0 @@
|
|||||||
# Examples
|
|
||||||
|
|
||||||
If you're looking for Pyrogram usage examples, please take a look at
|
|
||||||
the [PyrogramBotBase](https://git.end-play.xyz/profitroll/PyrogramBotBase) repository.
|
|
@@ -1,5 +1,5 @@
|
|||||||
[build-system]
|
[build-system]
|
||||||
requires = ["setuptools>=77.0.3", "wheel"]
|
requires = ["setuptools>=62.6", "wheel"]
|
||||||
build-backend = "setuptools.build_meta"
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
@@ -8,16 +8,17 @@ 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"
|
||||||
requires-python = ">=3.11"
|
requires-python = ">=3.9"
|
||||||
license = "GPL-3.0"
|
license = { text = "GPLv3" }
|
||||||
license-files = ["LICENSE"]
|
|
||||||
classifiers = [
|
classifiers = [
|
||||||
"Development Status :: 3 - Alpha",
|
"Development Status :: 3 - Alpha",
|
||||||
"Intended Audience :: Developers",
|
"Intended Audience :: Developers",
|
||||||
|
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
|
||||||
"Operating System :: OS Independent",
|
"Operating System :: OS Independent",
|
||||||
|
"Programming Language :: Python :: 3.9",
|
||||||
|
"Programming Language :: Python :: 3.10",
|
||||||
"Programming Language :: Python :: 3.11",
|
"Programming Language :: Python :: 3.11",
|
||||||
"Programming Language :: Python :: 3.12",
|
"Programming Language :: Python :: 3.12",
|
||||||
"Programming Language :: Python :: 3.13",
|
|
||||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||||
"Topic :: Utilities",
|
"Topic :: Utilities",
|
||||||
]
|
]
|
||||||
@@ -31,7 +32,6 @@ dev = { file = "requirements/dev.txt" }
|
|||||||
pycord = { file = "requirements/pycord.txt" }
|
pycord = { file = "requirements/pycord.txt" }
|
||||||
pyrogram = { file = "requirements/pyrogram.txt" }
|
pyrogram = { file = "requirements/pyrogram.txt" }
|
||||||
speed = { file = "requirements/speed.txt" }
|
speed = { file = "requirements/speed.txt" }
|
||||||
cache = { file = "requirements/cache.txt" }
|
|
||||||
|
|
||||||
[project.urls]
|
[project.urls]
|
||||||
Source = "https://git.end-play.xyz/profitroll/LibBotUniversal"
|
Source = "https://git.end-play.xyz/profitroll/LibBotUniversal"
|
||||||
@@ -42,8 +42,7 @@ Tracker = "https://git.end-play.xyz/profitroll/LibBotUniversal/issues"
|
|||||||
where = ["src"]
|
where = ["src"]
|
||||||
|
|
||||||
[tool.black]
|
[tool.black]
|
||||||
line-length = 108
|
target-version = ['py39', 'py310', 'py311' ,'py312']
|
||||||
target-version = ["py311", "py312", "py313"]
|
|
||||||
|
|
||||||
[tool.isort]
|
[tool.isort]
|
||||||
profile = "black"
|
profile = "black"
|
||||||
@@ -53,8 +52,6 @@ minversion = "6.0"
|
|||||||
python_files = ["test_*.py"]
|
python_files = ["test_*.py"]
|
||||||
pythonpath = "."
|
pythonpath = "."
|
||||||
testpaths = ["tests"]
|
testpaths = ["tests"]
|
||||||
asyncio_mode = "auto"
|
|
||||||
asyncio_default_fixture_loop_scope = "function"
|
|
||||||
|
|
||||||
[tool.mypy]
|
[tool.mypy]
|
||||||
namespace_packages = true
|
namespace_packages = true
|
||||||
@@ -62,12 +59,9 @@ install_types = true
|
|||||||
strict = true
|
strict = true
|
||||||
show_error_codes = true
|
show_error_codes = true
|
||||||
|
|
||||||
[tool.pylint]
|
|
||||||
disable = ["line-too-long"]
|
|
||||||
|
|
||||||
[tool.pylint.main]
|
[tool.pylint.main]
|
||||||
extension-pkg-whitelist = ["ujson"]
|
extension-pkg-whitelist = ["ujson"]
|
||||||
py-version = 3.11
|
py-version = 3.9
|
||||||
|
|
||||||
[tool.coverage.run]
|
[tool.coverage.run]
|
||||||
source = ["libbot"]
|
source = ["libbot"]
|
||||||
|
@@ -1,2 +1 @@
|
|||||||
aiofiles>=23.0.0
|
aiofiles>=23.0.0
|
||||||
typing-extensions~=4.15.0
|
|
@@ -1,2 +0,0 @@
|
|||||||
pymemcache~=4.0.0
|
|
||||||
redis~=6.4.0
|
|
@@ -1,12 +1,11 @@
|
|||||||
black==25.1.0
|
black==24.10.0
|
||||||
build==1.3.0
|
build==1.2.2.post1
|
||||||
isort==5.13.2
|
isort==5.13.2
|
||||||
mypy==1.17.1
|
mypy==1.13.0
|
||||||
pylint==3.3.8
|
pylint==3.3.2
|
||||||
pytest-asyncio==1.1.0
|
pytest-asyncio==0.25.0
|
||||||
pytest-cov==6.2.1
|
pytest-cov==6.0.0
|
||||||
pytest==8.4.1
|
pytest==8.3.4
|
||||||
tox==4.29.0
|
tox==4.23.2
|
||||||
twine==6.1.0
|
types-aiofiles==24.1.0.20240626
|
||||||
types-aiofiles==24.1.0.20250822
|
types-ujson==5.10.0.20240515
|
||||||
types-ujson==5.10.0.20250822
|
|
@@ -1 +1 @@
|
|||||||
ujson~=5.11.0
|
ujson~=5.10.0
|
@@ -1,5 +1,6 @@
|
|||||||
__version__ = "4.4.0"
|
__version__ = "3.3.0"
|
||||||
__license__ = "GPL3"
|
__license__ = "GPL3"
|
||||||
__author__ = "Profitroll"
|
__author__ = "Profitroll"
|
||||||
|
|
||||||
from . import utils, errors, i18n, pycord, pyrogram
|
from . import errors, i18n, pycord, pyrogram, sync
|
||||||
|
from .__main__ import config_delete, config_get, config_set, json_read, json_write
|
||||||
|
131
src/libbot/__main__.py
Normal file
131
src/libbot/__main__.py
Normal file
@@ -0,0 +1,131 @@
|
|||||||
|
from pathlib import Path
|
||||||
|
from typing import Any, Union
|
||||||
|
|
||||||
|
import aiofiles
|
||||||
|
|
||||||
|
try:
|
||||||
|
from ujson import dumps, loads
|
||||||
|
except ImportError:
|
||||||
|
from json import dumps, loads
|
||||||
|
|
||||||
|
from ._utils import supports_argument
|
||||||
|
from .sync._nested import nested_delete, nested_set
|
||||||
|
|
||||||
|
DEFAULT_CONFIG_LOCATION: str = "config.json"
|
||||||
|
|
||||||
|
|
||||||
|
async def json_read(path: Union[str, Path]) -> Any:
|
||||||
|
"""Read contents of a JSON file
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* path (`Union[str, Path]`): Path-like object or path as a string
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `Any`: File contents
|
||||||
|
"""
|
||||||
|
async with aiofiles.open(str(path), mode="r", encoding="utf-8") as f:
|
||||||
|
data = await f.read()
|
||||||
|
|
||||||
|
return loads(data)
|
||||||
|
|
||||||
|
|
||||||
|
async def json_write(data: Any, path: Union[str, Path]) -> None:
|
||||||
|
"""Write contents to a JSON file
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* data (`Any`): Contents to write. Must be a JSON serializable
|
||||||
|
* path (`Union[str, Path]`): Path-like object or path as a string of a destination
|
||||||
|
"""
|
||||||
|
async with aiofiles.open(str(path), mode="w", encoding="utf-8") as f:
|
||||||
|
await f.write(
|
||||||
|
dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
|
||||||
|
if supports_argument(dumps, "escape_forward_slashes")
|
||||||
|
else dumps(data, ensure_ascii=False, indent=4)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def config_get(
|
||||||
|
key: str, *path: str, config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION
|
||||||
|
) -> Any:
|
||||||
|
"""Get a value of the config key by its path provided
|
||||||
|
For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): Key that contains the value
|
||||||
|
* *path (`str`): Path to the key that contains the value
|
||||||
|
* config_file (`Union[str, Path]`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `Any`: Key's value
|
||||||
|
|
||||||
|
### Example:
|
||||||
|
Get the "salary" of "Pete" from this JSON structure:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"users": {
|
||||||
|
"Pete": {
|
||||||
|
"salary": 10.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This can be easily done with the following code:
|
||||||
|
```python
|
||||||
|
import libbot
|
||||||
|
salary = await libbot.config_get("salary", "users", "Pete")
|
||||||
|
```
|
||||||
|
"""
|
||||||
|
this_key = await json_read(config_file)
|
||||||
|
|
||||||
|
for dict_key in path:
|
||||||
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
|
return this_key[key]
|
||||||
|
|
||||||
|
|
||||||
|
async def config_set(
|
||||||
|
key: str, value: Any, *path: str, config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION
|
||||||
|
) -> None:
|
||||||
|
"""Set config's key by its path to the value
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): Key that leads to the value
|
||||||
|
* value (`Any`): Any JSON serializable data
|
||||||
|
* *path (`str`): Path to the key of the target
|
||||||
|
* config_file (`Union[str, Path]`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||||
|
|
||||||
|
### Raises:
|
||||||
|
* `KeyError`: Key is not found under path provided
|
||||||
|
"""
|
||||||
|
await json_write(
|
||||||
|
nested_set(await json_read(config_file), value, *(*path, key)), config_file
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def config_delete(
|
||||||
|
key: str,
|
||||||
|
*path: str,
|
||||||
|
missing_ok: bool = False,
|
||||||
|
config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION,
|
||||||
|
) -> None:
|
||||||
|
"""Set config's key by its path
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): Key to delete
|
||||||
|
* *path (`str`): Path to the key of the target
|
||||||
|
* missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
|
||||||
|
* config_file (`Union[str, Path]`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||||
|
|
||||||
|
### Raises:
|
||||||
|
* `KeyError`: Key is not found under path provided and `missing_ok` is `False`
|
||||||
|
"""
|
||||||
|
config_data = await json_read(config_file)
|
||||||
|
|
||||||
|
try:
|
||||||
|
nested_delete(config_data, *(*path, key))
|
||||||
|
except KeyError as exc:
|
||||||
|
if not missing_ok:
|
||||||
|
raise exc from exc
|
||||||
|
|
||||||
|
await json_write(config_data, config_file)
|
22
src/libbot/_utils.py
Normal file
22
src/libbot/_utils.py
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
import inspect
|
||||||
|
from typing import Callable
|
||||||
|
|
||||||
|
|
||||||
|
def supports_argument(func: Callable, arg_name: str) -> bool:
|
||||||
|
"""Check whether a function has a specific argument
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* func (`Callable`): Function to be inspected
|
||||||
|
* arg_name (`str`): Argument to be checked
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `bool`: `True` if argument is supported and `False` if not
|
||||||
|
"""
|
||||||
|
if hasattr(func, "__code__"):
|
||||||
|
return arg_name in inspect.signature(func).parameters
|
||||||
|
elif hasattr(func, "__doc__"):
|
||||||
|
if doc := func.__doc__:
|
||||||
|
first_line = doc.splitlines()[0]
|
||||||
|
return arg_name in first_line
|
||||||
|
|
||||||
|
return False
|
2
src/libbot/cache/__init__.py
vendored
2
src/libbot/cache/__init__.py
vendored
@@ -1,2 +0,0 @@
|
|||||||
# This file is left empty on purpose
|
|
||||||
# Adding imports here will cause import errors when libbot[pycord] is not installed
|
|
3
src/libbot/cache/classes/__init__.py
vendored
3
src/libbot/cache/classes/__init__.py
vendored
@@ -1,3 +0,0 @@
|
|||||||
from .cache import Cache
|
|
||||||
from .cache_memcached import CacheMemcached
|
|
||||||
from .cache_redis import CacheRedis
|
|
44
src/libbot/cache/classes/cache.py
vendored
44
src/libbot/cache/classes/cache.py
vendored
@@ -1,44 +0,0 @@
|
|||||||
from abc import ABC, abstractmethod
|
|
||||||
from typing import Any, Dict, Optional
|
|
||||||
|
|
||||||
import pymemcache
|
|
||||||
import redis
|
|
||||||
|
|
||||||
|
|
||||||
class Cache(ABC):
|
|
||||||
client: pymemcache.Client | redis.Redis
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
@abstractmethod
|
|
||||||
def from_config(cls, engine_config: Dict[str, Any]) -> Any:
|
|
||||||
pass
|
|
||||||
|
|
||||||
@abstractmethod
|
|
||||||
def get_json(self, key: str) -> Any | None:
|
|
||||||
# TODO This method must also carry out ObjectId conversion!
|
|
||||||
pass
|
|
||||||
|
|
||||||
@abstractmethod
|
|
||||||
def get_string(self, key: str) -> str | None:
|
|
||||||
pass
|
|
||||||
|
|
||||||
@abstractmethod
|
|
||||||
def get_object(self, key: str) -> Any | None:
|
|
||||||
pass
|
|
||||||
|
|
||||||
@abstractmethod
|
|
||||||
def set_json(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
|
|
||||||
# TODO This method must also carry out ObjectId conversion!
|
|
||||||
pass
|
|
||||||
|
|
||||||
@abstractmethod
|
|
||||||
def set_string(self, key: str, value: str, ttl_seconds: Optional[int] = None) -> None:
|
|
||||||
pass
|
|
||||||
|
|
||||||
@abstractmethod
|
|
||||||
def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
|
|
||||||
pass
|
|
||||||
|
|
||||||
@abstractmethod
|
|
||||||
def delete(self, key: str) -> None:
|
|
||||||
pass
|
|
112
src/libbot/cache/classes/cache_memcached.py
vendored
112
src/libbot/cache/classes/cache_memcached.py
vendored
@@ -1,112 +0,0 @@
|
|||||||
import logging
|
|
||||||
from logging import Logger
|
|
||||||
from typing import Dict, Any, Optional
|
|
||||||
|
|
||||||
from pymemcache import Client
|
|
||||||
|
|
||||||
from .cache import Cache
|
|
||||||
from ..utils._objects import _json_to_string, _string_to_json
|
|
||||||
|
|
||||||
logger: Logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
class CacheMemcached(Cache):
|
|
||||||
client: Client
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self, client: Client, prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = None
|
|
||||||
) -> None:
|
|
||||||
self.client: Client = client
|
|
||||||
self.prefix: str | None = prefix
|
|
||||||
self.default_ttl_seconds: int = default_ttl_seconds if default_ttl_seconds is not None else 0
|
|
||||||
|
|
||||||
logger.info("Initialized Memcached for caching")
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def from_config(cls, engine_config: Dict[str, Any], prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = None) -> "CacheMemcached":
|
|
||||||
if "uri" not in engine_config:
|
|
||||||
raise KeyError(
|
|
||||||
"Cache configuration is invalid. Please check if all keys are set (engine: memcached)"
|
|
||||||
)
|
|
||||||
|
|
||||||
return cls(Client(engine_config["uri"], default_noreply=True), prefix=prefix, default_ttl_seconds=default_ttl_seconds)
|
|
||||||
|
|
||||||
def _get_prefixed_key(self, key: str) -> str:
|
|
||||||
return key if self.prefix is None else f"{self.prefix}_{key}"
|
|
||||||
|
|
||||||
def get_json(self, key: str) -> Any | None:
|
|
||||||
key = self._get_prefixed_key(key)
|
|
||||||
|
|
||||||
try:
|
|
||||||
result: Any | None = self.client.get(key, None)
|
|
||||||
|
|
||||||
logger.debug(
|
|
||||||
"Got json cache key '%s'%s",
|
|
||||||
key,
|
|
||||||
"" if result is not None else " (not found)",
|
|
||||||
)
|
|
||||||
except Exception as exc:
|
|
||||||
logger.error("Could not get json cache key '%s' due to: %s", key, exc)
|
|
||||||
return None
|
|
||||||
|
|
||||||
return None if result is None else _string_to_json(result)
|
|
||||||
|
|
||||||
def get_string(self, key: str) -> str | None:
|
|
||||||
key = self._get_prefixed_key(key)
|
|
||||||
|
|
||||||
try:
|
|
||||||
result: str | None = self.client.get(key, None)
|
|
||||||
|
|
||||||
logger.debug(
|
|
||||||
"Got string cache key '%s'%s",
|
|
||||||
key,
|
|
||||||
"" if result is not None else " (not found)",
|
|
||||||
)
|
|
||||||
|
|
||||||
return result
|
|
||||||
except Exception as exc:
|
|
||||||
logger.error("Could not get string cache key '%s' due to: %s", key, exc)
|
|
||||||
return None
|
|
||||||
|
|
||||||
# TODO Implement binary deserialization
|
|
||||||
def get_object(self, key: str) -> Any | None:
|
|
||||||
raise NotImplementedError()
|
|
||||||
|
|
||||||
def set_json(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
|
|
||||||
key = self._get_prefixed_key(key)
|
|
||||||
|
|
||||||
try:
|
|
||||||
self.client.set(
|
|
||||||
key,
|
|
||||||
_json_to_string(value),
|
|
||||||
expire=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds,
|
|
||||||
)
|
|
||||||
logger.debug("Set json cache key '%s'", key)
|
|
||||||
except Exception as exc:
|
|
||||||
logger.error("Could not set json cache key '%s' due to: %s", key, exc)
|
|
||||||
return None
|
|
||||||
|
|
||||||
def set_string(self, key: str, value: str, ttl_seconds: Optional[int] = None) -> None:
|
|
||||||
key = self._get_prefixed_key(key)
|
|
||||||
|
|
||||||
try:
|
|
||||||
self.client.set(
|
|
||||||
key, value, expire=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds
|
|
||||||
)
|
|
||||||
logger.debug("Set string cache key '%s'", key)
|
|
||||||
except Exception as exc:
|
|
||||||
logger.error("Could not set string cache key '%s' due to: %s", key, exc)
|
|
||||||
return None
|
|
||||||
|
|
||||||
# TODO Implement binary serialization
|
|
||||||
def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
|
|
||||||
raise NotImplementedError()
|
|
||||||
|
|
||||||
def delete(self, key: str) -> None:
|
|
||||||
key = self._get_prefixed_key(key)
|
|
||||||
|
|
||||||
try:
|
|
||||||
self.client.delete(key)
|
|
||||||
logger.debug("Deleted cache key '%s'", key)
|
|
||||||
except Exception as exc:
|
|
||||||
logger.error("Could not delete cache key '%s' due to: %s", key, exc)
|
|
110
src/libbot/cache/classes/cache_redis.py
vendored
110
src/libbot/cache/classes/cache_redis.py
vendored
@@ -1,110 +0,0 @@
|
|||||||
import logging
|
|
||||||
from logging import Logger
|
|
||||||
from typing import Dict, Any, Optional
|
|
||||||
|
|
||||||
from redis import Redis
|
|
||||||
|
|
||||||
from .cache import Cache
|
|
||||||
from ..utils._objects import _json_to_string, _string_to_json
|
|
||||||
|
|
||||||
logger: Logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
class CacheRedis(Cache):
|
|
||||||
client: Redis
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self, client: Redis, prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = None
|
|
||||||
) -> None:
|
|
||||||
self.client: Redis = client
|
|
||||||
self.prefix: str | None = prefix
|
|
||||||
self.default_ttl_seconds: int | None = default_ttl_seconds
|
|
||||||
|
|
||||||
logger.info("Initialized Redis for caching")
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def from_config(cls, engine_config: Dict[str, Any], prefix: Optional[str] = None, default_ttl_seconds: Optional[int] = None) -> Any:
|
|
||||||
if "uri" not in engine_config:
|
|
||||||
raise KeyError(
|
|
||||||
"Cache configuration is invalid. Please check if all keys are set (engine: memcached)"
|
|
||||||
)
|
|
||||||
|
|
||||||
return cls(Redis.from_url(engine_config["uri"]), prefix=prefix, default_ttl_seconds=default_ttl_seconds)
|
|
||||||
|
|
||||||
def _get_prefixed_key(self, key: str) -> str:
|
|
||||||
return key if self.prefix is None else f"{self.prefix}_{key}"
|
|
||||||
|
|
||||||
def get_json(self, key: str) -> Any | None:
|
|
||||||
key = self._get_prefixed_key(key)
|
|
||||||
|
|
||||||
try:
|
|
||||||
result: Any | None = self.client.get(key)
|
|
||||||
|
|
||||||
logger.debug(
|
|
||||||
"Got json cache key '%s'%s",
|
|
||||||
key,
|
|
||||||
"" if result is not None else " (not found)",
|
|
||||||
)
|
|
||||||
except Exception as exc:
|
|
||||||
logger.error("Could not get json cache key '%s' due to: %s", key, exc)
|
|
||||||
return None
|
|
||||||
|
|
||||||
return None if result is None else _string_to_json(result)
|
|
||||||
|
|
||||||
def get_string(self, key: str) -> str | None:
|
|
||||||
key = self._get_prefixed_key(key)
|
|
||||||
|
|
||||||
try:
|
|
||||||
result: str | None = self.client.get(key)
|
|
||||||
|
|
||||||
logger.debug(
|
|
||||||
"Got string cache key '%s'%s",
|
|
||||||
key,
|
|
||||||
"" if result is not None else " (not found)",
|
|
||||||
)
|
|
||||||
|
|
||||||
return result
|
|
||||||
except Exception as exc:
|
|
||||||
logger.error("Could not get string cache key '%s' due to: %s", key, exc)
|
|
||||||
return None
|
|
||||||
|
|
||||||
# TODO Implement binary deserialization
|
|
||||||
def get_object(self, key: str) -> Any | None:
|
|
||||||
raise NotImplementedError()
|
|
||||||
|
|
||||||
def set_json(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
|
|
||||||
key = self._get_prefixed_key(key)
|
|
||||||
|
|
||||||
try:
|
|
||||||
self.client.set(
|
|
||||||
key,
|
|
||||||
_json_to_string(value),
|
|
||||||
ex=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds,
|
|
||||||
)
|
|
||||||
logger.debug("Set json cache key '%s'", key)
|
|
||||||
except Exception as exc:
|
|
||||||
logger.error("Could not set json cache key '%s' due to: %s", key, exc)
|
|
||||||
return None
|
|
||||||
|
|
||||||
def set_string(self, key: str, value: str, ttl_seconds: Optional[int] = None) -> None:
|
|
||||||
key = self._get_prefixed_key(key)
|
|
||||||
|
|
||||||
try:
|
|
||||||
self.client.set(key, value, ex=self.default_ttl_seconds if ttl_seconds is None else ttl_seconds)
|
|
||||||
logger.debug("Set string cache key '%s'", key)
|
|
||||||
except Exception as exc:
|
|
||||||
logger.error("Could not set string cache key '%s' due to: %s", key, exc)
|
|
||||||
return None
|
|
||||||
|
|
||||||
# TODO Implement binary serialization
|
|
||||||
def set_object(self, key: str, value: Any, ttl_seconds: Optional[int] = None) -> None:
|
|
||||||
raise NotImplementedError()
|
|
||||||
|
|
||||||
def delete(self, key: str) -> None:
|
|
||||||
key = self._get_prefixed_key(key)
|
|
||||||
|
|
||||||
try:
|
|
||||||
self.client.delete(key)
|
|
||||||
logger.debug("Deleted cache key '%s'", key)
|
|
||||||
except Exception as exc:
|
|
||||||
logger.error("Could not delete cache key '%s' due to: %s", key, exc)
|
|
1
src/libbot/cache/manager/__init__.py
vendored
1
src/libbot/cache/manager/__init__.py
vendored
@@ -1 +0,0 @@
|
|||||||
from .manager import create_cache_client
|
|
37
src/libbot/cache/manager/manager.py
vendored
37
src/libbot/cache/manager/manager.py
vendored
@@ -1,37 +0,0 @@
|
|||||||
from typing import Dict, Any, Literal, Optional
|
|
||||||
|
|
||||||
from ..classes import CacheMemcached, CacheRedis
|
|
||||||
|
|
||||||
|
|
||||||
def create_cache_client(
|
|
||||||
config: Dict[str, Any],
|
|
||||||
engine: Literal["memcached", "redis"] | None = None,
|
|
||||||
prefix: Optional[str] = None,
|
|
||||||
default_ttl_seconds: Optional[int] = None,
|
|
||||||
) -> CacheMemcached | CacheRedis:
|
|
||||||
"""Create a cache client of a provided type.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
config (Dict[str, Any]): Cache client configuration.
|
|
||||||
engine (Literal["memcached", "redis"] | None): Cache engine to use. Defaults to None.
|
|
||||||
prefix (:obj:`str`, optional): Prefix used for each key-value pair. Defaults to None (no prefix).
|
|
||||||
default_ttl_seconds (:obj:`int`, optional): Default TTL for values (in seconds). Defaults to None (does not expire).
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
CacheMemcached | CacheRedis: Cache client.
|
|
||||||
"""
|
|
||||||
if engine not in ["memcached", "redis"] or engine is None:
|
|
||||||
raise KeyError(f"Incorrect cache engine provided. Expected 'memcached' or 'redis', got '{engine}'")
|
|
||||||
|
|
||||||
if "cache" not in config or engine not in config["cache"]:
|
|
||||||
raise KeyError(
|
|
||||||
f"Cache configuration is invalid. Please check if all keys are set (engine: '{engine}')"
|
|
||||||
)
|
|
||||||
|
|
||||||
match engine:
|
|
||||||
case "memcached":
|
|
||||||
return CacheMemcached.from_config(config["cache"][engine], prefix=prefix, default_ttl_seconds=default_ttl_seconds)
|
|
||||||
case "redis":
|
|
||||||
return CacheRedis.from_config(config["cache"][engine], prefix=prefix, default_ttl_seconds=default_ttl_seconds)
|
|
||||||
case _:
|
|
||||||
raise KeyError(f"Cache implementation for the engine '{engine}' is not present.")
|
|
0
src/libbot/cache/utils/__init__.py
vendored
0
src/libbot/cache/utils/__init__.py
vendored
42
src/libbot/cache/utils/_objects.py
vendored
42
src/libbot/cache/utils/_objects.py
vendored
@@ -1,42 +0,0 @@
|
|||||||
import logging
|
|
||||||
from copy import deepcopy
|
|
||||||
from logging import Logger
|
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
try:
|
|
||||||
from ujson import dumps, loads
|
|
||||||
except ImportError:
|
|
||||||
from json import dumps, loads
|
|
||||||
|
|
||||||
logger: Logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
try:
|
|
||||||
from bson import ObjectId
|
|
||||||
except ImportError:
|
|
||||||
logger.warning(
|
|
||||||
"Could not import bson.ObjectId. PyMongo conversions will not be supported by the cache. It's safe to ignore this message if you do not use MongoDB."
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _json_to_string(json_object: Any) -> str:
|
|
||||||
json_object_copy: Any = deepcopy(json_object)
|
|
||||||
|
|
||||||
if isinstance(json_object_copy, dict) and "_id" in json_object_copy:
|
|
||||||
json_object_copy["_id"] = str(json_object_copy["_id"])
|
|
||||||
|
|
||||||
return dumps(json_object_copy, ensure_ascii=False, indent=0, escape_forward_slashes=False)
|
|
||||||
|
|
||||||
|
|
||||||
def _string_to_json(json_string: str) -> Any:
|
|
||||||
json_object: Any = loads(json_string)
|
|
||||||
|
|
||||||
if "_id" in json_object:
|
|
||||||
try:
|
|
||||||
json_object["_id"] = ObjectId(json_object["_id"])
|
|
||||||
except NameError:
|
|
||||||
logger.debug(
|
|
||||||
"Tried to convert attribute '_id' with value '%s' but bson.ObjectId is not present, skipping the conversion.",
|
|
||||||
json_object["_id"],
|
|
||||||
)
|
|
||||||
|
|
||||||
return json_object
|
|
@@ -1,15 +1,15 @@
|
|||||||
from typing import Any, List, Optional
|
from typing import Any, List, Optional, Union
|
||||||
|
|
||||||
|
|
||||||
class ConfigKeyError(Exception):
|
class ConfigKeyError(Exception):
|
||||||
"""Raised when config key is not found.
|
"""Raised when config key is not found.
|
||||||
|
|
||||||
### Attributes:
|
### Attributes:
|
||||||
* key (`str | List[str]`): Missing config key.
|
* key (`Union[str, List[str]]`): Missing config key.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, key: str | List[str]) -> None:
|
def __init__(self, key: Union[str, List[str]]) -> None:
|
||||||
self.key: str | List[str] = key
|
self.key: Union[str, List[str]] = key
|
||||||
super().__init__(
|
super().__init__(
|
||||||
f"Config key {'.'.join(key) if isinstance(key, list) else key} is missing. Please set in your config file."
|
f"Config key {'.'.join(key) if isinstance(key, list) else key} is missing. Please set in your config file."
|
||||||
)
|
)
|
||||||
@@ -22,12 +22,12 @@ class ConfigValueError(Exception):
|
|||||||
"""Raised when config key's value is invalid.
|
"""Raised when config key's value is invalid.
|
||||||
|
|
||||||
### Attributes:
|
### Attributes:
|
||||||
* key (`str | List[str]`): Invalid config key.
|
* key (`Union[str, List[str]]`): Invalid config key.
|
||||||
* value (`Optional[Any]`): Key's correct value.
|
* value (`Optional[Any]`): Key's correct value.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, key: str | List[str], value: Optional[Any] = None) -> None:
|
def __init__(self, key: Union[str, List[str]], value: Optional[Any] = None) -> None:
|
||||||
self.key: str | List[str] = key
|
self.key: Union[str, List[str]] = key
|
||||||
self.value: Optional[Any] = value
|
self.value: Optional[Any] = value
|
||||||
super().__init__(
|
super().__init__(
|
||||||
f"Config key {'.'.join(key) if isinstance(key, list) else key} has invalid value. {f'Must be {value}. ' if value else ''}Please set in your config file."
|
f"Config key {'.'.join(key) if isinstance(key, list) else key} has invalid value. {f'Must be {value}. ' if value else ''}Please set in your config file."
|
||||||
|
@@ -1,2 +1,118 @@
|
|||||||
from ._functions import _, in_all_locales, in_every_locale
|
from os import listdir
|
||||||
from .classes import BotLocale
|
from pathlib import Path
|
||||||
|
from typing import Any, Dict, Union
|
||||||
|
|
||||||
|
import libbot
|
||||||
|
from libbot.i18n import sync
|
||||||
|
from libbot.i18n.classes.bot_locale import BotLocale
|
||||||
|
|
||||||
|
|
||||||
|
async def _(
|
||||||
|
key: str,
|
||||||
|
*args: str,
|
||||||
|
locale: Union[str, None] = "en",
|
||||||
|
locales_root: Union[str, Path] = Path("locale"),
|
||||||
|
) -> Any:
|
||||||
|
"""Get value of locale string
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): The last key of the locale's keys path.
|
||||||
|
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||||
|
* locale (`Union[str, None]`): Locale to looked up in. Defaults to `"en"`.
|
||||||
|
* locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
|
||||||
|
"""
|
||||||
|
locale = libbot.sync.config_get("locale") if locale is None else locale
|
||||||
|
|
||||||
|
try:
|
||||||
|
this_dict = await libbot.json_read(Path(f"{locales_root}/{locale}.json"))
|
||||||
|
except FileNotFoundError:
|
||||||
|
try:
|
||||||
|
this_dict = await libbot.json_read(
|
||||||
|
Path(f'{locales_root}/{await libbot.config_get("locale")}.json')
|
||||||
|
)
|
||||||
|
except FileNotFoundError:
|
||||||
|
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||||
|
|
||||||
|
this_key = this_dict
|
||||||
|
for dict_key in args:
|
||||||
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
|
try:
|
||||||
|
return this_key[key]
|
||||||
|
except KeyError:
|
||||||
|
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||||
|
|
||||||
|
|
||||||
|
async def in_all_locales(
|
||||||
|
key: str, *args: str, locales_root: Union[str, Path] = Path("locale")
|
||||||
|
) -> list:
|
||||||
|
"""Get value of the provided key and path in all available locales
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): The last key of the locale's keys path.
|
||||||
|
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||||
|
* locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `list`: List of values in all locales
|
||||||
|
"""
|
||||||
|
|
||||||
|
output = []
|
||||||
|
files_locales = listdir(locales_root)
|
||||||
|
|
||||||
|
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||||
|
for lc in valid_locales:
|
||||||
|
try:
|
||||||
|
this_dict = await libbot.json_read(Path(f"{locales_root}/{lc}.json"))
|
||||||
|
except FileNotFoundError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
this_key = this_dict
|
||||||
|
for dict_key in args:
|
||||||
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
|
try:
|
||||||
|
output.append(this_key[key])
|
||||||
|
except KeyError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
return output
|
||||||
|
|
||||||
|
|
||||||
|
async def in_every_locale(
|
||||||
|
key: str, *args: str, locales_root: Union[str, Path] = Path("locale")
|
||||||
|
) -> Dict[str, Any]:
|
||||||
|
"""Get value of the provided key and path in every available locale with locale tag
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): The last key of the locale's keys path.
|
||||||
|
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||||
|
* locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
|
||||||
|
"""
|
||||||
|
|
||||||
|
output = {}
|
||||||
|
files_locales = listdir(locales_root)
|
||||||
|
|
||||||
|
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||||
|
for lc in valid_locales:
|
||||||
|
try:
|
||||||
|
this_dict = await libbot.json_read(Path(f"{locales_root}/{lc}.json"))
|
||||||
|
except FileNotFoundError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
this_key = this_dict
|
||||||
|
for dict_key in args:
|
||||||
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
|
try:
|
||||||
|
output[lc] = this_key[key]
|
||||||
|
except KeyError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
return output
|
||||||
|
@@ -1,232 +0,0 @@
|
|||||||
from os import listdir, PathLike
|
|
||||||
from pathlib import Path
|
|
||||||
from typing import Any, Dict, List
|
|
||||||
|
|
||||||
from ..utils.config import config_get
|
|
||||||
from ..utils.json import json_read
|
|
||||||
from ..utils.syncs import asyncable
|
|
||||||
|
|
||||||
|
|
||||||
def _get_valid_locales(locales_root: str | PathLike[str]) -> List[str]:
|
|
||||||
return [".".join(entry.split(".")[:-1]) for entry in listdir(locales_root)]
|
|
||||||
|
|
||||||
|
|
||||||
@asyncable
|
|
||||||
def _(
|
|
||||||
key: str,
|
|
||||||
*args: str,
|
|
||||||
locale: str | None = "en",
|
|
||||||
locales_root: str | Path = Path("locale"),
|
|
||||||
) -> Any:
|
|
||||||
"""Get value of locale string.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): The last key of the locale's keys path.
|
|
||||||
*args (str): Path to key like: `dict[args][key]`.
|
|
||||||
locale (str | None): Locale to looked up in. Defaults to "en".
|
|
||||||
locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`.
|
|
||||||
"""
|
|
||||||
if locale is None:
|
|
||||||
locale: str = config_get("locale")
|
|
||||||
|
|
||||||
try:
|
|
||||||
this_dict: Dict[str, Any] = json_read(Path(f"{locales_root}/{locale}.json"))
|
|
||||||
except FileNotFoundError:
|
|
||||||
try:
|
|
||||||
this_dict: Dict[str, Any] = json_read(Path(f'{locales_root}/{config_get("locale")}.json'))
|
|
||||||
except FileNotFoundError:
|
|
||||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
|
||||||
|
|
||||||
this_key: Dict[str, Any] = this_dict
|
|
||||||
|
|
||||||
for dict_key in args:
|
|
||||||
this_key = this_key[dict_key]
|
|
||||||
|
|
||||||
try:
|
|
||||||
return this_key[key]
|
|
||||||
except KeyError:
|
|
||||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
|
||||||
|
|
||||||
|
|
||||||
@_.asynchronous
|
|
||||||
async def _(
|
|
||||||
key: str,
|
|
||||||
*args: str,
|
|
||||||
locale: str | None = "en",
|
|
||||||
locales_root: str | Path = Path("locale"),
|
|
||||||
) -> Any:
|
|
||||||
"""Get value of locale string.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): The last key of the locale's keys path.
|
|
||||||
*args (str): Path to key like: `dict[args][key]`.
|
|
||||||
locale (str | None): Locale to looked up in. Defaults to "en".
|
|
||||||
locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`.
|
|
||||||
"""
|
|
||||||
locale: str = config_get("locale") if locale is None else locale
|
|
||||||
|
|
||||||
try:
|
|
||||||
this_dict: Dict[str, Any] = await json_read(Path(f"{locales_root}/{locale}.json"))
|
|
||||||
except FileNotFoundError:
|
|
||||||
try:
|
|
||||||
this_dict: Dict[str, Any] = await json_read(
|
|
||||||
Path(f'{locales_root}/{await config_get("locale")}.json')
|
|
||||||
)
|
|
||||||
except FileNotFoundError:
|
|
||||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
|
||||||
|
|
||||||
this_key: Dict[str, Any] = this_dict
|
|
||||||
|
|
||||||
for dict_key in args:
|
|
||||||
this_key = this_key[dict_key]
|
|
||||||
|
|
||||||
try:
|
|
||||||
return this_key[key]
|
|
||||||
except KeyError:
|
|
||||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
|
||||||
|
|
||||||
|
|
||||||
@asyncable
|
|
||||||
def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("locale")) -> List[Any]:
|
|
||||||
"""Get value of the provided key and path in all available locales.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): The last key of the locale's keys path.
|
|
||||||
*args (str): Path to key like: `dict[args][key]`.
|
|
||||||
locales_root (str | Path, optional): Folder where locales are located. Defaults to `Path("locale")`.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
List[Any]: List of values in all locales.
|
|
||||||
"""
|
|
||||||
|
|
||||||
output: List[Any] = []
|
|
||||||
|
|
||||||
for locale in _get_valid_locales(locales_root):
|
|
||||||
try:
|
|
||||||
this_dict: Dict[str, Any] = json_read(Path(f"{locales_root}/{locale}.json"))
|
|
||||||
except FileNotFoundError:
|
|
||||||
continue
|
|
||||||
|
|
||||||
this_key: Dict[str, Any] = this_dict
|
|
||||||
|
|
||||||
for dict_key in args:
|
|
||||||
this_key = this_key[dict_key]
|
|
||||||
|
|
||||||
try:
|
|
||||||
output.append(this_key[key])
|
|
||||||
except KeyError:
|
|
||||||
continue
|
|
||||||
|
|
||||||
return output
|
|
||||||
|
|
||||||
|
|
||||||
@in_all_locales.asynchronous
|
|
||||||
async def in_all_locales(key: str, *args: str, locales_root: str | Path = Path("locale")) -> List[Any]:
|
|
||||||
"""Get value of the provided key and path in all available locales.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): The last key of the locale's keys path.
|
|
||||||
*args (str): Path to key like: `dict[args][key]`.
|
|
||||||
locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
List[Any]: List of values in all locales.
|
|
||||||
"""
|
|
||||||
|
|
||||||
output: List[Any] = []
|
|
||||||
|
|
||||||
for locale in _get_valid_locales(locales_root):
|
|
||||||
try:
|
|
||||||
this_dict: Dict[str, Any] = await json_read(Path(f"{locales_root}/{locale}.json"))
|
|
||||||
except FileNotFoundError:
|
|
||||||
continue
|
|
||||||
|
|
||||||
this_key: Dict[str, Any] = this_dict
|
|
||||||
|
|
||||||
for dict_key in args:
|
|
||||||
this_key = this_key[dict_key]
|
|
||||||
|
|
||||||
try:
|
|
||||||
output.append(this_key[key])
|
|
||||||
except KeyError:
|
|
||||||
continue
|
|
||||||
|
|
||||||
return output
|
|
||||||
|
|
||||||
|
|
||||||
@asyncable
|
|
||||||
def in_every_locale(
|
|
||||||
key: str, *args: str, locales_root: str | Path = Path("locale")
|
|
||||||
) -> Dict[str, Any]:
|
|
||||||
"""Get value of the provided key and path in every available locale with locale tag.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): The last key of the locale's keys path.
|
|
||||||
*args (str): Path to key like: `dict[args][key]`.
|
|
||||||
locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Dict[str, Any]: Locale is a key, and it's value from locale file is a value.
|
|
||||||
"""
|
|
||||||
|
|
||||||
output: Dict[str, Any] = {}
|
|
||||||
|
|
||||||
for locale in _get_valid_locales(locales_root):
|
|
||||||
try:
|
|
||||||
this_dict: Dict[str, Any] = json_read(Path(f"{locales_root}/{locale}.json"))
|
|
||||||
except FileNotFoundError:
|
|
||||||
continue
|
|
||||||
|
|
||||||
this_key: Dict[str, Any] = this_dict
|
|
||||||
|
|
||||||
for dict_key in args:
|
|
||||||
this_key = this_key[dict_key]
|
|
||||||
|
|
||||||
try:
|
|
||||||
output[locale] = this_key[key]
|
|
||||||
except KeyError:
|
|
||||||
continue
|
|
||||||
|
|
||||||
return output
|
|
||||||
|
|
||||||
|
|
||||||
@in_every_locale.asynchronous
|
|
||||||
async def in_every_locale(
|
|
||||||
key: str, *args: str, locales_root: str | Path = Path("locale")
|
|
||||||
) -> Dict[str, Any]:
|
|
||||||
"""Get value of the provided key and path in every available locale with locale tag.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): The last key of the locale's keys path.
|
|
||||||
*args (str): Path to key like: `dict[args][key]`.
|
|
||||||
locales_root (str | Path, optional): Folder where locales are located. Defaults to Path("locale").
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Dict[str, Any]: Locale is a key, and it's value from locale file is a value.
|
|
||||||
"""
|
|
||||||
|
|
||||||
output: Dict[str, Any] = {}
|
|
||||||
|
|
||||||
for locale in _get_valid_locales(locales_root):
|
|
||||||
try:
|
|
||||||
this_dict: Dict[str, Any] = await json_read(Path(f"{locales_root}/{locale}.json"))
|
|
||||||
except FileNotFoundError:
|
|
||||||
continue
|
|
||||||
|
|
||||||
this_key: Dict[str, Any] = this_dict
|
|
||||||
|
|
||||||
for dict_key in args:
|
|
||||||
this_key = this_key[dict_key]
|
|
||||||
|
|
||||||
try:
|
|
||||||
output[locale] = this_key[key]
|
|
||||||
except KeyError:
|
|
||||||
continue
|
|
||||||
|
|
||||||
return output
|
|
@@ -1 +0,0 @@
|
|||||||
from .bot_locale import BotLocale
|
|
@@ -1,9 +1,8 @@
|
|||||||
from os import listdir
|
from os import listdir
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any, Dict, List
|
from typing import Any, Dict, Union
|
||||||
|
|
||||||
from ...utils.config import config_get
|
from libbot import sync
|
||||||
from ...utils.json import json_read
|
|
||||||
|
|
||||||
|
|
||||||
class BotLocale:
|
class BotLocale:
|
||||||
@@ -11,55 +10,52 @@ class BotLocale:
|
|||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
default_locale: str | None = "en",
|
default_locale: Union[str, None] = "en",
|
||||||
locales_root: str | Path = Path("locale"),
|
locales_root: Union[str, Path] = Path("locale"),
|
||||||
) -> None:
|
) -> None:
|
||||||
"""
|
|
||||||
Args:
|
|
||||||
default_locale (str | None, optional): Default locale. Defaults to "en".
|
|
||||||
locales_root (str | Path, optional): Path to a directory with locale files. Defaults to Path("locale").
|
|
||||||
"""
|
|
||||||
if isinstance(locales_root, str):
|
if isinstance(locales_root, str):
|
||||||
locales_root = Path(locales_root)
|
locales_root = Path(locales_root)
|
||||||
elif not isinstance(locales_root, Path):
|
elif not isinstance(locales_root, Path):
|
||||||
raise TypeError("'locales_root' must be a valid path or path-like object")
|
raise TypeError("'locales_root' must be a valid path or path-like object")
|
||||||
|
|
||||||
files_locales: List[str] = listdir(locales_root)
|
files_locales: list = listdir(locales_root)
|
||||||
|
|
||||||
valid_locales: List[str] = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
valid_locales: list = [
|
||||||
|
".".join(entry.split(".")[:-1]) for entry in files_locales
|
||||||
|
]
|
||||||
|
|
||||||
self.default: str = config_get("locale") if default_locale is None else default_locale
|
self.default: str = (
|
||||||
self.locales: Dict[str, Any] = {}
|
sync.config_get("locale") if default_locale is None else default_locale
|
||||||
|
|
||||||
for locale in valid_locales:
|
|
||||||
self.locales[locale] = json_read(Path(f"{locales_root}/{locale}.json"))
|
|
||||||
|
|
||||||
def _(self, key: str, *args: str, locale: str | None = None) -> Any:
|
|
||||||
"""Get value of locale string.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): The last key of the locale's keys path.
|
|
||||||
*args (str): Path to key like: `dict[args][key]`.
|
|
||||||
locale (str | None, optional): Locale to looked up in. Defaults to config's `"locale"` value.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Any: Value of provided locale key. Is usually `str`, `Dict[str, Any]` or `List[Any]`.
|
|
||||||
"""
|
|
||||||
if locale is None:
|
|
||||||
locale: str = self.default
|
|
||||||
|
|
||||||
try:
|
|
||||||
this_dict: Dict[str, Any] = self.locales[locale]
|
|
||||||
except KeyError:
|
|
||||||
try:
|
|
||||||
this_dict: Dict[str, Any] = self.locales[self.default]
|
|
||||||
except KeyError:
|
|
||||||
return (
|
|
||||||
f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
|
||||||
)
|
)
|
||||||
|
self.locales: dict = {}
|
||||||
|
|
||||||
this_key: Dict[str, Any] = this_dict
|
for lc in valid_locales:
|
||||||
|
self.locales[lc] = sync.json_read(Path(f"{locales_root}/{lc}.json"))
|
||||||
|
|
||||||
|
def _(self, key: str, *args: str, locale: Union[str, None] = None) -> Any:
|
||||||
|
"""Get value of locale string
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): The last key of the locale's keys path
|
||||||
|
* *args (`list`): Path to key like: `dict[args][key]`
|
||||||
|
* locale (`Union[str, None]`, *optional*): Locale to looked up in. Defaults to config's `"locale"` value
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
|
||||||
|
"""
|
||||||
|
|
||||||
|
if locale is None:
|
||||||
|
locale = self.default
|
||||||
|
|
||||||
|
try:
|
||||||
|
this_dict = self.locales[locale]
|
||||||
|
except KeyError:
|
||||||
|
try:
|
||||||
|
this_dict = self.locales[self.default]
|
||||||
|
except KeyError:
|
||||||
|
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||||
|
|
||||||
|
this_key = this_dict
|
||||||
for dict_key in args:
|
for dict_key in args:
|
||||||
this_key = this_key[dict_key]
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
@@ -68,26 +64,26 @@ class BotLocale:
|
|||||||
except KeyError:
|
except KeyError:
|
||||||
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||||
|
|
||||||
def in_all_locales(self, key: str, *args: str) -> List[Any]:
|
def in_all_locales(self, key: str, *args: str) -> list:
|
||||||
"""Get value of the provided key and path in all available locales.
|
"""Get value of the provided key and path in all available locales
|
||||||
|
|
||||||
Args:
|
### Args:
|
||||||
key (str): The last key of the locale's keys path.
|
* key (`str`): The last key of the locale's keys path.
|
||||||
*args (str): Path to key like: `dict[args][key]`.
|
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||||
|
|
||||||
Returns:
|
### Returns:
|
||||||
List[Any]: List of values in all locales.
|
* `list`: List of values in all locales
|
||||||
"""
|
"""
|
||||||
output: List[Any] = []
|
|
||||||
|
|
||||||
for name, locale in self.locales.items():
|
output = []
|
||||||
|
|
||||||
|
for name, lc in self.locales.items():
|
||||||
try:
|
try:
|
||||||
this_dict: Dict[str, Any] = locale
|
this_dict = lc
|
||||||
except KeyError:
|
except KeyError:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
this_key: Dict[str, Any] = this_dict
|
this_key = this_dict
|
||||||
|
|
||||||
for dict_key in args:
|
for dict_key in args:
|
||||||
this_key = this_key[dict_key]
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
@@ -99,25 +95,25 @@ class BotLocale:
|
|||||||
return output
|
return output
|
||||||
|
|
||||||
def in_every_locale(self, key: str, *args: str) -> Dict[str, Any]:
|
def in_every_locale(self, key: str, *args: str) -> Dict[str, Any]:
|
||||||
"""Get value of the provided key and path in every available locale with locale tag.
|
"""Get value of the provided key and path in every available locale with locale tag
|
||||||
|
|
||||||
Args:
|
### Args:
|
||||||
key (str): The last key of the locale's keys path.
|
* key (`str`): The last key of the locale's keys path.
|
||||||
*args (str): Path to key like: `dict[args][key]`.
|
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||||
|
|
||||||
Returns:
|
### Returns:
|
||||||
Dict[str, Any]: Locale is a key, and it's value from locale file is a value.
|
* `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
|
||||||
"""
|
"""
|
||||||
output: Dict[str, Any] = {}
|
|
||||||
|
|
||||||
for name, locale in self.locales.items():
|
output = {}
|
||||||
|
|
||||||
|
for name, lc in self.locales.items():
|
||||||
try:
|
try:
|
||||||
this_dict: Dict[str, Any] = locale
|
this_dict = lc
|
||||||
except KeyError:
|
except KeyError:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
this_key: Dict[str, Any] = this_dict
|
this_key = this_dict
|
||||||
|
|
||||||
for dict_key in args:
|
for dict_key in args:
|
||||||
this_key = this_key[dict_key]
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
|
117
src/libbot/i18n/sync/__init__.py
Normal file
117
src/libbot/i18n/sync/__init__.py
Normal file
@@ -0,0 +1,117 @@
|
|||||||
|
from os import listdir
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any, Dict, Union
|
||||||
|
|
||||||
|
import libbot
|
||||||
|
|
||||||
|
|
||||||
|
def _(
|
||||||
|
key: str,
|
||||||
|
*args: str,
|
||||||
|
locale: Union[str, None] = "en",
|
||||||
|
locales_root: Union[str, Path] = Path("locale"),
|
||||||
|
) -> Any:
|
||||||
|
"""Get value of locale string
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): The last key of the locale's keys path.
|
||||||
|
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||||
|
* locale (`Union[str, None]`): Locale to looked up in. Defaults to `"en"`.
|
||||||
|
* locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `Any`: Value of provided locale key. Is usually `str`, `dict` or `list`
|
||||||
|
"""
|
||||||
|
if locale is None:
|
||||||
|
locale = libbot.sync.config_get("locale")
|
||||||
|
|
||||||
|
try:
|
||||||
|
this_dict = libbot.sync.json_read(Path(f"{locales_root}/{locale}.json"))
|
||||||
|
except FileNotFoundError:
|
||||||
|
try:
|
||||||
|
this_dict = libbot.sync.json_read(
|
||||||
|
Path(f'{locales_root}/{libbot.sync.config_get("locale")}.json')
|
||||||
|
)
|
||||||
|
except FileNotFoundError:
|
||||||
|
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||||
|
|
||||||
|
this_key = this_dict
|
||||||
|
for dict_key in args:
|
||||||
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
|
try:
|
||||||
|
return this_key[key]
|
||||||
|
except KeyError:
|
||||||
|
return f'⚠️ Locale in config is invalid: could not get "{key}" in {args} from locale "{locale}"'
|
||||||
|
|
||||||
|
|
||||||
|
def in_all_locales(
|
||||||
|
key: str, *args: str, locales_root: Union[str, Path] = Path("locale")
|
||||||
|
) -> list:
|
||||||
|
"""Get value of the provided key and path in all available locales
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): The last key of the locale's keys path.
|
||||||
|
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||||
|
* locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `list`: List of values in all locales
|
||||||
|
"""
|
||||||
|
|
||||||
|
output = []
|
||||||
|
files_locales = listdir(locales_root)
|
||||||
|
|
||||||
|
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||||
|
for lc in valid_locales:
|
||||||
|
try:
|
||||||
|
this_dict = libbot.sync.json_read(Path(f"{locales_root}/{lc}.json"))
|
||||||
|
except FileNotFoundError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
this_key = this_dict
|
||||||
|
for dict_key in args:
|
||||||
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
|
try:
|
||||||
|
output.append(this_key[key])
|
||||||
|
except KeyError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
return output
|
||||||
|
|
||||||
|
|
||||||
|
def in_every_locale(
|
||||||
|
key: str, *args: str, locales_root: Union[str, Path] = Path("locale")
|
||||||
|
) -> Dict[str, Any]:
|
||||||
|
"""Get value of the provided key and path in every available locale with locale tag
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): The last key of the locale's keys path.
|
||||||
|
* *args (`list`): Path to key like: `dict[args][key]`.
|
||||||
|
* locales_root (`Union[str, Path]`, *optional*): Folder where locales are located. Defaults to `Path("locale")`.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `Dict[str, Any]`: Locale is a key and it's value from locale file is a value
|
||||||
|
"""
|
||||||
|
|
||||||
|
output = {}
|
||||||
|
files_locales = listdir(locales_root)
|
||||||
|
|
||||||
|
valid_locales = [".".join(entry.split(".")[:-1]) for entry in files_locales]
|
||||||
|
for lc in valid_locales:
|
||||||
|
try:
|
||||||
|
this_dict = libbot.sync.json_read(Path(f"{locales_root}/{lc}.json"))
|
||||||
|
except FileNotFoundError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
this_key = this_dict
|
||||||
|
for dict_key in args:
|
||||||
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
|
try:
|
||||||
|
output[lc] = this_key[key]
|
||||||
|
except KeyError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
return output
|
@@ -1,2 +0,0 @@
|
|||||||
# This file is left empty on purpose
|
|
||||||
# Adding imports here will cause import errors when libbot[pycord] is not installed
|
|
@@ -1,38 +1,47 @@
|
|||||||
import logging
|
import logging
|
||||||
from logging import Logger
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any, Dict
|
from typing import Any, Dict, List, Union
|
||||||
|
|
||||||
from typing_extensions import override
|
|
||||||
|
|
||||||
from ...i18n.classes import BotLocale
|
|
||||||
from ...utils import json_read
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||||
from apscheduler.schedulers.background import BackgroundScheduler
|
from apscheduler.schedulers.background import BackgroundScheduler
|
||||||
from discord import Bot
|
from discord import Bot
|
||||||
except ImportError as exc:
|
except ImportError as exc:
|
||||||
raise ImportError("You need to install libbot[pycord] in order to use this class.") from exc
|
raise ImportError(
|
||||||
|
"You need to install libbot[pycord] in order to use this class."
|
||||||
|
) from exc
|
||||||
|
|
||||||
logger: Logger = logging.getLogger(__name__)
|
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):
|
class PycordBot(Bot):
|
||||||
@override
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
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,
|
||||||
*args,
|
*args,
|
||||||
config: Dict[str, Any] | None = None,
|
|
||||||
config_path: str | Path = Path("config.json"),
|
|
||||||
locales_root: str | Path | None = None,
|
|
||||||
scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
|
|
||||||
**kwargs,
|
**kwargs,
|
||||||
):
|
):
|
||||||
self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
|
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__(
|
super().__init__(
|
||||||
debug_guilds=(self.config["bot"]["debug_guilds"] if self.config["debug"] else None),
|
debug_guilds=(
|
||||||
|
self.config["bot"]["debug_guilds"] if self.config["debug"] else None
|
||||||
|
),
|
||||||
owner_ids=self.config["bot"]["owners"],
|
owner_ids=self.config["bot"]["owners"],
|
||||||
*args,
|
*args,
|
||||||
**kwargs,
|
**kwargs,
|
||||||
@@ -49,18 +58,4 @@ class PycordBot(Bot):
|
|||||||
self.in_all_locales = self.bot_locale.in_all_locales
|
self.in_all_locales = self.bot_locale.in_all_locales
|
||||||
self.in_every_locale = self.bot_locale.in_every_locale
|
self.in_every_locale = self.bot_locale.in_every_locale
|
||||||
|
|
||||||
self.scheduler: AsyncIOScheduler | BackgroundScheduler | None = scheduler
|
self.scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = scheduler
|
||||||
|
|
||||||
@override
|
|
||||||
async def start(self, token: str, reconnect: bool = True, scheduler_start: bool = True) -> None:
|
|
||||||
if self.scheduler is not None and scheduler_start:
|
|
||||||
self.scheduler.start()
|
|
||||||
|
|
||||||
await super().start(token, reconnect=reconnect)
|
|
||||||
|
|
||||||
@override
|
|
||||||
async def close(self, scheduler_shutdown: bool = True, scheduler_wait: bool = True) -> None:
|
|
||||||
if self.scheduler is not None and scheduler_shutdown:
|
|
||||||
self.scheduler.shutdown(scheduler_wait)
|
|
||||||
|
|
||||||
await super().close()
|
|
||||||
|
@@ -1 +0,0 @@
|
|||||||
from .color import color_from_hex, hex_from_color
|
|
@@ -1,35 +0,0 @@
|
|||||||
from discord import Colour
|
|
||||||
|
|
||||||
|
|
||||||
def _int_from_hex(hex_string: str) -> int:
|
|
||||||
try:
|
|
||||||
return int(hex_string, base=16)
|
|
||||||
except Exception as exc:
|
|
||||||
raise ValueError("Input string must be a valid HEX code.") from exc
|
|
||||||
|
|
||||||
|
|
||||||
def _hex_from_int(color_int: int) -> str:
|
|
||||||
if not 0 <= color_int <= 0xFFFFFF:
|
|
||||||
raise ValueError("Color's value must be in the range 0 to 0xFFFFFF.")
|
|
||||||
|
|
||||||
return f"#{color_int:06x}"
|
|
||||||
|
|
||||||
|
|
||||||
def color_from_hex(hex_string: str) -> Colour:
|
|
||||||
"""Convert valid hexadecimal string to discord.Colour.
|
|
||||||
|
|
||||||
:param hex_string: Hexadecimal string to convert into Colour object
|
|
||||||
:type hex_string: str
|
|
||||||
:return: Colour object
|
|
||||||
"""
|
|
||||||
return Colour(_int_from_hex(hex_string))
|
|
||||||
|
|
||||||
|
|
||||||
def hex_from_color(color: Colour) -> str:
|
|
||||||
"""Convert discord.Colour to hexadecimal string.
|
|
||||||
|
|
||||||
:param color: Colour object to convert into the string
|
|
||||||
:type color: Colour
|
|
||||||
:return: Hexadecimal string in #XXXXXX format
|
|
||||||
"""
|
|
||||||
return _hex_from_int(color.value)
|
|
@@ -1,2 +0,0 @@
|
|||||||
# This file is left empty on purpose
|
|
||||||
# Adding imports here will cause import errors when libbot[pyrogram] is not installed
|
|
@@ -1,20 +1,10 @@
|
|||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
import sys
|
|
||||||
from datetime import datetime, timedelta
|
from datetime import datetime, timedelta
|
||||||
from logging import Logger
|
|
||||||
from os import cpu_count, getpid
|
from os import cpu_count, getpid
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from time import time
|
from time import time
|
||||||
from typing import Any, Dict, List
|
from typing import Any, Dict, List, Union
|
||||||
|
|
||||||
from typing_extensions import override
|
|
||||||
|
|
||||||
from .command import PyroCommand
|
|
||||||
from .commandset import CommandSet
|
|
||||||
from ...i18n import _
|
|
||||||
from ...i18n.classes import BotLocale
|
|
||||||
from ...utils import json_read
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import pyrogram
|
import pyrogram
|
||||||
@@ -35,59 +25,75 @@ try:
|
|||||||
BotCommandScopeDefault,
|
BotCommandScopeDefault,
|
||||||
)
|
)
|
||||||
except ImportError as exc:
|
except ImportError as exc:
|
||||||
raise ImportError("You need to install libbot[pyrogram] in order to use this class.") from exc
|
raise ImportError(
|
||||||
|
"You need to install libbot[pyrogram] in order to use this class."
|
||||||
|
) from exc
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from ujson import dumps, loads
|
from ujson import dumps, loads
|
||||||
except ImportError:
|
except ImportError:
|
||||||
from json import dumps, loads
|
from json import dumps, loads
|
||||||
|
|
||||||
logger: Logger = logging.getLogger(__name__)
|
from libbot.i18n import BotLocale
|
||||||
|
from libbot.i18n.sync import _
|
||||||
|
from libbot.pyrogram.classes.command import PyroCommand
|
||||||
|
from libbot.pyrogram.classes.commandset import CommandSet
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class PyroClient(Client):
|
class PyroClient(Client):
|
||||||
@override
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
name: str = "bot_client",
|
name: str = "bot_client",
|
||||||
owner: int | None = None,
|
owner: Union[int, None] = None,
|
||||||
config: Dict[str, Any] | None = None,
|
config: Union[Dict[str, Any], None] = None,
|
||||||
config_path: str | Path = Path("config.json"),
|
config_path: Union[str, Path] = Path("config.json"),
|
||||||
api_id: int | None = None,
|
api_id: Union[int, None] = None,
|
||||||
api_hash: str | None = None,
|
api_hash: Union[str, None] = None,
|
||||||
bot_token: str | None = None,
|
bot_token: Union[str, None] = None,
|
||||||
workers: int = min(32, cpu_count() + 4),
|
workers: int = min(32, cpu_count() + 4),
|
||||||
locales_root: str | Path | None = None,
|
locales_root: Union[str, Path, None] = None,
|
||||||
plugins_root: str = "plugins",
|
plugins_root: str = "plugins",
|
||||||
plugins_exclude: List[str] | None = None,
|
plugins_exclude: Union[List[str], None] = None,
|
||||||
sleep_threshold: int = 120,
|
sleep_threshold: int = 120,
|
||||||
max_concurrent_transmissions: int = 1,
|
max_concurrent_transmissions: int = 1,
|
||||||
commands_source: Dict[str, dict] | None = None,
|
commands_source: Union[Dict[str, dict], None] = None,
|
||||||
scoped_commands: bool | None = None,
|
scoped_commands: Union[bool, None] = None,
|
||||||
i18n_bot_info: bool = False,
|
i18n_bot_info: bool = False,
|
||||||
scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
|
scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
|
||||||
**kwargs,
|
**kwargs,
|
||||||
):
|
):
|
||||||
self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
|
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__(
|
super().__init__(
|
||||||
name=name,
|
name=name,
|
||||||
api_id=self.config["bot"]["api_id"] if api_id is None else api_id,
|
api_id=self.config["bot"]["api_id"] if api_id is None else api_id,
|
||||||
api_hash=self.config["bot"]["api_hash"] if api_hash is None else api_hash,
|
api_hash=self.config["bot"]["api_hash"] if api_hash is None else api_hash,
|
||||||
bot_token=self.config["bot"]["bot_token"] if bot_token is None else bot_token,
|
bot_token=self.config["bot"]["bot_token"]
|
||||||
|
if bot_token is None
|
||||||
|
else bot_token,
|
||||||
# Workers should be `min(32, cpu_count() + 4)`, otherwise
|
# Workers should be `min(32, cpu_count() + 4)`, otherwise
|
||||||
# handlers land in another event loop and you won't see them
|
# handlers land in another event loop and you won't see them
|
||||||
workers=self.config["bot"]["workers"] if "workers" in self.config["bot"] else workers,
|
workers=self.config["bot"]["workers"]
|
||||||
|
if "workers" in self.config["bot"]
|
||||||
|
else workers,
|
||||||
plugins=dict(
|
plugins=dict(
|
||||||
root=plugins_root,
|
root=plugins_root,
|
||||||
exclude=self.config["disabled_plugins"] if plugins_exclude is None else plugins_exclude,
|
exclude=self.config["disabled_plugins"]
|
||||||
|
if plugins_exclude is None
|
||||||
|
else plugins_exclude,
|
||||||
),
|
),
|
||||||
sleep_threshold=sleep_threshold,
|
sleep_threshold=sleep_threshold,
|
||||||
max_concurrent_transmissions=(
|
max_concurrent_transmissions=self.config["bot"][
|
||||||
self.config["bot"]["max_concurrent_transmissions"]
|
"max_concurrent_transmissions"
|
||||||
|
]
|
||||||
if "max_concurrent_transmissions" in self.config["bot"]
|
if "max_concurrent_transmissions" in self.config["bot"]
|
||||||
else max_concurrent_transmissions
|
else max_concurrent_transmissions,
|
||||||
),
|
|
||||||
**kwargs,
|
**kwargs,
|
||||||
)
|
)
|
||||||
self.owner: int = self.config["bot"]["owner"] if owner is None else owner
|
self.owner: int = self.config["bot"]["owner"] if owner is None else owner
|
||||||
@@ -96,7 +102,9 @@ class PyroClient(Client):
|
|||||||
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.scoped_commands: bool = (
|
||||||
self.config["bot"]["scoped_commands"] if scoped_commands is None else scoped_commands
|
self.config["bot"]["scoped_commands"]
|
||||||
|
if scoped_commands is None
|
||||||
|
else scoped_commands
|
||||||
)
|
)
|
||||||
self.start_time: float = 0
|
self.start_time: float = 0
|
||||||
|
|
||||||
@@ -111,14 +119,13 @@ class PyroClient(Client):
|
|||||||
self.in_all_locales = self.bot_locale.in_all_locales
|
self.in_all_locales = self.bot_locale.in_all_locales
|
||||||
self.in_every_locale = self.bot_locale.in_every_locale
|
self.in_every_locale = self.bot_locale.in_every_locale
|
||||||
|
|
||||||
self.scheduler: AsyncIOScheduler | BackgroundScheduler | None = scheduler
|
self.scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = scheduler
|
||||||
|
|
||||||
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
|
self.i18n_bot_info: bool = i18n_bot_info
|
||||||
|
|
||||||
@override
|
async def start(self, register_commands: bool = True) -> None:
|
||||||
async def start(self, register_commands: bool = True, scheduler_start: bool = True) -> None:
|
|
||||||
await super().start()
|
await super().start()
|
||||||
|
|
||||||
self.start_time = time()
|
self.start_time = time()
|
||||||
@@ -171,7 +178,7 @@ class PyroClient(Client):
|
|||||||
)
|
)
|
||||||
logger.info(
|
logger.info(
|
||||||
"Bot's info for the locale %s has been updated",
|
"Bot's info for the locale %s has been updated",
|
||||||
code,
|
self.code,
|
||||||
)
|
)
|
||||||
except KeyError:
|
except KeyError:
|
||||||
logger.warning(
|
logger.warning(
|
||||||
@@ -182,11 +189,9 @@ class PyroClient(Client):
|
|||||||
# 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:
|
||||||
await self.send_message(
|
await self.send_message(
|
||||||
chat_id=(
|
chat_id=self.owner
|
||||||
self.owner
|
|
||||||
if self.config["reports"]["chat_id"] == "owner"
|
if self.config["reports"]["chat_id"] == "owner"
|
||||||
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:
|
except BadRequest:
|
||||||
@@ -204,39 +209,32 @@ class PyroClient(Client):
|
|||||||
kwargs={"command_sets": await self.collect_commands()},
|
kwargs={"command_sets": await self.collect_commands()},
|
||||||
)
|
)
|
||||||
|
|
||||||
if scheduler_start:
|
|
||||||
self.scheduler.start()
|
self.scheduler.start()
|
||||||
|
|
||||||
@override
|
async def stop(self, exit_completely: bool = True) -> None:
|
||||||
async def stop(
|
|
||||||
self, exit_completely: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
|
|
||||||
) -> None:
|
|
||||||
try:
|
try:
|
||||||
await self.send_message(
|
await self.send_message(
|
||||||
chat_id=(
|
chat_id=self.owner
|
||||||
self.owner
|
|
||||||
if self.config["reports"]["chat_id"] == "owner"
|
if self.config["reports"]["chat_id"] == "owner"
|
||||||
else self.config["reports"]["chat_id"]
|
else self.config["reports"]["chat_id"],
|
||||||
),
|
|
||||||
text=f"Bot stopped with PID `{getpid()}`",
|
text=f"Bot stopped with PID `{getpid()}`",
|
||||||
)
|
)
|
||||||
await asyncio.sleep(0.5)
|
await asyncio.sleep(0.5)
|
||||||
except BadRequest:
|
except BadRequest:
|
||||||
logger.warning("Unable to send message to report chat.")
|
logger.warning("Unable to send message to report chat.")
|
||||||
|
|
||||||
if self.scheduler is not None and scheduler_shutdown:
|
|
||||||
self.scheduler.shutdown(scheduler_wait)
|
|
||||||
|
|
||||||
await super().stop()
|
await super().stop()
|
||||||
logger.warning("Bot stopped with PID %s.", getpid())
|
logger.warning("Bot stopped with PID %s.", getpid())
|
||||||
|
|
||||||
if exit_completely:
|
if exit_completely:
|
||||||
try:
|
try:
|
||||||
sys.exit()
|
exit()
|
||||||
except SystemExit as exc:
|
except SystemExit as exc:
|
||||||
raise SystemExit("Bot has been shut down, this is not an application error!") from exc
|
raise SystemExit(
|
||||||
|
"Bot has been shut down, this is not an application error!"
|
||||||
|
) from exc
|
||||||
|
|
||||||
async def collect_commands(self) -> 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:
|
||||||
@@ -258,9 +256,13 @@ class PyroClient(Client):
|
|||||||
scopes[dumps(scope)] = {"_": []}
|
scopes[dumps(scope)] = {"_": []}
|
||||||
|
|
||||||
# Add command to the scope's flattened key in scopes dict
|
# Add command to the scope's flattened key in scopes dict
|
||||||
scopes[dumps(scope)]["_"].append(BotCommand(command, _(command, "commands")))
|
scopes[dumps(scope)]["_"].append(
|
||||||
|
BotCommand(command, _(command, "commands"))
|
||||||
|
)
|
||||||
|
|
||||||
for locale, string in (self.in_every_locale(command, "commands")).items():
|
for locale, string in (
|
||||||
|
self.in_every_locale(command, "commands")
|
||||||
|
).items():
|
||||||
if locale not in scopes[dumps(scope)]:
|
if locale not in scopes[dumps(scope)]:
|
||||||
scopes[dumps(scope)][locale] = []
|
scopes[dumps(scope)][locale] = []
|
||||||
|
|
||||||
@@ -279,7 +281,11 @@ class PyroClient(Client):
|
|||||||
# Create object with the same name and args from the dict
|
# Create object with the same name and args from the dict
|
||||||
try:
|
try:
|
||||||
scope_obj = globals()[scope_dict["name"]](
|
scope_obj = globals()[scope_dict["name"]](
|
||||||
**{key: value for key, value in scope_dict.items() if key != "name"}
|
**{
|
||||||
|
key: value
|
||||||
|
for key, value in scope_dict.items()
|
||||||
|
if key != "name"
|
||||||
|
}
|
||||||
)
|
)
|
||||||
except NameError:
|
except NameError:
|
||||||
logger.error(
|
logger.error(
|
||||||
@@ -297,9 +303,13 @@ class PyroClient(Client):
|
|||||||
# Add set of commands to the list of the command sets
|
# Add set of commands to the list of the command sets
|
||||||
for locale, commands in locales.items():
|
for locale, commands in locales.items():
|
||||||
if locale == "_":
|
if locale == "_":
|
||||||
command_sets.append(CommandSet(commands, scope=scope_obj, language_code=""))
|
command_sets.append(
|
||||||
|
CommandSet(commands, scope=scope_obj, language_code="")
|
||||||
|
)
|
||||||
continue
|
continue
|
||||||
command_sets.append(CommandSet(commands, scope=scope_obj, language_code=locale))
|
command_sets.append(
|
||||||
|
CommandSet(commands, scope=scope_obj, language_code=locale)
|
||||||
|
)
|
||||||
|
|
||||||
logger.info("Registering the following command sets: %s", command_sets)
|
logger.info("Registering the following command sets: %s", command_sets)
|
||||||
|
|
||||||
@@ -307,9 +317,7 @@ class PyroClient(Client):
|
|||||||
# This part here looks into the handlers and looks for commands
|
# This part here looks into the handlers and looks for commands
|
||||||
# in it, if there are any. Then adds them to self.commands
|
# in it, if there are any. Then adds them to self.commands
|
||||||
for handler in self.dispatcher.groups[0]:
|
for handler in self.dispatcher.groups[0]:
|
||||||
if isinstance(handler, MessageHandler) and (
|
if isinstance(handler, MessageHandler):
|
||||||
hasattr(handler.filters, "base") or hasattr(handler.filters, "other")
|
|
||||||
):
|
|
||||||
for entry in [handler.filters.base, handler.filters.other]:
|
for entry in [handler.filters.base, handler.filters.other]:
|
||||||
if hasattr(entry, "commands"):
|
if hasattr(entry, "commands"):
|
||||||
for command in entry.commands:
|
for command in entry.commands:
|
||||||
@@ -338,7 +346,9 @@ class PyroClient(Client):
|
|||||||
command,
|
command,
|
||||||
)
|
)
|
||||||
|
|
||||||
async def register_commands(self, command_sets: List[CommandSet] | None = None) -> None:
|
async def register_commands(
|
||||||
|
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:
|
||||||
@@ -347,7 +357,10 @@ class PyroClient(Client):
|
|||||||
for command in self.commands
|
for command in self.commands
|
||||||
]
|
]
|
||||||
|
|
||||||
logger.info("Registering commands %s with a default scope 'BotCommandScopeDefault'", commands)
|
logger.info(
|
||||||
|
"Registering commands %s with a default scope 'BotCommandScopeDefault'",
|
||||||
|
commands
|
||||||
|
)
|
||||||
|
|
||||||
await self.set_bot_commands(commands)
|
await self.set_bot_commands(commands)
|
||||||
return
|
return
|
||||||
@@ -365,11 +378,15 @@ class PyroClient(Client):
|
|||||||
language_code=command_set.language_code,
|
language_code=command_set.language_code,
|
||||||
)
|
)
|
||||||
|
|
||||||
async def remove_commands(self, command_sets: List[CommandSet] | None = 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:
|
||||||
logger.info("Removing commands with a default scope 'BotCommandScopeDefault'")
|
logger.info(
|
||||||
|
"Removing commands with a default scope 'BotCommandScopeDefault'"
|
||||||
|
)
|
||||||
await self.delete_bot_commands(BotCommandScopeDefault())
|
await self.delete_bot_commands(BotCommandScopeDefault())
|
||||||
return
|
return
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from typing import List
|
from typing import List, Union
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from pyrogram.types import (
|
from pyrogram.types import (
|
||||||
@@ -13,7 +13,9 @@ try:
|
|||||||
BotCommandScopeDefault,
|
BotCommandScopeDefault,
|
||||||
)
|
)
|
||||||
except ImportError as exc:
|
except ImportError as exc:
|
||||||
raise ImportError("You need to install libbot[pyrogram] in order to use this class.") from exc
|
raise ImportError(
|
||||||
|
"You need to install libbot[pyrogram] in order to use this class."
|
||||||
|
) from exc
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
@@ -21,13 +23,13 @@ class CommandSet:
|
|||||||
"""Command stored in PyroClient's 'commands' attribute"""
|
"""Command stored in PyroClient's 'commands' attribute"""
|
||||||
|
|
||||||
commands: List[BotCommand]
|
commands: List[BotCommand]
|
||||||
scope: (
|
scope: Union[
|
||||||
BotCommandScopeDefault
|
BotCommandScopeDefault,
|
||||||
| BotCommandScopeAllPrivateChats
|
BotCommandScopeAllPrivateChats,
|
||||||
| BotCommandScopeAllGroupChats
|
BotCommandScopeAllGroupChats,
|
||||||
| BotCommandScopeAllChatAdministrators
|
BotCommandScopeAllChatAdministrators,
|
||||||
| BotCommandScopeChat
|
BotCommandScopeChat,
|
||||||
| BotCommandScopeChatAdministrators
|
BotCommandScopeChatAdministrators,
|
||||||
| BotCommandScopeChatMember
|
BotCommandScopeChatMember,
|
||||||
) = BotCommandScopeDefault
|
] = BotCommandScopeDefault
|
||||||
language_code: str = ""
|
language_code: str = ""
|
||||||
|
1
src/libbot/sync/__init__.py
Normal file
1
src/libbot/sync/__init__.py
Normal file
@@ -0,0 +1 @@
|
|||||||
|
from .__main__ import config_delete, config_get, config_set, json_read, json_write
|
127
src/libbot/sync/__main__.py
Normal file
127
src/libbot/sync/__main__.py
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
from pathlib import Path
|
||||||
|
from typing import Any, Union
|
||||||
|
|
||||||
|
from .._utils import supports_argument
|
||||||
|
from ._nested import nested_delete, nested_set
|
||||||
|
|
||||||
|
try:
|
||||||
|
from ujson import dumps, loads
|
||||||
|
except ImportError:
|
||||||
|
from json import dumps, loads
|
||||||
|
|
||||||
|
DEFAULT_CONFIG_LOCATION: str = "config.json"
|
||||||
|
|
||||||
|
|
||||||
|
def json_read(path: Union[str, Path]) -> Any:
|
||||||
|
"""Read contents of a JSON file
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* path (`Union[str, Path]`): Path-like object or path as a string
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `Any`: File contents
|
||||||
|
"""
|
||||||
|
with open(str(path), mode="r", encoding="utf-8") as f:
|
||||||
|
data = f.read()
|
||||||
|
|
||||||
|
return loads(data)
|
||||||
|
|
||||||
|
|
||||||
|
def json_write(data: Any, path: Union[str, Path]) -> None:
|
||||||
|
"""Write contents to a JSON file
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* data (`Any`): Contents to write. Must be a JSON serializable
|
||||||
|
* path (`Union[str, Path]`): Path-like object or path as a string of a destination
|
||||||
|
"""
|
||||||
|
with open(str(path), mode="w", encoding="utf-8") as f:
|
||||||
|
f.write(
|
||||||
|
dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
|
||||||
|
if supports_argument(dumps, "escape_forward_slashes")
|
||||||
|
else dumps(data, ensure_ascii=False, indent=4)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def config_get(
|
||||||
|
key: str, *path: str, config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION
|
||||||
|
) -> Any:
|
||||||
|
"""Get a value of the config key by its path provided
|
||||||
|
For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): Key that contains the value
|
||||||
|
* *path (`str`): Path to the key that contains the value
|
||||||
|
* config_file (`Union[str, Path]`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `Any`: Key's value
|
||||||
|
|
||||||
|
### Example:
|
||||||
|
Get the "salary" of "Pete" from this JSON structure:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"users": {
|
||||||
|
"Pete": {
|
||||||
|
"salary": 10.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This can be easily done with the following code:
|
||||||
|
```python
|
||||||
|
import libbot
|
||||||
|
salary = libbot.sync.config_get("salary", "users", "Pete")
|
||||||
|
```
|
||||||
|
"""
|
||||||
|
this_key = json_read(config_file)
|
||||||
|
|
||||||
|
for dict_key in path:
|
||||||
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
|
return this_key[key]
|
||||||
|
|
||||||
|
|
||||||
|
def config_set(
|
||||||
|
key: str, value: Any, *path: str, config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION
|
||||||
|
) -> None:
|
||||||
|
"""Set config's key by its path to the value
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): Key that leads to the value
|
||||||
|
* value (`Any`): Any JSON serializable data
|
||||||
|
* *path (`str`): Path to the key of the target
|
||||||
|
* config_file (`Union[str, Path]`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||||
|
|
||||||
|
### Raises:
|
||||||
|
* `KeyError`: Key is not found under path provided
|
||||||
|
"""
|
||||||
|
json_write(nested_set(json_read(config_file), value, *(*path, key)), config_file)
|
||||||
|
|
||||||
|
|
||||||
|
def config_delete(
|
||||||
|
key: str,
|
||||||
|
*path: str,
|
||||||
|
missing_ok: bool = False,
|
||||||
|
config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION,
|
||||||
|
) -> None:
|
||||||
|
"""Set config's key by its path
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* key (`str`): Key to delete
|
||||||
|
* *path (`str`): Path to the key of the target
|
||||||
|
* missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
|
||||||
|
* config_file (`Union[str, Path]`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
||||||
|
|
||||||
|
### Raises:
|
||||||
|
* `KeyError`: Key is not found under path provided and `missing_ok` is `False`
|
||||||
|
"""
|
||||||
|
config_data = json_read(config_file)
|
||||||
|
|
||||||
|
try:
|
||||||
|
nested_delete(config_data, *(*path, key))
|
||||||
|
except KeyError as exc:
|
||||||
|
if not missing_ok:
|
||||||
|
raise exc from exc
|
||||||
|
|
||||||
|
json_write(config_data, config_file)
|
64
src/libbot/sync/_nested.py
Normal file
64
src/libbot/sync/_nested.py
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
from typing import Any, Dict
|
||||||
|
|
||||||
|
|
||||||
|
def nested_set(
|
||||||
|
target: dict, value: Any, *path: str, create_missing=True
|
||||||
|
) -> Dict[str, Any]:
|
||||||
|
"""Set the key by its path to the value
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* target (`dict`): Dictionary to perform modifications on
|
||||||
|
* value (`Any`): Any data
|
||||||
|
* *path (`str`): Path to the key of the target
|
||||||
|
* create_missing (`bool`, *optional*): Create keys on the way if they're missing. Defaults to `True`
|
||||||
|
|
||||||
|
### Raises:
|
||||||
|
* `KeyError`: Key is not found under path provided
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
* `Dict[str, Any]`: Changed dictionary
|
||||||
|
"""
|
||||||
|
d = target
|
||||||
|
|
||||||
|
for key in path[:-1]:
|
||||||
|
if key in d:
|
||||||
|
d = d[key]
|
||||||
|
elif create_missing:
|
||||||
|
d = d.setdefault(key, {})
|
||||||
|
else:
|
||||||
|
raise KeyError(
|
||||||
|
f"Key '{key}' is not found under path provided ({path}) and create_missing is False"
|
||||||
|
)
|
||||||
|
|
||||||
|
if path[-1] in d or create_missing:
|
||||||
|
d[path[-1]] = value
|
||||||
|
|
||||||
|
return target
|
||||||
|
|
||||||
|
|
||||||
|
def nested_delete(target: dict, *path: str) -> Dict[str, Any]:
|
||||||
|
"""Delete the key by its path
|
||||||
|
|
||||||
|
### Args:
|
||||||
|
* target (`dict`): Dictionary to perform modifications on
|
||||||
|
|
||||||
|
### Raises:
|
||||||
|
* `KeyError`: Key is not found under path provided
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
`Dict[str, Any]`: Changed dictionary
|
||||||
|
"""
|
||||||
|
d = target
|
||||||
|
|
||||||
|
for key in path[:-1]:
|
||||||
|
if key in d:
|
||||||
|
d = d[key]
|
||||||
|
else:
|
||||||
|
raise KeyError(f"Key '{key}' is not found under path provided ({path})")
|
||||||
|
|
||||||
|
if path[-1] in d:
|
||||||
|
del d[path[-1]]
|
||||||
|
else:
|
||||||
|
raise KeyError(f"Key '{path[-1]}' is not found under path provided ({path})")
|
||||||
|
|
||||||
|
return target
|
@@ -1,3 +0,0 @@
|
|||||||
from . import misc
|
|
||||||
from .config import config_get, config_set, config_delete
|
|
||||||
from .json import json_read, json_write
|
|
@@ -1 +0,0 @@
|
|||||||
from ._functions import config_get, config_set, config_delete
|
|
@@ -1,163 +0,0 @@
|
|||||||
from pathlib import Path
|
|
||||||
from typing import Any, Dict
|
|
||||||
|
|
||||||
from ..json import json_read, json_write
|
|
||||||
from ..misc import nested_delete, nested_set
|
|
||||||
from ..syncs import asyncable
|
|
||||||
|
|
||||||
try:
|
|
||||||
from ujson import dumps, loads
|
|
||||||
except ImportError:
|
|
||||||
from json import dumps, loads
|
|
||||||
|
|
||||||
DEFAULT_CONFIG_LOCATION: str = "config.json"
|
|
||||||
|
|
||||||
|
|
||||||
@asyncable
|
|
||||||
def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION) -> Any:
|
|
||||||
"""Get a value of the config key by its path provided.
|
|
||||||
For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): Key that contains the value
|
|
||||||
*path (str): Path to the key that contains the value (pass *[] or don't pass anything at all to get on the top/root level)
|
|
||||||
config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Any: Key's value
|
|
||||||
|
|
||||||
Example:
|
|
||||||
Get the "salary" of "Pete" from this JSON structure: `{"users": {"Pete": {"salary": 10.0}}}`
|
|
||||||
|
|
||||||
This can be easily done with the following code:
|
|
||||||
|
|
||||||
>>> import libbot
|
|
||||||
salary: float = libbot.sync.config_get("salary", "users", "Pete")
|
|
||||||
"""
|
|
||||||
this_key: Dict[str, Any] = json_read(config_file)
|
|
||||||
|
|
||||||
for dict_key in path:
|
|
||||||
this_key = this_key[dict_key]
|
|
||||||
|
|
||||||
return this_key[key]
|
|
||||||
|
|
||||||
|
|
||||||
@config_get.asynchronous
|
|
||||||
async def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION) -> Any:
|
|
||||||
"""Get a value of the config key by its path provided.
|
|
||||||
For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): Key that contains the value
|
|
||||||
*path (str): Path to the key that contains the value (pass *[] or don't pass anything at all to get on the top/root level)
|
|
||||||
config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Any: Key's value
|
|
||||||
|
|
||||||
Example:
|
|
||||||
Get the "salary" of "Pete" from this JSON structure: `{"users": {"Pete": {"salary": 10.0}}}`
|
|
||||||
|
|
||||||
This can be easily done with the following code:
|
|
||||||
|
|
||||||
>>> import libbot
|
|
||||||
salary: float = libbot.sync.config_get("salary", "users", "Pete")
|
|
||||||
"""
|
|
||||||
this_key: Dict[str, Any] = await json_read(config_file)
|
|
||||||
|
|
||||||
for dict_key in path:
|
|
||||||
this_key = this_key[dict_key]
|
|
||||||
|
|
||||||
return this_key[key]
|
|
||||||
|
|
||||||
|
|
||||||
@asyncable
|
|
||||||
def config_set(key: str, value: Any, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION) -> None:
|
|
||||||
"""Set config's key by its path to the value.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): Key that leads to the value.
|
|
||||||
value (Any): Any JSON-serializable data.
|
|
||||||
*path (str): Path to the key of the target (pass *[] or don't pass anything at all to set on the top/root level).
|
|
||||||
config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to "config.json".
|
|
||||||
|
|
||||||
Raises:
|
|
||||||
KeyError: Key was not found under the provided path.
|
|
||||||
"""
|
|
||||||
json_write(nested_set(json_read(config_file), value, *(*path, key)), config_file)
|
|
||||||
|
|
||||||
|
|
||||||
@config_set.asynchronous
|
|
||||||
async def config_set(
|
|
||||||
key: str, value: Any, *path: str, config_file: str | Path = DEFAULT_CONFIG_LOCATION
|
|
||||||
) -> None:
|
|
||||||
"""Set config's key by its path to the value.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): Key that leads to the value.
|
|
||||||
value (Any): Any JSON-serializable data.
|
|
||||||
*path (str): Path to the key of the target (pass *[] or don't pass anything at all to set on the top/root level).
|
|
||||||
config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to "config.json".
|
|
||||||
|
|
||||||
Raises:
|
|
||||||
KeyError: Key was not found under the provided path.
|
|
||||||
"""
|
|
||||||
await json_write(nested_set(await json_read(config_file), value, *(*path, key)), config_file)
|
|
||||||
|
|
||||||
|
|
||||||
@asyncable
|
|
||||||
def config_delete(
|
|
||||||
key: str,
|
|
||||||
*path: str,
|
|
||||||
missing_ok: bool = False,
|
|
||||||
config_file: str | Path = DEFAULT_CONFIG_LOCATION,
|
|
||||||
) -> None:
|
|
||||||
"""Delete config's key by its path.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): Key to delete.
|
|
||||||
*path (str): Path to the key of the target (pass *[] or don't pass anything at all to delete on the top/root level)
|
|
||||||
missing_ok (bool): Do not raise an exception if the key is missing. Defaults to False.
|
|
||||||
config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to "config.json".
|
|
||||||
|
|
||||||
Raises:
|
|
||||||
KeyError: Key is not found under path provided and `missing_ok` is False.
|
|
||||||
"""
|
|
||||||
config_data: Dict[str, Any] = json_read(config_file)
|
|
||||||
|
|
||||||
try:
|
|
||||||
nested_delete(config_data, *(*path, key))
|
|
||||||
except KeyError as exc:
|
|
||||||
if not missing_ok:
|
|
||||||
raise exc from exc
|
|
||||||
|
|
||||||
json_write(config_data, config_file)
|
|
||||||
|
|
||||||
|
|
||||||
@config_delete.asynchronous
|
|
||||||
async def config_delete(
|
|
||||||
key: str,
|
|
||||||
*path: str,
|
|
||||||
missing_ok: bool = False,
|
|
||||||
config_file: str | Path = DEFAULT_CONFIG_LOCATION,
|
|
||||||
) -> None:
|
|
||||||
"""Delete config's key by its path.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
key (str): Key to delete.
|
|
||||||
*path (str): Path to the key of the target (pass *[] or don't pass anything at all to delete on the top/root level)
|
|
||||||
missing_ok (bool): Do not raise an exception if the key is missing. Defaults to False.
|
|
||||||
config_file (str | Path, optional): Path-like object or path as a string of a location of the config file. Defaults to "config.json".
|
|
||||||
|
|
||||||
Raises:
|
|
||||||
KeyError: Key is not found under path provided and `missing_ok` is False.
|
|
||||||
"""
|
|
||||||
config_data: Dict[str, Any] = await json_read(config_file)
|
|
||||||
|
|
||||||
try:
|
|
||||||
nested_delete(config_data, *(*path, key))
|
|
||||||
except KeyError as exc:
|
|
||||||
if not missing_ok:
|
|
||||||
raise exc from exc
|
|
||||||
|
|
||||||
await json_write(config_data, config_file)
|
|
@@ -1 +0,0 @@
|
|||||||
from ._functions import json_read, json_write
|
|
@@ -1,76 +0,0 @@
|
|||||||
from pathlib import Path
|
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
import aiofiles
|
|
||||||
|
|
||||||
from ..misc import supports_argument
|
|
||||||
from ..syncs import asyncable
|
|
||||||
|
|
||||||
try:
|
|
||||||
from ujson import dumps, loads
|
|
||||||
except ImportError:
|
|
||||||
from json import dumps, loads
|
|
||||||
|
|
||||||
|
|
||||||
@asyncable
|
|
||||||
def json_read(path: str | Path) -> Any:
|
|
||||||
"""Read contents of a JSON file and return it.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
path (str | Path): Path-like object or path to the file as a string.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Any: File contents.
|
|
||||||
"""
|
|
||||||
with open(str(path), mode="r", encoding="utf-8") as f:
|
|
||||||
data = f.read()
|
|
||||||
|
|
||||||
return loads(data)
|
|
||||||
|
|
||||||
|
|
||||||
@json_read.asynchronous
|
|
||||||
async def json_read(path: str | Path) -> Any:
|
|
||||||
"""Read contents of a JSON file and return it.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
path (str | Path): Path-like object or path to the file as a string.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Any: File contents.
|
|
||||||
"""
|
|
||||||
async with aiofiles.open(str(path), mode="r", encoding="utf-8") as f:
|
|
||||||
data = await f.read()
|
|
||||||
|
|
||||||
return loads(data)
|
|
||||||
|
|
||||||
|
|
||||||
@asyncable
|
|
||||||
def json_write(data: Any, path: str | Path) -> None:
|
|
||||||
"""Write contents to a JSON file.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
data (Any): Contents to write. Must be a JSON-serializable object.
|
|
||||||
path (str | Path): Path-like object or path to the file as a string.
|
|
||||||
"""
|
|
||||||
with open(str(path), mode="w", encoding="utf-8") as f:
|
|
||||||
f.write(
|
|
||||||
dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
|
|
||||||
if supports_argument(dumps, "escape_forward_slashes")
|
|
||||||
else dumps(data, ensure_ascii=False, indent=4)
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@json_write.asynchronous
|
|
||||||
async def json_write(data: Any, path: str | Path) -> None:
|
|
||||||
"""Write contents to a JSON file.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
data (Any): Contents to write. Must be a JSON-serializable object.
|
|
||||||
path (str | Path): Path-like object or path to the file as a string.
|
|
||||||
"""
|
|
||||||
async with aiofiles.open(str(path), mode="w", encoding="utf-8") as f:
|
|
||||||
await f.write(
|
|
||||||
dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
|
|
||||||
if supports_argument(dumps, "escape_forward_slashes")
|
|
||||||
else dumps(data, ensure_ascii=False, indent=4)
|
|
||||||
)
|
|
@@ -1 +0,0 @@
|
|||||||
from ._functions import supports_argument, nested_set, nested_delete
|
|
@@ -1,87 +0,0 @@
|
|||||||
import inspect
|
|
||||||
from typing import Any, Dict
|
|
||||||
from typing import Callable
|
|
||||||
|
|
||||||
|
|
||||||
def supports_argument(func: Callable[..., Any], arg_name: str) -> bool:
|
|
||||||
"""Check whether a function has a specific argument.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
func (Callable[..., Any]): Function to be inspected.
|
|
||||||
arg_name (str): Argument to be checked.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
bool: True if argument is supported and False if not.
|
|
||||||
"""
|
|
||||||
if hasattr(func, "__code__"):
|
|
||||||
return arg_name in inspect.signature(func).parameters
|
|
||||||
|
|
||||||
if hasattr(func, "__doc__"):
|
|
||||||
if doc := func.__doc__:
|
|
||||||
first_line = doc.splitlines()[0]
|
|
||||||
return arg_name in first_line
|
|
||||||
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def nested_set(
|
|
||||||
target: Dict[str, Any], value: Any, *path: str, create_missing: bool = True
|
|
||||||
) -> Dict[str, Any]:
|
|
||||||
"""Set the key by its path to the value
|
|
||||||
|
|
||||||
Args:
|
|
||||||
target (Dict[str, Any]): Dictionary to perform the modification on.
|
|
||||||
value (Any): New value.
|
|
||||||
*path (str): Path to the key.
|
|
||||||
create_missing (:obj:`bool`, optional): Create keys on the way if they're missing. Defaults to True.
|
|
||||||
|
|
||||||
Raises:
|
|
||||||
KeyError: Key is not found under the provided path.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Dict[str, Any]: Modified dictionary.
|
|
||||||
"""
|
|
||||||
target_copy: Dict[str, Any] = target
|
|
||||||
|
|
||||||
for key in path[:-1]:
|
|
||||||
if key in target_copy:
|
|
||||||
target_copy = target_copy[key]
|
|
||||||
elif create_missing:
|
|
||||||
target_copy = target_copy.setdefault(key, {})
|
|
||||||
else:
|
|
||||||
raise KeyError(
|
|
||||||
f"Key '{key}' is not found under path provided ({path}) and create_missing is False"
|
|
||||||
)
|
|
||||||
|
|
||||||
if path[-1] in target_copy or create_missing:
|
|
||||||
target_copy[path[-1]] = value
|
|
||||||
|
|
||||||
return target
|
|
||||||
|
|
||||||
|
|
||||||
def nested_delete(target: Dict[str, Any], *path: str) -> Dict[str, Any]:
|
|
||||||
"""Delete the key by its path.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
target (Dict[str, Any]): Dictionary to perform the modification on.
|
|
||||||
|
|
||||||
Raises:
|
|
||||||
KeyError: Key is not found under the provided path.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Dict[str, Any]: Modified dictionary.
|
|
||||||
"""
|
|
||||||
target_copy: Dict[str, Any] = target
|
|
||||||
|
|
||||||
for key in path[:-1]:
|
|
||||||
if key in target_copy:
|
|
||||||
target_copy = target_copy[key]
|
|
||||||
else:
|
|
||||||
raise KeyError(f"Key '{key}' is not found under path provided ({path})")
|
|
||||||
|
|
||||||
if path[-1] in target_copy:
|
|
||||||
del target_copy[path[-1]]
|
|
||||||
else:
|
|
||||||
raise KeyError(f"Key '{path[-1]}' is not found under path provided ({path})")
|
|
||||||
|
|
||||||
return target
|
|
@@ -1 +0,0 @@
|
|||||||
from ._syncs import asyncable
|
|
@@ -1,69 +0,0 @@
|
|||||||
import asyncio
|
|
||||||
import inspect
|
|
||||||
from inspect import FrameInfo
|
|
||||||
from typing import Any, Callable, Optional, Type
|
|
||||||
|
|
||||||
|
|
||||||
class asyncable:
|
|
||||||
"""Allows to mark a callable able to be async.
|
|
||||||
|
|
||||||
Source: https://itsjohannawren.medium.com/single-call-sync-and-async-in-python-2acadd07c9d6"""
|
|
||||||
|
|
||||||
def __init__(self, method: Callable):
|
|
||||||
self.__sync = method
|
|
||||||
self.__async = None
|
|
||||||
|
|
||||||
def asynchronous(self, method: Callable) -> "asyncable":
|
|
||||||
if not isinstance(method, Callable):
|
|
||||||
raise RuntimeError("NOT CALLABLE!!!")
|
|
||||||
|
|
||||||
self.__async = method
|
|
||||||
return self
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def __is_awaited() -> bool:
|
|
||||||
frame: FrameInfo = inspect.stack()[2]
|
|
||||||
|
|
||||||
if not hasattr(frame, "positions"):
|
|
||||||
return False
|
|
||||||
|
|
||||||
return (
|
|
||||||
frame.positions.col_offset >= 6
|
|
||||||
and frame.code_context[frame.index][frame.positions.col_offset - 6 : frame.positions.col_offset]
|
|
||||||
== "await "
|
|
||||||
)
|
|
||||||
|
|
||||||
def __get__(
|
|
||||||
self,
|
|
||||||
instance: Type,
|
|
||||||
*args,
|
|
||||||
owner_class: Optional[Type[Type]] = None,
|
|
||||||
**kwargs,
|
|
||||||
) -> Callable:
|
|
||||||
if self.__is_awaited():
|
|
||||||
if self.__async is None:
|
|
||||||
raise RuntimeError(
|
|
||||||
"Attempting to call asyncable with await, but no asynchronous call has been defined"
|
|
||||||
)
|
|
||||||
|
|
||||||
bound_method = self.__async.__get__(instance, owner_class)
|
|
||||||
|
|
||||||
if isinstance(self.__sync, classmethod):
|
|
||||||
return lambda: asyncio.ensure_future(bound_method(owner_class, *args, **kwargs))
|
|
||||||
|
|
||||||
return lambda: asyncio.ensure_future(bound_method(*args, **kwargs))
|
|
||||||
|
|
||||||
bound_method = self.__sync.__get__(instance, owner_class)
|
|
||||||
|
|
||||||
return lambda: bound_method(*args, **kwargs)
|
|
||||||
|
|
||||||
def __call__(self, *args, **kwargs) -> Any:
|
|
||||||
if self.__is_awaited():
|
|
||||||
if self.__async is None:
|
|
||||||
raise RuntimeError(
|
|
||||||
"Attempting to call asyncable with await, but no asynchronous call has been defined"
|
|
||||||
)
|
|
||||||
|
|
||||||
return asyncio.ensure_future(self.__async(*args, **kwargs))
|
|
||||||
|
|
||||||
return self.__sync(*args, **kwargs)
|
|
@@ -2,14 +2,5 @@
|
|||||||
"locale": "en",
|
"locale": "en",
|
||||||
"bot": {
|
"bot": {
|
||||||
"bot_token": "sample_token"
|
"bot_token": "sample_token"
|
||||||
},
|
|
||||||
"cache": {
|
|
||||||
"type": "memcached",
|
|
||||||
"memcached": {
|
|
||||||
"uri": "127.0.0.1:11211"
|
|
||||||
},
|
|
||||||
"redis": {
|
|
||||||
"uri": "redis://127.0.0.1:6379/0"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
@@ -1,6 +1,8 @@
|
|||||||
from typing import Any, List
|
from pathlib import Path
|
||||||
|
from typing import Any, List, Union
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from libbot.i18n import BotLocale
|
from libbot.i18n import BotLocale
|
||||||
|
|
||||||
|
|
||||||
@@ -18,12 +20,14 @@ from libbot.i18n import BotLocale
|
|||||||
def test_bot_locale_get(
|
def test_bot_locale_get(
|
||||||
key: str,
|
key: str,
|
||||||
args: List[str],
|
args: List[str],
|
||||||
locale: str | None,
|
locale: Union[str, None],
|
||||||
expected: Any,
|
expected: Any,
|
||||||
bot_locale: BotLocale,
|
bot_locale: BotLocale,
|
||||||
):
|
):
|
||||||
assert (
|
assert (
|
||||||
bot_locale._(key, *args, locale=locale) if locale is not None else bot_locale._(key, *args)
|
bot_locale._(key, *args, locale=locale)
|
||||||
|
if locale is not None
|
||||||
|
else bot_locale._(key, *args)
|
||||||
) == expected
|
) == expected
|
||||||
|
|
||||||
|
|
||||||
@@ -35,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, bot_locale: BotLocale):
|
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
|
||||||
|
|
||||||
|
|
||||||
@@ -47,5 +53,7 @@ def test_i18n_in_all_locales(key: str, args: List[str], expected: Any, bot_local
|
|||||||
("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, bot_locale: BotLocale):
|
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
|
||||||
|
@@ -1,28 +0,0 @@
|
|||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from libbot.cache.classes import Cache
|
|
||||||
from libbot.cache.manager import create_cache_client
|
|
||||||
|
|
||||||
try:
|
|
||||||
from ujson import JSONDecodeError, dumps, loads
|
|
||||||
except ImportError:
|
|
||||||
from json import JSONDecodeError, dumps, loads
|
|
||||||
|
|
||||||
from typing import Any, Dict
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
"engine",
|
|
||||||
[
|
|
||||||
"memcached",
|
|
||||||
"redis",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
def test_cache_creation(engine: str, location_config: Path):
|
|
||||||
with open(location_config, "r", encoding="utf-8") as file:
|
|
||||||
config: Dict[str, Any] = loads(file.read())
|
|
||||||
|
|
||||||
cache: Cache = create_cache_client(config, engine)
|
|
||||||
assert isinstance(cache, Cache)
|
|
@@ -2,7 +2,8 @@ from pathlib import Path
|
|||||||
from typing import Any, List
|
from typing import Any, List
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from libbot.utils import config_delete, config_get, config_set
|
|
||||||
|
from libbot import config_delete, config_get, config_set
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
@@ -24,9 +25,14 @@ async def test_config_get_valid(args: List[str], expected: str, location_config:
|
|||||||
(["bot_stonks", "bot"], pytest.raises(KeyError)),
|
(["bot_stonks", "bot"], pytest.raises(KeyError)),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
async def test_config_get_invalid(args: List[str], expected: Any, location_config: Path):
|
async def test_config_get_invalid(
|
||||||
|
args: List[str], expected: Any, location_config: Path
|
||||||
|
):
|
||||||
with expected:
|
with expected:
|
||||||
assert await config_get(args[0], *args[1:], config_file=location_config) == expected
|
assert (
|
||||||
|
await config_get(args[0], *args[1:], config_file=location_config)
|
||||||
|
== expected
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
@@ -62,4 +68,7 @@ async def test_config_delete(key: str, path: List[str], location_config: Path):
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
async def test_config_delete_missing(key: str, path: List[str], location_config: Path):
|
async def test_config_delete_missing(key: str, path: List[str], location_config: Path):
|
||||||
assert await config_delete(key, *path, missing_ok=True, config_file=location_config) is None
|
assert (
|
||||||
|
await config_delete(key, *path, missing_ok=True, config_file=location_config)
|
||||||
|
is None
|
||||||
|
)
|
||||||
|
@@ -2,7 +2,8 @@ from pathlib import Path
|
|||||||
from typing import Any, List
|
from typing import Any, List
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from libbot.utils import config_delete, config_get, config_set
|
|
||||||
|
from libbot import sync
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -12,8 +13,8 @@ from libbot.utils import config_delete, 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, location_config: Path):
|
def test_config_get_valid(args: List[str], expected: str, location_config: Path):
|
||||||
assert config_get(args[0], *args[1:], config_file=location_config) == expected
|
assert sync.config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -24,7 +25,9 @@ async def test_config_get_valid(args: List[str], expected: str, location_config:
|
|||||||
)
|
)
|
||||||
def test_config_get_invalid(args: List[str], expected: Any, location_config: Path):
|
def test_config_get_invalid(args: List[str], expected: Any, location_config: Path):
|
||||||
with expected:
|
with expected:
|
||||||
assert config_get(args[0], *args[1:], config_file=location_config) == expected
|
assert (
|
||||||
|
sync.config_get(args[0], *args[1:], config_file=location_config) == expected
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -35,8 +38,8 @@ def test_config_get_invalid(args: List[str], expected: Any, location_config: Pat
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
|
def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
|
||||||
config_set(key, value, *path, config_file=location_config)
|
sync.config_set(key, value, *path, config_file=location_config)
|
||||||
assert config_get(key, *path, config_file=location_config) == value
|
assert sync.config_get(key, *path, config_file=location_config) == value
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -46,8 +49,8 @@ def test_config_set(key: str, path: List[str], value: Any, location_config: Path
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_config_delete(key: str, path: List[str], location_config: Path):
|
def test_config_delete(key: str, path: List[str], location_config: Path):
|
||||||
config_delete(key, *path, config_file=location_config)
|
sync.config_delete(key, *path, config_file=location_config)
|
||||||
assert key not in config_get(*path, config_file=location_config)
|
assert key not in sync.config_get(*path, config_file=location_config)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -57,4 +60,7 @@ def test_config_delete(key: str, path: List[str], location_config: Path):
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_config_delete_missing(key: str, path: List[str], location_config: Path):
|
def test_config_delete_missing(key: str, path: List[str], location_config: Path):
|
||||||
assert config_delete(key, *path, missing_ok=True, config_file=location_config) is None
|
assert (
|
||||||
|
sync.config_delete(key, *path, missing_ok=True, config_file=location_config)
|
||||||
|
is None
|
||||||
|
)
|
||||||
|
@@ -1,7 +1,8 @@
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any, List
|
from typing import Any, List, Union
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from libbot import i18n
|
from libbot import i18n
|
||||||
|
|
||||||
|
|
||||||
@@ -20,7 +21,7 @@ from libbot import i18n
|
|||||||
async def test_i18n_get(
|
async def test_i18n_get(
|
||||||
key: str,
|
key: str,
|
||||||
args: List[str],
|
args: List[str],
|
||||||
locale: str | None,
|
locale: Union[str, None],
|
||||||
expected: Any,
|
expected: Any,
|
||||||
location_locale: Path,
|
location_locale: Path,
|
||||||
):
|
):
|
||||||
@@ -40,8 +41,12 @@ 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, location_locale: Path):
|
async def test_i18n_in_all_locales(
|
||||||
assert (await i18n.in_all_locales(key, *args, locales_root=location_locale)) == expected
|
key: str, args: List[str], expected: Any, location_locale: Path
|
||||||
|
):
|
||||||
|
assert (
|
||||||
|
await i18n.in_all_locales(key, *args, locales_root=location_locale)
|
||||||
|
) == expected
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
@@ -53,5 +58,9 @@ async def test_i18n_in_all_locales(key: str, args: List[str], expected: Any, loc
|
|||||||
("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, location_locale: Path):
|
async def test_i18n_in_every_locale(
|
||||||
assert (await i18n.in_every_locale(key, *args, locales_root=location_locale)) == expected
|
key: str, args: List[str], expected: Any, location_locale: Path
|
||||||
|
):
|
||||||
|
assert (
|
||||||
|
await i18n.in_every_locale(key, *args, locales_root=location_locale)
|
||||||
|
) == expected
|
||||||
|
@@ -1,8 +1,9 @@
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any, List
|
from typing import Any, List, Union
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from libbot.i18n import _, in_all_locales, in_every_locale
|
|
||||||
|
from libbot.i18n import sync
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -19,14 +20,14 @@ from libbot.i18n import _, in_all_locales, in_every_locale
|
|||||||
def test_i18n_get(
|
def test_i18n_get(
|
||||||
key: str,
|
key: str,
|
||||||
args: List[str],
|
args: List[str],
|
||||||
locale: str | None,
|
locale: Union[str, None],
|
||||||
expected: Any,
|
expected: Any,
|
||||||
location_locale: Path,
|
location_locale: Path,
|
||||||
):
|
):
|
||||||
assert (
|
assert (
|
||||||
_(key, *args, locale=locale, locales_root=location_locale)
|
sync._(key, *args, locale=locale, locales_root=location_locale)
|
||||||
if locale is not None
|
if locale is not None
|
||||||
else _(key, *args, locales_root=location_locale)
|
else sync._(key, *args, locales_root=location_locale)
|
||||||
) == expected
|
) == expected
|
||||||
|
|
||||||
|
|
||||||
@@ -38,8 +39,10 @@ def test_i18n_get(
|
|||||||
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
("nested", ["callbacks", "default"], ["sure", "авжеж"]),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_i18n_in_all_locales(key: str, args: List[str], expected: Any, location_locale: Path):
|
def test_i18n_in_all_locales(
|
||||||
assert (in_all_locales(key, *args, locales_root=location_locale)) == expected
|
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(
|
@pytest.mark.parametrize(
|
||||||
@@ -50,5 +53,7 @@ def test_i18n_in_all_locales(key: str, args: List[str], expected: Any, location_
|
|||||||
("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, location_locale: Path):
|
def test_i18n_in_every_locale(
|
||||||
assert (in_every_locale(key, *args, locales_root=location_locale)) == expected
|
key: str, args: List[str], expected: Any, location_locale: Path
|
||||||
|
):
|
||||||
|
assert (sync.in_every_locale(key, *args, locales_root=location_locale)) == expected
|
||||||
|
@@ -4,10 +4,11 @@ except ImportError:
|
|||||||
from json import dumps, JSONDecodeError
|
from json import dumps, JSONDecodeError
|
||||||
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any, Union
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from libbot.utils import json_read, json_write
|
|
||||||
|
from libbot import json_read, json_write
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
@@ -24,7 +25,7 @@ from libbot.utils import json_read, json_write
|
|||||||
("tests/data/empty.json", {}),
|
("tests/data/empty.json", {}),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
async def test_json_read_valid(path: str | Path, expected: Any):
|
async def test_json_read_valid(path: Union[str, Path], expected: Any):
|
||||||
assert await json_read(path) == expected
|
assert await json_read(path) == expected
|
||||||
|
|
||||||
|
|
||||||
@@ -36,7 +37,7 @@ async def test_json_read_valid(path: str | Path, expected: Any):
|
|||||||
("tests/data/nonexistent.json", FileNotFoundError),
|
("tests/data/nonexistent.json", FileNotFoundError),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
async def test_json_read_invalid(path: str | Path, expected: Any):
|
async def test_json_read_invalid(path: Union[str, Path], expected: Any):
|
||||||
with pytest.raises(expected):
|
with pytest.raises(expected):
|
||||||
await json_read(path)
|
await json_read(path)
|
||||||
|
|
||||||
@@ -55,7 +56,7 @@ async def test_json_read_invalid(path: str | Path, expected: Any):
|
|||||||
({}, "tests/data/empty.json"),
|
({}, "tests/data/empty.json"),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
async def test_json_write(data: Any, path: str | Path):
|
async def test_json_write(data: Any, path: Union[str, Path]):
|
||||||
await json_write(data, path)
|
await json_write(data, path)
|
||||||
|
|
||||||
assert Path(path).is_file()
|
assert Path(path).is_file()
|
||||||
|
@@ -4,10 +4,11 @@ except ImportError:
|
|||||||
from json import dumps, JSONDecodeError
|
from json import dumps, JSONDecodeError
|
||||||
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any, Union
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from libbot.utils import json_read, json_write
|
|
||||||
|
from libbot import sync
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -23,8 +24,8 @@ from libbot.utils import json_read, json_write
|
|||||||
("tests/data/empty.json", {}),
|
("tests/data/empty.json", {}),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_json_read_valid(path: str | Path, expected: Any):
|
def test_json_read_valid(path: Union[str, Path], expected: Any):
|
||||||
assert json_read(path) == expected
|
assert sync.json_read(path) == expected
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -34,9 +35,9 @@ def test_json_read_valid(path: str | Path, expected: Any):
|
|||||||
("tests/data/nonexistent.json", FileNotFoundError),
|
("tests/data/nonexistent.json", FileNotFoundError),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_json_read_invalid(path: str | Path, expected: Any):
|
def test_json_read_invalid(path: Union[str, Path], expected: Any):
|
||||||
with pytest.raises(expected):
|
with pytest.raises(expected):
|
||||||
assert json_read(path) == expected
|
assert sync.json_read(path) == expected
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -52,8 +53,8 @@ def test_json_read_invalid(path: str | Path, expected: Any):
|
|||||||
({}, "tests/data/empty.json"),
|
({}, "tests/data/empty.json"),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_json_write(data: Any, path: str | Path):
|
def test_json_write(data: Any, path: Union[str, Path]):
|
||||||
json_write(data, path)
|
sync.json_write(data, path)
|
||||||
|
|
||||||
assert Path(path).is_file()
|
assert Path(path).is_file()
|
||||||
with open(path, "r", encoding="utf-8") as f:
|
with open(path, "r", encoding="utf-8") as f:
|
||||||
|
@@ -1,7 +1,8 @@
|
|||||||
from typing import Any, Dict, List
|
from typing import Any, Dict, List
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from libbot.utils.misc import nested_delete, nested_set
|
|
||||||
|
from libbot.sync._nested import nested_delete, nested_set
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -55,7 +56,9 @@ def test_nested_set_invalid(
|
|||||||
expected: Any,
|
expected: Any,
|
||||||
):
|
):
|
||||||
with pytest.raises(expected):
|
with pytest.raises(expected):
|
||||||
assert (nested_set(target, value, *path, create_missing=create_missing)) == expected
|
assert (
|
||||||
|
nested_set(target, value, *path, create_missing=create_missing)
|
||||||
|
) == expected
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
|
@@ -1,7 +1,8 @@
|
|||||||
from typing import Callable
|
from typing import Callable
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from libbot.utils.misc import supports_argument
|
|
||||||
|
from libbot._utils import supports_argument
|
||||||
|
|
||||||
|
|
||||||
def func1(foo: str, bar: str):
|
def func1(foo: str, bar: str):
|
||||||
|
8
tox.ini
8
tox.ini
@@ -1,13 +1,14 @@
|
|||||||
[tox]
|
[tox]
|
||||||
minversion = 3.11.0
|
minversion = 3.9.0
|
||||||
envlist = py311, py312, py313
|
envlist = py39, py310, py311, py312
|
||||||
isolated_build = true
|
isolated_build = true
|
||||||
|
|
||||||
[gh-actions]
|
[gh-actions]
|
||||||
python =
|
python =
|
||||||
|
3.9: py39
|
||||||
|
3.10: py310
|
||||||
3.11: py311
|
3.11: py311
|
||||||
3.12: py312
|
3.12: py312
|
||||||
3.13: py313
|
|
||||||
|
|
||||||
[testenv]
|
[testenv]
|
||||||
setenv =
|
setenv =
|
||||||
@@ -18,6 +19,5 @@ deps =
|
|||||||
-r{toxinidir}/requirements/pycord.txt
|
-r{toxinidir}/requirements/pycord.txt
|
||||||
-r{toxinidir}/requirements/pyrogram.txt
|
-r{toxinidir}/requirements/pyrogram.txt
|
||||||
-r{toxinidir}/requirements/speed.txt
|
-r{toxinidir}/requirements/speed.txt
|
||||||
-r{toxinidir}/requirements/cache.txt
|
|
||||||
commands =
|
commands =
|
||||||
pytest --basetemp={envtmpdir} --cov=libbot
|
pytest --basetemp={envtmpdir} --cov=libbot
|
Reference in New Issue
Block a user