Merge pull request 'v3.3.0' (#159) from dev into main
All checks were successful
Analysis / SonarCloud (push) Successful in 43s
Tests / Build and Test (3.10) (push) Successful in 1m2s
Tests / Build and Test (3.11) (push) Successful in 1m2s
Tests / Build and Test (3.12) (push) Successful in 1m8s
Tests / Build and Test (3.9) (push) Successful in 1m4s

Reviewed-on: #159
This commit is contained in:
Profitroll 2024-12-16 23:48:07 +02:00
commit 1b60257bc5
14 changed files with 62 additions and 30 deletions

View File

@ -0,0 +1,24 @@
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 }}

View File

@ -10,11 +10,12 @@ on:
jobs: jobs:
test: test:
name: Build and Test
runs-on: ubuntu-latest runs-on: ubuntu-latest
container: catthehacker/ubuntu:act-latest container: catthehacker/ubuntu:act-latest
strategy: strategy:
matrix: matrix:
python-version: ["3.8", "3.9", "3.10", "3.11"] python-version: ["3.9", "3.10", "3.11", "3.12"]
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3

View File

@ -8,17 +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.8" requires-python = ">=3.9"
license = { text = "GPLv3" } license = { text = "GPLv3" }
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)", "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.9", "Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: Utilities", "Topic :: Utilities",
] ]
@ -42,7 +42,7 @@ Tracker = "https://git.end-play.xyz/profitroll/LibBotUniversal/issues"
where = ["src"] where = ["src"]
[tool.black] [tool.black]
target-version = ['py38', 'py39', 'py310', 'py311'] target-version = ['py39', 'py310', 'py311' ,'py312']
[tool.isort] [tool.isort]
profile = "black" profile = "black"
@ -61,7 +61,7 @@ show_error_codes = true
[tool.pylint.main] [tool.pylint.main]
extension-pkg-whitelist = ["ujson"] extension-pkg-whitelist = ["ujson"]
py-version = 3.8 py-version = 3.9
[tool.coverage.run] [tool.coverage.run]
source = ["libbot"] source = ["libbot"]

View File

@ -1,11 +1,11 @@
black==24.4.2 black==24.10.0
build==1.2.1 build==1.2.2.post1
isort==5.13.2 isort==5.13.2
mypy==1.10.1 mypy==1.13.0
pylint==3.2.5 pylint==3.3.2
pytest-asyncio==0.23.7 pytest-asyncio==0.25.0
pytest-cov==5.0.0 pytest-cov==6.0.0
pytest==8.2.2 pytest==8.3.4
tox==4.16.0 tox==4.23.2
types-aiofiles==24.1.0.20240626 types-aiofiles==24.1.0.20240626
types-ujson==5.10.0.20240515 types-ujson==5.10.0.20240515

View File

@ -1,2 +1,2 @@
apscheduler~=3.10.4 apscheduler~=3.11.0
py-cord~=2.6.0 py-cord~=2.6.0

View File

@ -1,2 +1,2 @@
apscheduler~=3.10.4 apscheduler~=3.11.0
pyrofork~=2.3.32 pyrofork~=2.3.32

2
sonar-project.properties Normal file
View File

@ -0,0 +1,2 @@
sonar.projectKey=profitroll_libbot
sonar.organization=profitroll

View File

@ -1,4 +1,4 @@
__version__ = "3.2.3" __version__ = "3.3.0"
__license__ = "GPL3" __license__ = "GPL3"
__author__ = "Profitroll" __author__ = "Profitroll"

View File

