Merge pull request 'Closes #187 and improves documentation' (#188) from bugfix/187 into dev

Reviewed-on: #188

.gitea/workflows/analysis.yml

@@ -6,19 +6,19 @@ on:
       - main
       - dev
   pull_request:
-    types: [opened, synchronize, reopened]
+    types: [ opened, synchronize, reopened ]
 
 jobs:
   sonarcloud:
     name: SonarCloud
-    runs-on: ubuntu-latest
-    container: catthehacker/ubuntu:act-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: SonarCloud Scan
-        uses: SonarSource/sonarcloud-github-action@master
+      - uses: SonarActions/cache@v1
+      - name: SonarQube Scan
+        uses: SonarSource/sonarqube-scan-action@v4.2.1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitea/workflows/publish.yml

@@ -9,81 +9,58 @@ permissions:
 
 jobs:
   release-build:
-    runs-on: ubuntu-latest
-    container: catthehacker/ubuntu:act-latest
-
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-
       - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
-
       - name: Build release distributions
         run: |
           python -m pip install build
           python -m build
-
       - name: Upload distributions
         uses: christopherhx/gitea-upload-artifact@v4
         with:
           name: release-dists
           path: dist/
-
   gitea-publish:
-    runs-on: ubuntu-latest
-    container: catthehacker/ubuntu:act-latest
-
-    needs:
-      - release-build
-
+    runs-on: ubuntu-24.04
+    needs: release-build
     permissions:
       id-token: write
-
     environment:
       name: gitea
       url: https://git.end-play.xyz/profitroll/-/packages/pypi/libbot
-
     env:
       GITHUB_WORKFLOW_REF: ${{ gitea.workflow_ref }}
       INPUT_REPOSITORY_URL: https://git.end-play.xyz/api/packages/profitroll/pypi
-
     steps:
       - name: Retrieve release distributions
         uses: christopherhx/gitea-download-artifact@v4
         with:
           name: release-dists
           path: dist/
-
       - name: Publish package distributions to TestPyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.PYPI_GITEA_API_TOKEN }}
           repository-url: https://git.end-play.xyz/api/packages/profitroll/pypi
-
   pypi-publish:
-    runs-on: ubuntu-latest
-    container: catthehacker/ubuntu:act-latest
-
-    needs:
-      - release-build
-
+    runs-on: ubuntu-24.04
+    needs: release-build
     permissions:
       id-token: write
-
     environment:
       name: pypi
-
     env:
       GITHUB_WORKFLOW_REF: ${{ gitea.workflow_ref }}
-
     steps:
       - name: Retrieve release distributions
         uses: christopherhx/gitea-download-artifact@v4
         with:
           name: release-dists
           path: dist/
-
       - name: Publish package distributions to TestPyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:

.gitea/workflows/tests.yml

@@ -11,18 +11,18 @@ on:
 jobs:
   test:
     name: Build and Test
-    runs-on: ubuntu-latest
-    container: catthehacker/ubuntu:act-latest
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
         python-version: [ "3.11", "3.12", "3.13" ]
-
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: './requirements/*'
         env:
           AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
       - name: Install dependencies

requirements/dev.txt

@@ -1,12 +1,12 @@
-black==24.10.0
+black==25.1.0
 build==1.2.2.post1
 isort==5.13.2
-mypy==1.14.1
-pylint==3.3.3
-pytest-asyncio==0.25.1
+mypy==1.15.0
+pylint==3.3.4
+pytest-asyncio==0.25.3
 pytest-cov==6.0.0
 pytest==8.3.4
-tox==4.23.2
-twine==6.0.1
+tox==4.24.0
+twine==6.1.0
 types-aiofiles==24.1.0.20241221
 types-ujson==5.10.0.20240515

src/libbot/utils/config/_functions.py

@@ -20,7 +20,7 @@ def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CONFIG_LO
 
     ### Args:
         * key (`str`): Key that contains the value
