Merge pull request 'v3.3.0' (#159) from dev into main

Reviewed-on: #159

.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

@@ -36,17 +36,4 @@ jobs:
       - uses: actions/upload-artifact@v3
         with:
           name: Artifacts
-          path: dist/*
+          path: dist/*
-  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: https://github.com/SonarSource/sonarcloud-github-action@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

requirements/dev.txt

@@ -2,10 +2,10 @@ black==24.10.0
 build==1.2.2.post1
 isort==5.13.2
 mypy==1.13.0
-pylint==3.3.1
+pylint==3.3.2
-pytest-asyncio==0.24.0
+pytest-asyncio==0.25.0
 pytest-cov==6.0.0
-pytest==8.3.3
+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
+apscheduler~=3.11.0
 py-cord~=2.6.0

requirements/pyrogram.txt

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

src/libbot/__main__.py

@@ -11,6 +11,8 @@ except ImportError:
 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
@@ -43,7 +45,7 @@ async def json_write(data: Any, path: Union[str, Path]) -> None:
 
 
 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"`
@@ -83,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
 
@@ -99,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/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

@@ -9,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
@@ -41,7 +43,7 @@ def json_write(data: Any, path: Union[str, Path]) -> None:
 
 
 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"`
@@ -81,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
 
@@ -95,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_utils.py

@@ -6,10 +6,12 @@ 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