Prepare stubs for 2.5.1.

.github/workflows/default.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.11
+          python-version: 3.12
       - uses: abatilo/actions-poetry@v2
       - name: Install
         run: |

.github/workflows/linting.yml

@@ -10,7 +10,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.11
+          python-version: 3.12
       - uses: abatilo/actions-poetry@v2
       - name: Install
         run: |

.github/workflows/pypi-publish.yml

@@ -22,7 +22,7 @@ jobs:
           replace-with: "$1"
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.11
+          python-version: 3.12
       - uses: abatilo/actions-poetry@v2
       - name: Build
         run: |

configs/config-2.5.yml

@@ -3,7 +3,7 @@
 version: 2
 
 # version of the stubs - this is overridden when publishing
-__version__: "2.5.0"
+__version__: "2.5.1"
 
 # This is the root of the mobase module and will contain everything
 # related to functions / classes, including their documentation.

stubs/2.5.1/mobase-stubs/widgets/__init__.pyi

@@ -0,0 +1,159 @@
+from __future__ import annotations
+
+__version__ = "2.5.1"
+
+from typing import List, Tuple, Union, overload
+
+import PyQt6.QtCore
+import PyQt6.QtGui
+import PyQt6.QtWidgets
+
+class TaskDialog:
+    """
+    Customizable choice dialog.
+    """
+
+    def __init__(self: TaskDialog, parent: PyQt6.QtWidgets.QWidget  | None = None, title: str = '', main: str = '', content: str = '', details: str = '', icon: PyQt6.QtWidgets.QMessageBox.Icon = PyQt6.QtWidgets.QMessageBox.Icon.NoIcon, buttons: list[TaskDialogButton] = [], remember: Union[str, tuple[str, str]] = '') -> None:
+        """
+        Construct a new TaskDialog.
+
+        Args:
+            parent: Parent widget of the dialog.
+            title: Title of the dialog.
+            main: Header of the dialog (big text at the top).
+            content: Main message of the dialog (text below main).
+            details: Details for the dialog, initially collapsed (bottom of the dialog).
+            icon: Icon for the dialog.
+            buttons: List of buttons for the dialog.
+            remember: Remember the choice for this dialog.
+        """
+        ...
+    def addButton(self: TaskDialog, button: TaskDialogButton) -> TaskDialog:
+        """
+        Add a custom button to this TaskDialog.
+
+        Args:
+            button: Button to add to the dialog.
+        """
+        ...
+    def addContent(self: TaskDialog, widget: PyQt6.QtWidgets.QWidget) -> None:
+        """
+        Add a custom widget content to this TaskDialog. Widget content are put between
+        content and buttons (above buttons).
+
+        Args:
+            widget: Widget to add.
+        """
+        ...
+    def exec(self: TaskDialog) -> PyQt6.QtWidgets.QMessageBox.StandardButton:
+        """
+        Display this dialog and wait for user-interaction to return. This is a blocking
+        function.
+
+        Returns:
+            The button clicked by the user. Without custom buttons, this return Ok,
+        otherwise it returns the button set in the TaskDialogButton.
+        """
+        ...
+    def setContent(self: TaskDialog, content: str) -> TaskDialog:
+        """
+        Set the top-level message of this dialog.
+
+        Args:
+            content: Top-level message to set.
+        """
+        ...
+    def setDetails(self: TaskDialog, details: str) -> TaskDialog:
+        """
+        Set the details for this TaskDialog.
+
+        The details are hidden by default and the user can display them by clicking
+        the "Details" button at the bottom of the TaskDialog.
+
+        Args:
+            details: Details content to display. Can be a multi-line string.
+        """
+        ...
+    def setIcon(self: TaskDialog, icon: PyQt6.QtWidgets.QMessageBox.Icon) -> TaskDialog:
+        """
+        Set the icon of the dialog.
+
+        Args:
+            icon: Icon of the dialog.
+        """
+        ...
+    def setMain(self: TaskDialog, main: str) -> TaskDialog:
+        """
+        Set the main message of the dialog. The main message is displayed at the top of
+        the dialog in large font.
+
+        Args:
+            main: Main message of the dialog.
+        """
+        ...
+    def setRemember(self: TaskDialog, action: str, file: str = '') -> TaskDialog:
+        """
+        Configure the dialog to remember user-choice.
+        """
+        ...
+    def setTitle(self: TaskDialog, title: str) -> TaskDialog:
+        """
+        Set the title of the dialog.
+
+        Args:
+            title: Title of the dialog.
+        """
+        ...
+    def setWidth(self: TaskDialog, width: int) -> None:
+        """
+        Set the width of the dialog.
+
+        Args:
+            width: Width of the dialog.
+        """
+        ...
+
+
+class TaskDialogButton:
+    """
+    Special button to be used inside TaskDialog widgets.
+    """
+
+    @property
+    def button(self) -> PyQt6.QtWidgets.QMessageBox.StandardButton: ...
+    @button.setter
+    def button(self, arg0: PyQt6.QtWidgets.QMessageBox.StandardButton) -> None: ...
+
+    @property
+    def description(self) -> str: ...
+    @description.setter
+    def description(self, arg0: str) -> None: ...
+
+    @property
+    def text(self) -> str: ...
+    @text.setter
+    def text(self, arg0: str) -> None: ...
+
+    @overload
+    def __init__(self: TaskDialogButton, text: str, description: str, button: PyQt6.QtWidgets.QMessageBox.StandardButton) -> None:
+        """
+        Create a TaskDialogButton.
+
+        Args:
+            text: Label of the button.
+            description: Description of the button.
+            button: Value returned by TaskDialog.exec() if this button is clicked.
+        """
+        ...
+    @overload
+    def __init__(self: TaskDialogButton, text: str, button: PyQt6.QtWidgets.QMessageBox.StandardButton) -> None:
+        """
+        Create a TaskDialogButton without description.
+
+        Args:
+            text: Label of the button.
+            button: Value returned by TaskDialog.exec() if this button is clicked.
+        """
+        ...
+
+

stubs/setup/poetry.lock

@@ -1,7 +1,7 @@
-# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand.
+# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand.
 package = []
 
 [metadata]
 lock-version = "2.0"
-python-versions = "^3.11"
-content-hash = "81b2fa642d7f2d1219cf80112ace12d689d053d81be7f7addb98144d56fc0fb2"
+python-versions = "^3.12"
+content-hash = "34e39677d8527182346093002688d17a5d2fc204b9eb3e094b2e6ac519028228"

stubs/setup/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mobase-stubs"
-version = "v2.5.0.dev16"
+version = "v2.5.0.dev17"
 description = "PEP561 stub files for the mobase Python API."
 authors = ["Holt59 <capelle.mikael@gmail.com>"]
 license = "MIT"
@@ -11,7 +11,7 @@ documentation = "https://www.modorganizer.org/python-plugins-doc/"
 repository = "https://github.com/ModOrganizer2/mo2-pystubs-generation"
 
 [tool.poetry.dependencies]
-python = "^3.11"
+python = "^3.12"
 
 [build-system]
 requires = ["poetry-core"]