@ -11,6 +11,8 @@ except ImportError:
from ._utils import supports_argument from ._utils import supports_argument
from .sync._nested import nested_delete, nested_set from .sync._nested import nested_delete, nested_set
DEFAULT_CONFIG_LOCATION: str = "config.json"
async def json_read(path: Union[str, Path]) -> Any: async def json_read(path: Union[str, Path]) -> Any:
"""Read contents of a JSON file """Read contents of a JSON file
@ -43,7 +45,7 @@ async def json_write(data: Any, path: Union[str, Path]) -> None:
async def config_get( async def config_get(
key: str, *path: str, config_file: Union[str, Path] = "config.json" key: str, *path: str, config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION
) -> Any: ) -> Any:
"""Get a value of the config key by its path provided """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"` For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`
@ -83,7 +85,7 @@ async def config_get(
async def config_set( async def config_set(
key: str, value: Any, *path: str, config_file: Union[str, Path] = "config.json" key: str, value: Any, *path: str, config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION
) -> None: ) -> None:
"""Set config's key by its path to the value """Set config's key by its path to the value
@ -99,14 +101,13 @@ async def config_set(
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
async def config_delete( async def config_delete(
key: str, key: str,
*path: str, *path: str,
missing_ok: bool = False, missing_ok: bool = False,
config_file: Union[str, Path] = "config.json", config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION,
) -> None: ) -> None:
"""Set config's key by its path """Set config's key by its path

View File

@ -358,7 +358,8 @@ class PyroClient(Client):
] ]
logger.info( logger.info(
"Registering commands %s with a default scope 'BotCommandScopeDefault'" "Registering commands %s with a default scope 'BotCommandScopeDefault'",
commands
) )
await self.set_bot_commands(commands) await self.set_bot_commands(commands)

View File

@ -9,6 +9,8 @@ try:
except ImportError: except ImportError:
from json import dumps, loads from json import dumps, loads
DEFAULT_CONFIG_LOCATION: str = "config.json"
def json_read(path: Union[str, Path]) -> Any: def json_read(path: Union[str, Path]) -> Any:
"""Read contents of a JSON file """Read contents of a JSON file
@ -41,7 +43,7 @@ def json_write(data: Any, path: Union[str, Path]) -> None:
def config_get( def config_get(
key: str, *path: str, config_file: Union[str, Path] = "config.json" key: str, *path: str, config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION
) -> Any: ) -> Any:
"""Get a value of the config key by its path provided """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"` For example, `foo.bar.key` has a path of `"foo", "bar"` and the key `"key"`
@ -81,7 +83,7 @@ def config_get(
def config_set( def config_set(
key: str, value: Any, *path: str, config_file: Union[str, Path] = "config.json" key: str, value: Any, *path: str, config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION
) -> None: ) -> None:
"""Set config's key by its path to the value """Set config's key by its path to the value
@ -95,14 +97,13 @@ def config_set(
* `KeyError`: Key is not found under path provided * `KeyError`: Key is not found under path provided
""" """
json_write(nested_set(json_read(config_file), value, *(*path, key)), config_file) json_write(nested_set(json_read(config_file), value, *(*path, key)), config_file)
return
def config_delete( def config_delete(
key: str, key: str,
*path: str, *path: str,
missing_ok: bool = False, missing_ok: bool = False,
config_file: Union[str, Path] = "config.json", config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION,
) -> None: ) -> None:
"""Set config's key by its path """Set config's key by its path

View File

@ -59,7 +59,7 @@ def test_config_delete(key: str, path: List[str], location_config: Path):
("bot_lol", ["bot"]), ("bot_lol", ["bot"]),
], ],
) )
async 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 ( assert (
sync.config_delete(key, *path, missing_ok=True, config_file=location_config) sync.config_delete(key, *path, missing_ok=True, config_file=location_config)
is None is None

View File

@ -6,10 +6,12 @@ from libbot._utils import supports_argument
def func1(foo: str, bar: str): def func1(foo: str, bar: str):
"""Dummy function with specific arguments"""
pass pass
def func2(foo: str): def func2(foo: str):
"""Dummy function with specific arguments"""
pass pass

View File

@ -1,14 +1,14 @@
[tox] [tox]
minversion = 3.8.0 minversion = 3.9.0
envlist = py38, py39, py310, py311 envlist = py39, py310, py311, py312
isolated_build = true isolated_build = true
[gh-actions] [gh-actions]
python = python =
3.8: py38
3.9: py39 3.9: py39
3.10: py310 3.10: py310
3.11: py311 3.11: py311
3.12: py312
[testenv] [testenv]
setenv = setenv =