Merge pull request 'v3.3.1' (#160) from dev into main

Reviewed-on: #160

.gitea/workflows/analysis.yml

@@ -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 }}

.gitea/workflows/tests.yml

@@ -10,11 +10,12 @@ on:
 
 jobs:
   test:
+    name: Build and Test
     runs-on: ubuntu-latest
     container: catthehacker/ubuntu:act-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v3
@@ -35,4 +36,4 @@ jobs:
       - uses: actions/upload-artifact@v3
         with:
           name: Artifacts
-          path: dist/*
+          path: dist/*

pyproject.toml

@@ -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.8"
+requires-python = ">=3.9"
 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 = ['py38', 'py39', 'py310', 'py311']
+target-version = ['py39', 'py310', 'py311' ,'py312']
 
 [tool.isort]
 profile = "black"
@@ -61,7 +61,7 @@ show_error_codes = true
 
 [tool.pylint.main]
 extension-pkg-whitelist = ["ujson"]
-py-version = 3.8
+py-version = 3.9
 
 [tool.coverage.run]
 source = ["libbot"]

requirements/dev.txt

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

requirements/pycord.txt

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

requirements/pyrogram.txt

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

sonar-project.properties

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

src/libbot/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.2.1"
+__version__ = "3.3.1"
 __license__ = "GPL3"
 __author__ = "Profitroll"
 

src/libbot/__main__.py

@@ -8,8 +8,11 @@ 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"
+
 
 async def json_read(path: Union[str, Path]) -> Any:
     """Read contents of a JSON file
@@ -36,13 +39,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 hasattr(dumps, "escape_forward_slashes")
+            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] = "config.json"
+    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"`
@@ -82,7 +85,7 @@ async def config_get(
 
 
 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:
     """Set config's key by its path to the value
 
@@ -98,14 +101,13 @@ async def config_set(
     await json_write(
         nested_set(await json_read(config_file), value, *(*path, key)), config_file
     )
-    return
 
 
 async def config_delete(
     key: str,
     *path: str,
     missing_ok: bool = False,
-    config_file: Union[str, Path] = "config.json",
+    config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION,
 ) -> None:
     """Set config's key by its path
 

src/libbot/_utils.py

@@ -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

src/libbot/pyrogram/classes/client.py

@@ -358,7 +358,8 @@ class PyroClient(Client):
             ]
 
             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)

src/libbot/sync/__main__.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 from typing import Any, Union
 
+from .._utils import supports_argument
 from ._nested import nested_delete, nested_set
 
 try:
@@ -8,6 +9,8 @@ try:
 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
@@ -34,13 +37,13 @@ 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 hasattr(dumps, "escape_forward_slashes")
+            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"
+    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"`
@@ -80,7 +83,7 @@ def config_get(
 
 
 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:
     """Set config's key by its path to the value
 
@@ -94,14 +97,13 @@ def config_set(
         * `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",
+    config_file: Union[str, Path] = DEFAULT_CONFIG_LOCATION,
 ) -> None:
     """Set config's key by its path
 

tests/test_config_sync.py

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

tests/test_utils.py

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

tox.ini

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