Compare commits
4 Commits
a47a508ecf
...
v3.1.0
Author | SHA1 | Date | |
---|---|---|---|
55c61e3fce | |||
b9550032ba | |||
5ba763246b | |||
f0ffdf096d |
@@ -1,24 +0,0 @@
|
||||
name: Analysis
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- dev
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened]
|
||||
|
||||
jobs:
|
||||
sonarcloud:
|
||||
name: SonarCloud
|
||||
runs-on: ubuntu-latest
|
||||
container: catthehacker/ubuntu:act-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: SonarCloud Scan
|
||||
uses: SonarSource/sonarcloud-github-action@master
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
@@ -10,12 +10,11 @@ on:
|
||||
|
||||
jobs:
|
||||
test:
|
||||
name: Build and Test
|
||||
runs-on: ubuntu-latest
|
||||
container: catthehacker/ubuntu:act-latest
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: ["3.9", "3.10", "3.11", "3.12"]
|
||||
python-version: ["3.8", "3.9", "3.10", "3.11"]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
@@ -28,12 +27,6 @@ jobs:
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install tox tox-gh-actions build
|
||||
pip install tox tox-gh-actions
|
||||
- name: Test with 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,5 +166,3 @@ venv_linux/
|
||||
venv_windows/
|
||||
|
||||
.vscode/
|
||||
|
||||
tests/.tmp/
|
@@ -8,17 +8,17 @@ dynamic = ["version", "dependencies", "optional-dependencies"]
|
||||
authors = [{ name = "Profitroll" }]
|
||||
description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.9"
|
||||
requires-python = ">=3.8"
|
||||
license = { text = "GPLv3" }
|
||||
classifiers = [
|
||||
"Development Status :: 3 - Alpha",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
|
||||
"Operating System :: OS Independent",
|
||||
"Programming Language :: Python :: 3.8",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||
"Topic :: Utilities",
|
||||
]
|
||||
@@ -42,7 +42,7 @@ Tracker = "https://git.end-play.xyz/profitroll/LibBotUniversal/issues"
|
||||
where = ["src"]
|
||||
|
||||
[tool.black]
|
||||
target-version = ['py39', 'py310', 'py311' ,'py312']
|
||||
target-version = ['py38', 'py39', 'py310', 'py311']
|
||||
|
||||
[tool.isort]
|
||||
profile = "black"
|
||||
@@ -61,7 +61,7 @@ show_error_codes = true
|
||||
|
||||
[tool.pylint.main]
|
||||
extension-pkg-whitelist = ["ujson"]
|
||||
py-version = 3.9
|
||||
py-version = 3.8
|
||||
|
||||
[tool.coverage.run]
|
||||
source = ["libbot"]
|
||||
|
@@ -1,11 +1,11 @@
|
||||
black==24.10.0
|
||||
build==1.2.2.post1
|
||||
black==24.4.2
|
||||
build==1.2.1
|
||||
isort==5.13.2
|
||||
mypy==1.14.0
|
||||
pylint==3.3.3
|
||||
pytest-asyncio==0.25.0
|
||||
pytest-cov==6.0.0
|
||||
pytest==8.3.4
|
||||
tox==4.23.2
|
||||
types-aiofiles==24.1.0.20241221
|
||||
mypy==1.10.0
|
||||
pylint==3.2.1
|
||||
pytest-asyncio==0.23.7
|
||||
pytest-cov==5.0.0
|
||||
pytest==8.2.0
|
||||
tox==4.15.0
|
||||
types-aiofiles==23.2.0.20240403
|
||||
types-ujson==5.10.0.20240515
|
@@ -1,2 +1,2 @@
|
||||
apscheduler~=3.11.0
|
||||
py-cord~=2.6.0
|
||||
apscheduler~=3.10.4
|
||||
py-cord~=2.5.0
|
@@ -1,2 +1,2 @@
|
||||
apscheduler~=3.11.0
|
||||
pyrofork~=2.3.32
|
||||
apscheduler~=3.10.4
|
||||
pyrofork~=2.3.21.post3
|
@@ -1,2 +0,0 @@
|
||||
sonar.projectKey=profitroll_libbot
|
||||
sonar.organization=profitroll
|
@@ -1,6 +1,6 @@
|
||||
__version__ = "3.3.1"
|
||||
__version__ = "3.1.0"
|
||||
__license__ = "GPL3"
|
||||
__author__ = "Profitroll"
|
||||
|
||||
from . import errors, i18n, pycord, pyrogram, sync
|
||||
from .__main__ import config_delete, config_get, config_set, json_read, json_write
|
||||
from .__main__ import *
|
||||
|
@@ -8,10 +8,7 @@ try:
|
||||
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"
|
||||
from libbot.sync import nested_set
|
||||
|
||||
|
||||
async def json_read(path: Union[str, Path]) -> Any:
|
||||
@@ -25,7 +22,6 @@ async def json_read(path: Union[str, Path]) -> Any:
|
||||
"""
|
||||
async with aiofiles.open(str(path), mode="r", encoding="utf-8") as f:
|
||||
data = await f.read()
|
||||
|
||||
return loads(data)
|
||||
|
||||
|
||||
@@ -39,13 +35,13 @@ async def json_write(data: Any, path: Union[str, Path]) -> None:
|
||||
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")
|
||||
if hasattr(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
|
||||
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"`
|
||||
@@ -77,15 +73,13 @@ async def config_get(
|
||||
```
|
||||
"""
|
||||
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
|
||||
key: str, value: Any, *path: str, config_file: Union[str, Path] = "config.json"
|
||||
) -> None:
|
||||
"""Set config's key by its path to the value
|
||||
|
||||
@@ -94,38 +88,8 @@ async def config_set(
|
||||
* 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)
|
||||
return
|
||||
|
@@ -1,22 +0,0 @@
|
||||
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
|
@@ -59,15 +59,3 @@ class PycordBot(Bot):
|
||||
self.in_every_locale = self.bot_locale.in_every_locale
|
||||
|
||||
self.scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = scheduler
|
||||
|
||||
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)
|
||||
|
||||
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()
|
||||
|
@@ -125,7 +125,7 @@ class PyroClient(Client):
|
||||
|
||||
self.i18n_bot_info: bool = i18n_bot_info
|
||||
|
||||
async def start(self, register_commands: bool = True, scheduler_start: bool = True) -> None:
|
||||
async def start(self, register_commands: bool = True) -> None:
|
||||
await super().start()
|
||||
|
||||
self.start_time = time()
|
||||
@@ -209,12 +209,9 @@ class PyroClient(Client):
|
||||
kwargs={"command_sets": await self.collect_commands()},
|
||||
)
|
||||
|
||||
if scheduler_start:
|
||||
self.scheduler.start()
|
||||
|
||||
async def stop(
|
||||
self, exit_completely: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
|
||||
) -> None:
|
||||
async def stop(self, exit_completely: bool = True) -> None:
|
||||
try:
|
||||
await self.send_message(
|
||||
chat_id=self.owner
|
||||
@@ -226,9 +223,6 @@ class PyroClient(Client):
|
||||
except BadRequest:
|
||||
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()
|
||||
logger.warning("Bot stopped with PID %s.", getpid())
|
||||
|
||||
@@ -364,8 +358,7 @@ class PyroClient(Client):
|
||||
]
|
||||
|
||||
logger.info(
|
||||
"Registering commands %s with a default scope 'BotCommandScopeDefault'",
|
||||
commands
|
||||
"Registering commands %s with a default scope 'BotCommandScopeDefault'"
|
||||
)
|
||||
|
||||
await self.set_bot_commands(commands)
|
||||
|
@@ -1 +1,116 @@
|
||||
from .__main__ import config_delete, config_get, config_set, json_read, json_write
|
||||
from pathlib import Path
|
||||
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
|
||||
|
@@ -1,127 +0,0 @@
|
||||
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)
|
@@ -1,64 +0,0 @@
|
||||
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,7 +1,4 @@
|
||||
from json import dumps, loads
|
||||
from os import makedirs
|
||||
from pathlib import Path
|
||||
from uuid import uuid4
|
||||
|
||||
import pytest
|
||||
|
||||
@@ -10,22 +7,7 @@ from libbot.i18n import BotLocale
|
||||
|
||||
@pytest.fixture()
|
||||
def location_config() -> Path:
|
||||
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")
|
||||
return Path("tests/config.json")
|
||||
|
||||
|
||||
@pytest.fixture()
|
||||
|
@@ -3,7 +3,7 @@ from typing import Any, List
|
||||
|
||||
import pytest
|
||||
|
||||
from libbot import config_delete, config_get, config_set
|
||||
from libbot import config_get, config_set
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@@ -46,29 +46,3 @@ async def test_config_get_invalid(
|
||||
async def test_config_set(key: str, path: List[str], value: Any, location_config: Path):
|
||||
await config_set(key, value, *path, config_file=location_config)
|
||||
assert await config_get(key, *path, config_file=location_config) == value
|
||||
|
||||
|
||||
@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,27 +40,3 @@ 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):
|
||||
sync.config_set(key, value, *path, config_file=location_config)
|
||||
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"]),
|
||||
],
|
||||
)
|
||||
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
|
||||
|
||||
from libbot.sync._nested import nested_delete, nested_set
|
||||
from libbot import sync
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -33,7 +33,9 @@ def test_nested_set_valid(
|
||||
create_missing: bool,
|
||||
expected: Any,
|
||||
):
|
||||
assert (nested_set(target, value, *path, create_missing=create_missing)) == expected
|
||||
assert (
|
||||
sync.nested_set(target, value, *path, create_missing=create_missing)
|
||||
) == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
@@ -57,25 +59,5 @@ def test_nested_set_invalid(
|
||||
):
|
||||
with pytest.raises(expected):
|
||||
assert (
|
||||
nested_set(target, value, *path, create_missing=create_missing)
|
||||
sync.nested_set(target, value, *path, create_missing=create_missing)
|
||||
) == 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
|
||||
|
@@ -1,26 +0,0 @@
|
||||
from typing import Callable
|
||||
|
||||
import pytest
|
||||
|
||||
from libbot._utils import supports_argument
|
||||
|
||||
|
||||
def func1(foo: str, bar: str):
|
||||
"""Dummy function with specific arguments"""
|
||||
pass
|
||||
|
||||
|
||||
def func2(foo: str):
|
||||
"""Dummy function with specific arguments"""
|
||||
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
|
Reference in New Issue
Block a user