Merge pull request 'Update dependency twine to v6.1.0' (#181) from renovate/twine-6.x into dev

Reviewed-on: #181

.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
+    runs-on: ubuntu-24.04
-    container: catthehacker/ubuntu:act-latest
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: SonarCloud Scan
+      - uses: SonarActions/cache@v1
-        uses: SonarSource/sonarcloud-github-action@master
+      - 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

@@ -0,0 +1,67 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [ published ]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    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-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-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:
+          password: ${{ secrets.PYPI_PYPI_API_TOKEN }}

.gitea/workflows/tests.yml

@@ -11,18 +11,18 @@ on:
 jobs:
   test:
     name: Build and Test
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
-    container: catthehacker/ubuntu:act-latest
     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

README.md

@@ -36,6 +36,8 @@ pip install libbot[pycord,speed]
 ### Pyrogram
 
 ```python
+import sys
+
 from libbot.pyrogram.classes import PyroClient
 
 
@@ -47,7 +49,7 @@ def main():
     except KeyboardInterrupt:
         print("Shutting down...")
     finally:
-        exit()
+        sys.exit()
 
 
 if __name__ == "__main__":
@@ -57,6 +59,9 @@ if __name__ == "__main__":
 ### Pycord
 
 ```python
+import asyncio
+from asyncio import AbstractEventLoop
+
 from discord import Intents
 from libbot.utils import config_get
 from libbot.pycord.classes import PycordBot
@@ -76,7 +81,7 @@ async def main():
 
 
 if __name__ == "__main__":
-    loop = asyncio.get_event_loop()
+    loop: AbstractEventLoop = asyncio.get_event_loop()
     loop.run_until_complete(main())
 ```
 

examples/README.md

@@ -0,0 +1,4 @@
+# Examples
+
+If you're looking for Pyrogram usage examples, please take a look at
+the [PyrogramBotBase](https://git.end-play.xyz/profitroll/PyrogramBotBase) repository.

requirements/_.txt

@@ -1,2 +1,2 @@
 aiofiles>=23.0.0
-typing_extensions~=4.12.2
+typing-extensions~=4.12.2

requirements/dev.txt

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

src/libbot/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "4.0.1"
+__version__ = "4.0.2"
 __license__ = "GPL3"
 __author__ = "Profitroll"
 

src/libbot/pycord/classes/bot.py

@@ -1,9 +1,13 @@
 import logging
+from logging import Logger
 from pathlib import Path
 from typing import Any, Dict
 
 from typing_extensions import override
 
+from ...i18n.classes import BotLocale
+from ...utils import json_read
+
 try:
     from apscheduler.schedulers.asyncio import AsyncIOScheduler
     from apscheduler.schedulers.background import BackgroundScheduler
@@ -11,32 +15,21 @@ try:
 except ImportError as exc:
     raise ImportError("You need to install libbot[pycord] in order to use this class.") from exc
 
-try:
+logger: Logger = logging.getLogger(__name__)
-    from ujson import loads
-except ImportError:
-    from json import loads
-
-from ...i18n.classes import BotLocale
-
-logger = logging.getLogger(__name__)
 
 
 class PycordBot(Bot):
     @override
     def __init__(
-        self,
+            self,
-        *args,
+            *args,
-        config: Dict[str, Any] | None = None,
+            config: Dict[str, Any] | None = None,
-        config_path: str | Path = Path("config.json"),
+            config_path: str | Path = Path("config.json"),
-        locales_root: str | Path | None = None,
+            locales_root: str | Path | None = None,
-        scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
+            scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
-        **kwargs,
+            **kwargs,
     ):
-        if config is None:
+        self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
-            with open(config_path, "r", encoding="utf-8") as f:
-                self.config: dict = loads(f.read())
-        else:
-            self.config = config
 
         super().__init__(
             debug_guilds=(self.config["bot"]["debug_guilds"] if self.config["debug"] else None),

src/libbot/pycord/utils/__init__.py

@@ -0,0 +1 @@
+from .color import color_from_hex, hex_from_color

src/libbot/pycord/utils/color.py

@@ -0,0 +1,35 @@
+from discord import Colour
+
+
+def _int_from_hex(hex_string: str) -> int:
+    try:
+        return int(hex_string, base=16)
+    except Exception as exc:
+        raise ValueError("Input string must be a valid HEX code.") from exc
+
+
+def _hex_from_int(color_int: int) -> str:
+    if not 0 <= color_int <= 0xFFFFFF:
+        raise ValueError("Color's value must be in the range 0 to 0xFFFFFF.")
+
+    return f"#{color_int:06x}"
+
+
+def color_from_hex(hex_string: str) -> Colour:
+    """Convert valid hexadecimal string to discord.Colour.
+
+    :param hex_string: Hexadecimal string to convert into Colour object
+    :type hex_string: str
+    :return: Colour object
+    """
+    return Colour(_int_from_hex(hex_string))
+
+
+def hex_from_color(color: Colour) -> str:
+    """Convert discord.Colour to hexadecimal string.
+
+    :param color: Colour object to convert into the string
+    :type color: Colour
+    :return: Hexadecimal string in #XXXXXX format
+    """
+    return _hex_from_int(color.value)

src/libbot/pyrogram/classes/client.py

@@ -2,6 +2,7 @@ import asyncio
 import logging
 import sys
 from datetime import datetime, timedelta
+from logging import Logger
 from os import cpu_count, getpid
 from pathlib import Path
 from time import time
@@ -9,6 +10,12 @@ from typing import Any, Dict, List
 
 from typing_extensions import override
 
+from .command import PyroCommand
+from .commandset import CommandSet
+from ...i18n import _
+from ...i18n.classes import BotLocale
+from ...utils import json_read
+
 try:
     import pyrogram
     from apscheduler.schedulers.asyncio import AsyncIOScheduler
@@ -35,42 +42,33 @@ try:
 except ImportError:
     from json import dumps, loads
 
-from ...i18n.classes import BotLocale
+logger: Logger = logging.getLogger(__name__)
-from ...i18n import _
-from .command import PyroCommand
-from .commandset import CommandSet
-
-logger = logging.getLogger(__name__)
 
 
 class PyroClient(Client):
     @override
     def __init__(
-        self,
+            self,
-        name: str = "bot_client",
+            name: str = "bot_client",
-        owner: int | None = None,
+            owner: int | None = None,
-        config: Dict[str, Any] | None = None,
+            config: Dict[str, Any] | None = None,
-        config_path: str | Path = Path("config.json"),
+            config_path: str | Path = Path("config.json"),
-        api_id: int | None = None,
+            api_id: int | None = None,
-        api_hash: str | None = None,
+            api_hash: str | None = None,
-        bot_token: str | None = None,
+            bot_token: str | None = None,
-        workers: int = min(32, cpu_count() + 4),
+            workers: int = min(32, cpu_count() + 4),
-        locales_root: str | Path | None = None,
+            locales_root: str | Path | None = None,
-        plugins_root: str = "plugins",
+            plugins_root: str = "plugins",
-        plugins_exclude: List[str] | None = None,
+            plugins_exclude: List[str] | None = None,
-        sleep_threshold: int = 120,
+            sleep_threshold: int = 120,
-        max_concurrent_transmissions: int = 1,
+            max_concurrent_transmissions: int = 1,
-        commands_source: Dict[str, dict] | None = None,
+            commands_source: Dict[str, dict] | None = None,
-        scoped_commands: bool | None = None,
+            scoped_commands: bool | None = None,
-        i18n_bot_info: bool = False,
+            i18n_bot_info: bool = False,
-        scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
+            scheduler: AsyncIOScheduler | BackgroundScheduler | None = None,
-        **kwargs,
+            **kwargs,
     ):
-        if config is None:
+        self.config: Dict[str, Any] = config if config is not None else json_read(config_path)
-            with open(config_path, "r", encoding="utf-8") as f:
-                self.config: dict = loads(f.read())
-        else:
-            self.config = config
 
         super().__init__(
             name=name,
@@ -211,7 +209,7 @@ class PyroClient(Client):
 
     @override
     async def stop(
-        self, exit_completely: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
+            self, exit_completely: bool = True, scheduler_shutdown: bool = True, scheduler_wait: bool = True
     ) -> None:
         try:
             await self.send_message(
@@ -310,7 +308,7 @@ class PyroClient(Client):
             # in it, if there are any. Then adds them to self.commands
             for handler in self.dispatcher.groups[0]:
                 if isinstance(handler, MessageHandler) and (
-                    hasattr(handler.filters, "base") or hasattr(handler.filters, "other")
+                        hasattr(handler.filters, "base") or hasattr(handler.filters, "other")
                 ):
                     for entry in [handler.filters.base, handler.filters.other]:
                         if hasattr(entry, "commands"):
@@ -321,8 +319,8 @@ class PyroClient(Client):
         return command_sets
 
     def add_command(
-        self,
+            self,
-        command: str,
+            command: str,
     ) -> None:
         """Add command to the bot's internal commands list