Compare commits
No commits in common. "main" and "v3.2.0" have entirely different histories.
@ -1,11 +1,11 @@
|
||||
black==24.4.2
|
||||
build==1.2.1
|
||||
isort==5.13.2
|
||||
mypy==1.10.1
|
||||
pylint==3.2.5
|
||||
mypy==1.10.0
|
||||
pylint==3.2.2
|
||||
pytest-asyncio==0.23.7
|
||||
pytest-cov==5.0.0
|
||||
pytest==8.2.2
|
||||
tox==4.16.0
|
||||
types-aiofiles==24.1.0.20240626
|
||||
pytest==8.2.1
|
||||
tox==4.15.0
|
||||
types-aiofiles==23.2.0.20240403
|
||||
types-ujson==5.10.0.20240515
|
@ -1,2 +1,2 @@
|
||||
apscheduler~=3.10.4
|
||||
py-cord~=2.6.0
|
||||
py-cord~=2.5.0
|
@ -1,2 +1,2 @@
|
||||
apscheduler~=3.10.4
|
||||
pyrofork~=2.3.32
|
||||
pyrofork~=2.3.21.post3
|
@ -1,4 +1,4 @@
|
||||
__version__ = "3.2.3"
|
||||
__version__ = "3.2.0"
|
||||
__license__ = "GPL3"
|
||||
__author__ = "Profitroll"
|
||||
|
||||
|
@ -8,7 +8,6 @@ try:
|
||||
except ImportError:
|
||||
from json import dumps, loads
|
||||
|
||||
from ._utils import supports_argument
|
||||
from .sync._nested import nested_delete, nested_set
|
||||
|
||||
|
||||
@ -37,7 +36,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:
|
||||
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)
|
||||
)
|
||||
|
||||
@ -103,28 +102,20 @@ async def config_set(
|
||||
|
||||
|
||||
async def config_delete(
|
||||
key: str,
|
||||
*path: str,
|
||||
missing_ok: bool = False,
|
||||
config_file: Union[str, Path] = "config.json",
|
||||
key: str, *path: str, 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`
|
||||
* `KeyError`: Key is not found under path provided
|
||||
"""
|
||||
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
|
||||
nested_delete(config_data, *(*path, key))
|
||||
|
||||
await json_write(config_data, config_file)
|
||||
|
@ -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
|
@ -1,7 +1,6 @@
|
||||
from pathlib import Path
|
||||
from typing import Any, Union
|
||||
|
||||
from .._utils import supports_argument
|
||||
from ._nested import nested_delete, nested_set
|
||||
|
||||
try:
|
||||
@ -35,7 +34,7 @@ def json_write(data: Any, path: Union[str, Path]) -> None:
|
||||
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")
|
||||
if hasattr(dumps, "escape_forward_slashes")
|
||||
else dumps(data, ensure_ascii=False, indent=4)
|
||||
)
|
||||
|
||||
@ -99,28 +98,20 @@ def config_set(
|
||||
|
||||
|
||||
def config_delete(
|
||||
key: str,
|
||||
*path: str,
|
||||
missing_ok: bool = False,
|
||||
config_file: Union[str, Path] = "config.json",
|
||||
key: str, *path: str, 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`
|
||||
* `KeyError`: Key is not found under path provided
|
||||
"""
|
||||
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
|
||||
nested_delete(config_data, *(*path, key))
|
||||
|
||||
json_write(config_data, config_file)
|
||||
|
@ -3,7 +3,7 @@ from typing import Any, List
|
||||
|
||||
import pytest
|
||||
|
||||
from libbot import config_delete, config_get, config_set
|
||||
from libbot import config_delete, config_get, config_set, sync
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@ -58,17 +58,3 @@ async def test_config_set(key: str, path: List[str], value: Any, location_config
|
||||
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
|
||||
)
|
||||
|
@ -51,16 +51,3 @@ 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):
|
||||
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
|
||||
)
|
||||
|
@ -1,24 +0,0 @@
|
||||
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