-        * *path (`str`): Path to the key that contains the value
+        * *path (`str`): Path to the key that contains the value (pass *[] or don't pass anything at all to get on the top/root level)
         * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
     ### Returns:
@@ -59,7 +59,7 @@ async def config_get(key: str, *path: str, config_file: str | Path = DEFAULT_CON
 
     ### Args:
         * key (`str`): Key that contains the value
-        * *path (`str`): Path to the key that contains the value
+        * *path (`str`): Path to the key that contains the value (pass *[] or don't pass anything at all to get on the top/root level)
         * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
     ### Returns:
@@ -98,7 +98,7 @@ def config_set(key: str, value: Any, *path: str, config_file: str | Path = DEFAU
     ### Args:
         * key (`str`): Key that leads to the value
         * value (`Any`): Any JSON serializable data
-        * *path (`str`): Path to the key of the target
+        * *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to set on the top/root level)
         * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
     ### Raises:
@@ -116,7 +116,7 @@ async def config_set(
     ### Args:
         * key (`str`): Key that leads to the value
         * value (`Any`): Any JSON serializable data
-        * *path (`str`): Path to the key of the target
+        * *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to set on the top/root level)
         * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
     ### Raises:
@@ -136,7 +136,7 @@ def config_delete(
 
     ### Args:
         * key (`str`): Key to delete
-        * *path (`str`): Path to the key of the target
+        * *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to delete on the top/root level)
         * missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
         * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 
@@ -165,7 +165,7 @@ async def config_delete(
 
     ### Args:
         * key (`str`): Key to delete
-        * *path (`str`): Path to the key of the target
+        * *path (`str`): Path to the key of the target (pass *[] or don't pass anything at all to delete on the top/root level)
         * missing_ok (`bool`): Do not raise an exception if the key is missing. Defaults to `False`
         * config_file (`str | Path`, *optional*): Path-like object or path as a string of a location of the config file. Defaults to `"config.json"`
 

src/libbot/utils/misc/_functions.py

@@ -3,11 +3,11 @@ from typing import Any, Dict
 from typing import Callable
 
 
-def supports_argument(func: Callable, arg_name: str) -> bool:
+def supports_argument(func: Callable[..., Any], arg_name: str) -> bool:
     """Check whether a function has a specific argument
 
     ### Args:
-        * func (`Callable`): Function to be inspected
+        * func (`Callable[..., Any]`): Function to be inspected
         * arg_name (`str`): Argument to be checked
 
     ### Returns:
@@ -24,11 +24,13 @@ def supports_argument(func: Callable, arg_name: str) -> bool:
     return False
 
 
-def nested_set(target: dict, value: Any, *path: str, create_missing=True) -> Dict[str, Any]:
+def nested_set(
+    target: Dict[str, Any], value: Any, *path: str, create_missing: bool = True
+) -> Dict[str, Any]:
     """Set the key by its path to the value
 
     ### Args:
-        * target (`dict`): Dictionary to perform modifications on
+        * target (`Dict[str, Any]`): 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`
@@ -39,29 +41,29 @@ def nested_set(target: dict, value: Any, *path: str, create_missing=True) -> Dic
     ### Returns:
         * `Dict[str, Any]`: Changed dictionary
     """
-    d = target
+    target_copy: Dict[str, Any] = target
 
     for key in path[:-1]:
-        if key in d:
-            d = d[key]
+        if key in target_copy:
+            target_copy = target_copy[key]
         elif create_missing:
-            d = d.setdefault(key, {})
+            target_copy = target_copy.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
+    if path[-1] in target_copy or create_missing:
+        target_copy[path[-1]] = value
 
     return target
 
 
-def nested_delete(target: dict, *path: str) -> Dict[str, Any]:
+def nested_delete(target: Dict[str, Any], *path: str) -> Dict[str, Any]:
     """Delete the key by its path
 
     ### Args:
-        * target (`dict`): Dictionary to perform modifications on
+        * target (`Dict[str, Any]`): Dictionary to perform modifications on
 
     ### Raises:
         * `KeyError`: Key is not found under path provided
@@ -69,16 +71,16 @@ def nested_delete(target: dict, *path: str) -> Dict[str, Any]:
     ### Returns:
         `Dict[str, Any]`: Changed dictionary
     """
-    d = target
+    target_copy: Dict[str, Any] = target
 
     for key in path[:-1]:
-        if key in d:
-            d = d[key]
+        if key in target_copy:
+            target_copy = target_copy[key]
         else:
             raise KeyError(f"Key '{key}' is not found under path provided ({path})")
 
-    if path[-1] in d:
-        del d[path[-1]]
+    if path[-1] in target_copy:
+        del target_copy[path[-1]]
     else:
         raise KeyError(f"Key '{path[-1]}' is not found under path provided ({path})")