Compare commits
37 Commits
Author | SHA1 | Date | |
---|---|---|---|
171e36a491 | |||
8f89d93fdc | |||
8dc389d1b3 | |||
70b5994ecb | |||
ea45ccbad6 | |||
7d287ec46c | |||
d317443960 | |||
4daf6a5a5e | |||
b81700da77 | |||
910efda16c | |||
c91591468b | |||
dad6717706 | |||
263522690f | |||
1bd4b6afe9 | |||
c419c684aa | |||
bd3fbd7c2c | |||
64ba9efa34 | |||
748b2b2abb | |||
15f9274050 | |||
6d3c20479d | |||
52c2e5cc13 | |||
dfaadfd769 | |||
66ede3d60f | |||
3c3de1436e | |||
cfeadfdd32 | |||
7032bef956 | |||
ce691b2eda | |||
a383959c9f | |||
55c61e3fce | |||
7068e7f194 | |||
5b16419f20 | |||
2ed348933b | |||
c3d3e43216 | |||
1f464ef624 | |||
10c7ecbfd0 | |||
e8769e8aeb | |||
f101105d41 |
@ -27,6 +27,12 @@ jobs:
|
|||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: |
|
||||||
python -m pip install --upgrade pip
|
python -m pip install --upgrade pip
|
||||||
pip install tox tox-gh-actions
|
pip install tox tox-gh-actions build
|
||||||
- name: Test with tox
|
- name: Test with tox
|
||||||
run: tox
|
run: tox
|
||||||
|
- name: Build
|
||||||
|
run: python -m build
|
||||||
|
- uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: Artifacts
|
||||||
|
path: dist/*
|
||||||
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -166,3 +166,5 @@ venv_linux/
|
|||||||
venv_windows/
|
venv_windows/
|
||||||
|
|
||||||
.vscode/
|
.vscode/
|
||||||
|
|
||||||
|
tests/.tmp/
|
86
README.md
86
README.md
@ -1,2 +1,86 @@
|
|||||||
# LibBotUniversal
|
<h1 align="center">LibBotUniversal</h1>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://git.end-play.xyz/profitroll/LibBotUniversal/src/branch/master/LICENSE"><img alt="PyPI - License" src="https://img.shields.io/pypi/l/libbot">
|
||||||
|
<a href="https://git.end-play.xyz/profitroll/LibBotUniversal/releases/latest"><img alt="Gitea Release" src="https://img.shields.io/gitea/v/release/profitroll/LibBotUniversal?gitea_url=https%3A%2F%2Fgit.end-play.xyz"></a>
|
||||||
|
<a href="https://pypi.org/project/libbot/"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/libbot"></a>
|
||||||
|
<a href="https://git.end-play.xyz/profitroll/LibBotUniversal"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
Handy library for Telegram/Discord bots development.
|
||||||
|
|
||||||
|
## Getting started
|
||||||
|
|
||||||
|
There are different sub-packages available:
|
||||||
|
|
||||||
|
* pyrogram - Telegram bots with Pyrogram's fork "Pyrofork"
|
||||||
|
* pycord - Discord bots with Pycord
|
||||||
|
* speed - Performance improvements
|
||||||
|
* 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.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# Only general features
|
||||||
|
pip install libbot
|
||||||
|
|
||||||
|
# Only with Pyrogram
|
||||||
|
pip install libbot[pyrogram]
|
||||||
|
|
||||||
|
# With Pycord and Performance improvements
|
||||||
|
pip install libbot[pycord,speed]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Pyrogram
|
||||||
|
|
||||||
|
```python
|
||||||
|
from libbot.pyrogram import PyroClient
|
||||||
|
|
||||||
|
def main():
|
||||||
|
client = PyroClient(scheduler=scheduler)
|
||||||
|
|
||||||
|
try:
|
||||||
|
client.run()
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
print("Shutting down...")
|
||||||
|
finally:
|
||||||
|
if client.scheduler is not None:
|
||||||
|
client.scheduler.shutdown()
|
||||||
|
exit()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pycord
|
||||||
|
|
||||||
|
```python
|
||||||
|
from discord import Intents
|
||||||
|
from libbot import sync
|
||||||
|
from libbot.pycord import PycordBot
|
||||||
|
|
||||||
|
|
||||||
|
async def main():
|
||||||
|
intents = Intents.default()
|
||||||
|
bot = PycordBot(intents=intents)
|
||||||
|
|
||||||
|
bot.load_extension("cogs")
|
||||||
|
|
||||||
|
try:
|
||||||
|
await bot.start(sync.config_get("bot_token", "bot"))
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
logger.warning("Shutting down...")
|
||||||
|
await bot.close()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
loop = asyncio.get_event_loop()
|
||||||
|
loop.run_until_complete(main())
|
||||||
|
```
|
||||||
|
|
||||||
|
## Config examples
|
||||||
|
|
||||||
|
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.
|
||||||
|
13
examples/config_pycord.json
Normal file
13
examples/config_pycord.json
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"locale": "en",
|
||||||
|
"debug": false,
|
||||||
|
"bot": {
|
||||||
|
"owners": [
|
||||||
|
0
|
||||||
|
],
|
||||||
|
"debug_guilds": [
|
||||||
|
0
|
||||||
|
],
|
||||||
|
"bot_token": ""
|
||||||
|
}
|
||||||
|
}
|
@ -9,11 +9,11 @@ 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.8"
|
requires-python = ">=3.8"
|
||||||
license = { file = "LICENSE" }
|
license = { text = "GPLv3" }
|
||||||
classifiers = [
|
classifiers = [
|
||||||
"Development Status :: 3 - Alpha",
|
"Development Status :: 3 - Alpha",
|
||||||
"Intended Audience :: Developers",
|
"Intended Audience :: Developers",
|
||||||
"License :: OSI Approved :: MIT License",
|
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
|
||||||
"Operating System :: OS Independent",
|
"Operating System :: OS Independent",
|
||||||
"Programming Language :: Python :: 3.8",
|
"Programming Language :: Python :: 3.8",
|
||||||
"Programming Language :: Python :: 3.9",
|
"Programming Language :: Python :: 3.9",
|
||||||
|
@ -1,11 +1,11 @@
|
|||||||
black==24.4.2
|
black==24.4.2
|
||||||
build==1.2.1
|
build==1.2.1
|
||||||
isort==5.13.2
|
isort==5.13.2
|
||||||
mypy==1.10.0
|
mypy==1.10.1
|
||||||
pylint==3.2.0
|
pylint==3.2.5
|
||||||
pytest-asyncio==0.23.6
|
pytest-asyncio==0.23.7
|
||||||
pytest-cov==5.0.0
|
pytest-cov==5.0.0
|
||||||
pytest==8.2.0
|
pytest==8.2.2
|
||||||
tox==4.15.0
|
tox==4.16.0
|
||||||
types-aiofiles==23.2.0.20240403
|
types-aiofiles==24.1.0.20240626
|
||||||
types-ujson==5.9.0.0
|
types-ujson==5.10.0.20240515
|
@ -1,2 +1,2 @@
|
|||||||
apscheduler~=3.10.4
|
apscheduler~=3.10.4
|
||||||
py-cord~=2.5.0
|
py-cord~=2.6.0
|
@ -1,2 +1,2 @@
|
|||||||
apscheduler~=3.10.4
|
apscheduler~=3.10.4
|
||||||
pyrofork~=2.3.21.post3
|
pyrofork~=2.3.32
|
@ -1,6 +1,6 @@
|
|||||||
__version__ = "3.0.1"
|
__version__ = "3.2.3"
|
||||||
__license__ = "GPL3"
|
__license__ = "GPL3"
|
||||||
__author__ = "Profitroll"
|
__author__ = "Profitroll"
|
||||||
|
|
||||||
from . import i18n, pycord, pyrogram, sync
|
from . import errors, i18n, pycord, pyrogram, sync
|
||||||
from .__main__ import *
|
from .__main__ import config_delete, config_get, config_set, json_read, json_write
|
||||||
|
@ -8,7 +8,8 @@ try:
|
|||||||
except ImportError:
|
except ImportError:
|
||||||
from json import dumps, loads
|
from json import dumps, loads
|
||||||
|
|
||||||
from libbot.sync import nested_set
|
from ._utils import supports_argument
|
||||||
|
from .sync._nested import nested_delete, nested_set
|
||||||
|
|
||||||
|
|
||||||
async def json_read(path: Union[str, Path]) -> Any:
|
async def json_read(path: Union[str, Path]) -> Any:
|
||||||
@ -22,6 +23,7 @@ async def json_read(path: Union[str, Path]) -> Any:
|
|||||||
"""
|
"""
|
||||||
async with aiofiles.open(str(path), mode="r", encoding="utf-8") as f:
|
async with aiofiles.open(str(path), mode="r", encoding="utf-8") as f:
|
||||||
data = await f.read()
|
data = await f.read()
|
||||||
|
|
||||||
return loads(data)
|
return loads(data)
|
||||||
|
|
||||||
|
|
||||||
@ -35,7 +37,7 @@ async def json_write(data: Any, path: Union[str, Path]) -> None:
|
|||||||
async with aiofiles.open(str(path), mode="w", encoding="utf-8") as f:
|
async with aiofiles.open(str(path), mode="w", encoding="utf-8") as f:
|
||||||
await f.write(
|
await f.write(
|
||||||
dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
|
dumps(data, ensure_ascii=False, escape_forward_slashes=False, indent=4)
|
||||||
if hasattr(dumps, "escape_forward_slashes")
|
if supports_argument(dumps, "escape_forward_slashes")
|
||||||
else dumps(data, ensure_ascii=False, indent=4)
|
else dumps(data, ensure_ascii=False, indent=4)
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -73,8 +75,10 @@ async def config_get(
|
|||||||
```
|
```
|
||||||
"""
|
"""
|
||||||
this_key = await json_read(config_file)
|
this_key = await json_read(config_file)
|
||||||
|
|
||||||
for dict_key in path:
|
for dict_key in path:
|
||||||
this_key = this_key[dict_key]
|
this_key = this_key[dict_key]
|
||||||
|
|
||||||
return this_key[key]
|
return this_key[key]
|
||||||
|
|
||||||
|
|
||||||
@ -88,8 +92,39 @@ async def config_set(
|
|||||||
* value (`Any`): Any JSON serializable data
|
* value (`Any`): Any JSON serializable data
|
||||||
* *path (`str`): Path to the key of the target
|
* *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"`
|
* 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(
|
await json_write(
|
||||||
nested_set(await json_read(config_file), value, *(*path, key)), config_file
|
nested_set(await json_read(config_file), value, *(*path, key)), config_file
|
||||||
)
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
|
|
||||||
|
async def config_delete(
|
||||||
|
key: str,
|
||||||
|
*path: str,
|
||||||
|
missing_ok: bool = False,
|
||||||
|
config_file: Union[str, Path] = "config.json",
|
||||||
|
) -> 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
|
1
src/libbot/errors/__init__.py
Normal file
1
src/libbot/errors/__init__.py
Normal file
@ -0,0 +1 @@
|
|||||||
|
from .config import ConfigKeyError, ConfigValueError
|
37
src/libbot/errors/config.py
Normal file
37
src/libbot/errors/config.py
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
from typing import Any, List, Optional, Union
|
||||||
|
|
||||||
|
|
||||||
|
class ConfigKeyError(Exception):
|
||||||
|
"""Raised when config key is not found.
|
||||||
|
|
||||||
|
### Attributes:
|
||||||
|
* key (`Union[str, List[str]]`): Missing config key.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, key: Union[str, List[str]]) -> None:
|
||||||
|
self.key: Union[str, List[str]] = key
|
||||||
|
super().__init__(
|
||||||
|
f"Config key {'.'.join(key) if isinstance(key, list) else key} is missing. Please set in your config file."
|
||||||
|
)
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return f"Config key {'.'.join(self.key) if isinstance(self.key, list) else self.key} is missing. Please set in your config file."
|
||||||
|
|
||||||
|
|
||||||
|
class ConfigValueError(Exception):
|
||||||
|
"""Raised when config key's value is invalid.
|
||||||
|
|
||||||
|
### Attributes:
|
||||||
|
* key (`Union[str, List[str]]`): Invalid config key.
|
||||||
|
* value (`Optional[Any]`): Key's correct value.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, key: Union[str, List[str]], value: Optional[Any] = None) -> None:
|
||||||
|
self.key: Union[str, List[str]] = key
|
||||||
|
self.value: Optional[Any] = value
|
||||||
|
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."
|
||||||
|
)
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return f"Config key {'.'.join(self.key) if isinstance(self.key, list) else self.key} has invalid value. {f'Must be {self.value}. ' if self.value else ''}Please set in your config file."
|
@ -1,6 +1,6 @@
|
|||||||
import logging
|
import logging
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any, Dict, Union
|
from typing import Any, Dict, List, Union
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||||
@ -29,6 +29,7 @@ class PycordBot(Bot):
|
|||||||
config_path: Union[str, Path] = Path("config.json"),
|
config_path: Union[str, Path] = Path("config.json"),
|
||||||
locales_root: Union[str, Path, None] = None,
|
locales_root: Union[str, Path, None] = None,
|
||||||
scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
|
scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
|
||||||
|
*args,
|
||||||
**kwargs,
|
**kwargs,
|
||||||
):
|
):
|
||||||
if config is None:
|
if config is None:
|
||||||
@ -38,8 +39,11 @@ class PycordBot(Bot):
|
|||||||
self.config = config
|
self.config = config
|
||||||
|
|
||||||
super().__init__(
|
super().__init__(
|
||||||
debug_guilds=self.config["bot"]["debug_guilds"],
|
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,
|
||||||
**kwargs,
|
**kwargs,
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -48,7 +52,7 @@ class PycordBot(Bot):
|
|||||||
locales_root=(Path("locale") if locales_root is None else locales_root),
|
locales_root=(Path("locale") if locales_root is None else locales_root),
|
||||||
)
|
)
|
||||||
self.default_locale: str = self.bot_locale.default
|
self.default_locale: str = self.bot_locale.default
|
||||||
self.locales: dict = self.bot_locale.locales
|
self.locales: Dict[str, Any] = self.bot_locale.locales
|
||||||
|
|
||||||
self._ = self.bot_locale._
|
self._ = self.bot_locale._
|
||||||
self.in_all_locales = self.bot_locale.in_all_locales
|
self.in_all_locales = self.bot_locale.in_all_locales
|
||||||
|
@ -1,116 +1 @@
|
|||||||
from pathlib import Path
|
from .__main__ import config_delete, config_get, config_set, json_read, json_write
|
||||||
from typing import Any, Union
|
|
||||||
|
|
||||||
try:
|
|
||||||
from ujson import dumps, loads
|
|
||||||
except ImportError:
|
|
||||||
from json import dumps, loads
|
|
||||||
|
|
||||||
|
|
||||||
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 hasattr(dumps, "escape_forward_slashes")
|
|
||||||
else dumps(data, ensure_ascii=False, indent=4)
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def nested_set(target: dict, value: Any, *path: str, create_missing=True) -> dict:
|
|
||||||
"""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`
|
|
||||||
|
|
||||||
### Returns:
|
|
||||||
* `dict`: 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 config_get(
|
|
||||||
key: str, *path: str, config_file: Union[str, Path] = "config.json"
|
|
||||||
) -> 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] = "config.json"
|
|
||||||
) -> 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"`
|
|
||||||
"""
|
|
||||||
json_write(nested_set(json_read(config_file), value, *(*path, key)), config_file)
|
|
||||||
return
|
|
||||||
|
126
src/libbot/sync/__main__.py
Normal file
126
src/libbot/sync/__main__.py
Normal file
@ -0,0 +1,126 @@
|
|||||||
|
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
|
||||||
|
|
||||||
|
|
||||||
|
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] = "config.json"
|
||||||
|
) -> 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] = "config.json"
|
||||||
|
) -> 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)
|
||||||
|
return
|
||||||
|
|
||||||
|
|
||||||
|
def config_delete(
|
||||||
|
key: str,
|
||||||
|
*path: str,
|
||||||
|
missing_ok: bool = False,
|
||||||
|
config_file: Union[str, Path] = "config.json",
|
||||||
|
) -> 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,4 +1,7 @@
|
|||||||
|
from json import dumps, loads
|
||||||
|
from os import makedirs
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
from uuid import uuid4
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
@ -7,7 +10,22 @@ from libbot.i18n import BotLocale
|
|||||||
|
|
||||||
@pytest.fixture()
|
@pytest.fixture()
|
||||||
def location_config() -> Path:
|
def location_config() -> Path:
|
||||||
return Path("tests/config.json")
|
makedirs(Path("tests/.tmp"), exist_ok=True)
|
||||||
|
|
||||||
|
filename = str(uuid4())
|
||||||
|
|
||||||
|
with open(Path("tests/config.json"), "r", encoding="utf-8") as file:
|
||||||
|
config = loads(file.read())
|
||||||
|
|
||||||
|
with open(Path(f"tests/.tmp/{filename}.json"), "w", encoding="utf-8") as file:
|
||||||
|
file.write(
|
||||||
|
dumps(
|
||||||
|
config,
|
||||||
|
ensure_ascii=False,
|
||||||
|
indent=4,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return Path(f"tests/.tmp/{filename}.json")
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
@pytest.fixture()
|
||||||
|
@ -3,7 +3,7 @@ from typing import Any, List
|
|||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from libbot import config_get, config_set
|
from libbot import config_delete, config_get, config_set
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
@ -46,3 +46,29 @@ async def test_config_get_invalid(
|
|||||||
async def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
|
async def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
|
||||||
await config_set(key, value, *path, config_file=location_config)
|
await config_set(key, value, *path, config_file=location_config)
|
||||||
assert await config_get(key, *path, config_file=location_config) == value
|
assert await config_get(key, *path, config_file=location_config) == value
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"key, path",
|
||||||
|
[
|
||||||
|
("bot_token", ["bot"]),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
async def test_config_delete(key: str, path: List[str], location_config: Path):
|
||||||
|
await config_delete(key, *path, config_file=location_config)
|
||||||
|
assert key not in (await config_get(*path, config_file=location_config))
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"key, path",
|
||||||
|
[
|
||||||
|
("bot_lol", ["bot"]),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
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
|
||||||
|
)
|
||||||
|
@ -40,3 +40,27 @@ 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):
|
||||||
sync.config_set(key, value, *path, config_file=location_config)
|
sync.config_set(key, value, *path, config_file=location_config)
|
||||||
assert sync.config_get(key, *path, config_file=location_config) == value
|
assert sync.config_get(key, *path, config_file=location_config) == value
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"key, path",
|
||||||
|
[
|
||||||
|
("bot_token", ["bot"]),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_config_delete(key: str, path: List[str], location_config: Path):
|
||||||
|
sync.config_delete(key, *path, config_file=location_config)
|
||||||
|
assert key not in sync.config_get(*path, config_file=location_config)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"key, path",
|
||||||
|
[
|
||||||
|
("bot_lol", ["bot"]),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
async def test_config_delete_missing(key: str, path: List[str], location_config: Path):
|
||||||
|
assert (
|
||||||
|
sync.config_delete(key, *path, missing_ok=True, config_file=location_config)
|
||||||
|
is None
|
||||||
|
)
|
||||||
|
@ -2,7 +2,7 @@ from typing import Any, Dict, List
|
|||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from libbot import sync
|
from libbot.sync._nested import nested_delete, nested_set
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@ -33,9 +33,7 @@ def test_nested_set_valid(
|
|||||||
create_missing: bool,
|
create_missing: bool,
|
||||||
expected: Any,
|
expected: Any,
|
||||||
):
|
):
|
||||||
assert (
|
assert (nested_set(target, value, *path, create_missing=create_missing)) == expected
|
||||||
sync.nested_set(target, value, *path, create_missing=create_missing)
|
|
||||||
) == expected
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@ -59,5 +57,25 @@ def test_nested_set_invalid(
|
|||||||
):
|
):
|
||||||
with pytest.raises(expected):
|
with pytest.raises(expected):
|
||||||
assert (
|
assert (
|
||||||
sync.nested_set(target, value, *path, create_missing=create_missing)
|
nested_set(target, value, *path, create_missing=create_missing)
|
||||||
) == expected
|
) == expected
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"target, path, expected",
|
||||||
|
[
|
||||||
|
({"foo": "bar"}, ["foo"], {}),
|
||||||
|
({"foo": "bar", "bar": "foo"}, ["bar"], {"foo": "bar"}),
|
||||||
|
(
|
||||||
|
{"foo": {"bar": {}}},
|
||||||
|
["foo", "bar"],
|
||||||
|
{"foo": {}},
|
||||||
|
),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_nested_delete(
|
||||||
|
target: Dict[str, Any],
|
||||||
|
path: List[str],
|
||||||
|
expected: Any,
|
||||||
|
):
|
||||||
|
assert (nested_delete(target, *path)) == expected
|
||||||
|
24
tests/test_utils.py
Normal file
24
tests/test_utils.py
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
from typing import Callable
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from libbot._utils import supports_argument
|
||||||
|
|
||||||
|
|
||||||
|
def func1(foo: str, bar: str):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def func2(foo: str):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"func, arg_name, result",
|
||||||
|
[
|
||||||
|
(func1, "foo", True),
|
||||||
|
(func2, "bar", False),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_supports_argument(func: Callable, arg_name: str, result: bool):
|
||||||
|
assert supports_argument(func, arg_name) == result
|
Loading…
Reference in New Issue
Block a user