qtbot.mouseClick() not .click()

newsfragments/2.feature.rst

@@ -0,0 +1 @@
+Introduce QTrio specific wrappers for some builtin dialogs.

qtrio/__init__.py

@@ -11,6 +11,7 @@
     EventTypeAlreadyRegisteredError,
     ReturnCodeError,
     RunnerTimedOutError,
+    UserCancelledError,
 )
 
 from ._core import (

qtrio/_dialogs.py

@@ -0,0 +1,339 @@
+import contextlib
+import os
+import sys
+import typing
+
+import async_generator
+import attr
+from qtpy import QtCore
+from qtpy import QtWidgets
+import trio
+
+import qtrio._qt
+
+
+@contextlib.contextmanager
+def manage(dialog):
+    finished_event = trio.Event()
+
+    def slot(*args, **kwargs):
+        if not finished_event.is_set():
+            finished_event.set()
+
+    with qtrio._qt.connection(signal=dialog.finished, slot=slot):
+        try:
+            dialog.setup()
+            yield finished_event
+        finally:
+            dialog.teardown()
+
+
+@attr.s(auto_attribs=True)
+class IntegerDialog:
+    parent: QtWidgets.QWidget
+    dialog: typing.Optional[QtWidgets.QInputDialog] = None
+    edit_widget: typing.Optional[QtWidgets.QWidget] = None
+    ok_button: typing.Optional[QtWidgets.QPushButton] = None
+    cancel_button: typing.Optional[QtWidgets.QPushButton] = None
+    attempt: typing.Optional[int] = None
+    result: typing.Optional[int] = None
+
+    shown = qtrio._qt.Signal(QtWidgets.QInputDialog)
+    hidden = qtrio._qt.Signal()
+    finished = qtrio._qt.Signal(int)  # QtWidgets.QDialog.DialogCode
+
+    @classmethod
+    def build(cls, parent: QtCore.QObject = None,) -> "IntegerDialog":
+        return cls(parent=parent)
+
+    def setup(self):
+        self.result = None
+
+        self.dialog = QtWidgets.QInputDialog(self.parent)
+
+        # TODO: adjust so we can use a context manager?
+        self.dialog.finished.connect(self.finished)
+
+        self.dialog.show()
+
+        buttons = dialog_button_box_buttons_by_role(dialog=self.dialog)
+        self.ok_button = buttons.get(QtWidgets.QDialogButtonBox.AcceptRole)
+        self.cancel_button = buttons.get(QtWidgets.QDialogButtonBox.RejectRole)
+
+        [self.edit_widget] = self.dialog.findChildren(QtWidgets.QLineEdit)
+
+        if self.attempt is None:
+            self.attempt = 0
+        else:
+            self.attempt += 1
+
+        self.shown.emit(self.dialog)
+
+    def teardown(self):
+        if self.dialog is not None:
+            self.dialog.close()
+            self.dialog.finished.disconnect(self.finished)
+        self.dialog = None
+        self.ok_button = None
+        self.cancel_button = None
+        self.edit_widget = None
+
+    async def wait(self):
+        while True:
+            with manage(dialog=self) as finished_event:
+                await finished_event.wait()
+
+                if self.dialog.result() != QtWidgets.QDialog.Accepted:
+                    raise qtrio.UserCancelledError()
+
+                try:
+                    self.result = int(self.dialog.textValue())
+                except ValueError:
+                    continue
+
+                return self.result
+
+
+@attr.s(auto_attribs=True)
+class TextInputDialog:
+    title: typing.Optional[str] = None
+    label: typing.Optional[str] = None
+    parent: typing.Optional[QtCore.QObject] = None
+
+    dialog: typing.Optional[QtWidgets.QInputDialog] = None
+    accept_button: typing.Optional[QtWidgets.QPushButton] = None
+    reject_button: typing.Optional[QtWidgets.QPushButton] = None
+    line_edit: typing.Optional[QtWidgets.QLineEdit] = None
+    result: typing.Optional[str] = None
+
+    shown = qtrio._qt.Signal(QtWidgets.QInputDialog)
+    finished = qtrio._qt.Signal(int)  # QtWidgets.QDialog.DialogCode
+
+    @classmethod
+    def build(
+        cls,
+        title: typing.Optional[str] = None,
+        label: typing.Optional[str] = None,
+        parent: typing.Optional[QtCore.QObject] = None,
+    ) -> "TextInputDialog":
+        return cls(title=title, label=label, parent=parent)
+
+    def setup(self):
+        self.result = None
+
+        self.dialog = QtWidgets.QInputDialog(parent=self.parent)
+        if self.label is not None:
+            self.dialog.setLabelText(self.label)
+        if self.title is not None:
+            self.dialog.setWindowTitle(self.title)
+
+        # TODO: adjust so we can use a context manager?
+        self.dialog.finished.connect(self.finished)
+        self.dialog.show()
+
+        buttons = dialog_button_box_buttons_by_role(dialog=self.dialog)
+        self.accept_button = buttons[QtWidgets.QDialogButtonBox.AcceptRole]
+        self.reject_button = buttons[QtWidgets.QDialogButtonBox.RejectRole]
+
+        [self.line_edit] = self.dialog.findChildren(QtWidgets.QLineEdit)
+
+        self.shown.emit(self.dialog)
+
+    def teardown(self):
+        if self.dialog is not None:
+            self.dialog.close()
+            self.dialog.finished.disconnect(self.finished)
+        self.dialog = None
+        self.accept_button = None
+        self.reject_button = None
+
+    async def wait(self):
+        with manage(dialog=self) as finished_event:
+            await finished_event.wait()
+
+            result = self.dialog.result()
+
+            if result == QtWidgets.QDialog.Rejected:
+                raise qtrio.UserCancelledError()
+
+            self.result = self.dialog.textValue()
+
+            return self.result
+
+
+def dialog_button_box_buttons_by_role(
+    dialog: QtWidgets.QDialog,
+) -> typing.Mapping[QtWidgets.QDialogButtonBox.ButtonRole, QtWidgets.QAbstractButton]:
+    hits = dialog.findChildren(QtWidgets.QDialogButtonBox)
+
+    if len(hits) == 0:
+        return {}
+
+    [button_box] = hits
+    return {button_box.buttonRole(button): button for button in button_box.buttons()}
+
+
+@attr.s(auto_attribs=True)
+class FileDialog:
+    file_mode: QtWidgets.QFileDialog.FileMode
+    accept_mode: QtWidgets.QFileDialog.AcceptMode
+    dialog: typing.Optional[QtWidgets.QFileDialog] = None
+    parent: typing.Optional[QtCore.QObject] = None
+    default_directory: typing.Optional[trio.Path] = None
+    default_file: typing.Optional[trio.Path] = None
+    options: QtWidgets.QFileDialog.Options = QtWidgets.QFileDialog.Options()
+    accept_button: typing.Optional[QtWidgets.QPushButton] = None
+    reject_button: typing.Optional[QtWidgets.QPushButton] = None
+    result: typing.Optional[trio.Path] = None
+
+    shown = qtrio._qt.Signal(QtWidgets.QFileDialog)
+    finished = qtrio._qt.Signal(int)  # QtWidgets.QDialog.DialogCode
+
+    @classmethod
+    def build(
+        cls,
+        parent: typing.Optional[QtCore.QObject] = None,
+        default_directory: typing.Optional[trio.Path] = None,
+        default_file: typing.Optional[trio.Path] = None,
+        options: QtWidgets.QFileDialog.Options = QtWidgets.QFileDialog.Options(),
+    ) -> "FileDialog":
+        return cls(
+            parent=parent,
+            default_directory=default_directory,
+            default_file=default_file,
+            options=options,
+            file_mode=QtWidgets.QFileDialog.AnyFile,
+            accept_mode=QtWidgets.QFileDialog.AcceptSave,
+        )
+
+    def setup(self):
+        self.result = None
+
+        extras = {}
+
+        if self.default_directory is not None:
+            extras["directory"] = os.fspath(self.default_directory)
+
+        options = self.options
+        if sys.platform == "darwin":
+            # https://github.com/altendky/qtrio/issues/28
+            options |= QtWidgets.QFileDialog.DontUseNativeDialog
+
+        self.dialog = QtWidgets.QFileDialog(
+            parent=self.parent, options=options, **extras
+        )
+
+        if self.default_file is not None:
+            self.dialog.selectFile(os.fspath(self.default_file))
+
+        self.dialog.setFileMode(self.file_mode)
+        self.dialog.setAcceptMode(self.accept_mode)
+
+        # TODO: adjust so we can use a context manager?
+        self.dialog.finished.connect(self.finished)
+
+        self.dialog.show()
+
+        buttons = dialog_button_box_buttons_by_role(dialog=self.dialog)
+        self.accept_button = buttons.get(QtWidgets.QDialogButtonBox.AcceptRole)
+        self.reject_button = buttons.get(QtWidgets.QDialogButtonBox.RejectRole)
+
+        self.shown.emit(self.dialog)
+
+    def teardown(self):
+        if self.dialog is not None:
+            self.dialog.close()
+            self.dialog.finished.disconnect(self.finished)
+        self.dialog = None
+        self.accept_button = None
+        self.reject_button = None
+
+    async def wait(self):
+        with manage(dialog=self) as finished_event:
+            await finished_event.wait()
+            if self.dialog.result() != QtWidgets.QDialog.Accepted:
+                self.result = None
+            else:
+                [path_string] = self.dialog.selectedFiles()
+                self.result = trio.Path(path_string)
+
+            return self.result
+
+
+@attr.s(auto_attribs=True)
+class MessageBox:
+    icon: QtWidgets.QMessageBox.Icon
+    title: str
+    text: str
+    buttons: QtWidgets.QMessageBox.StandardButtons
+
+    parent: typing.Optional[QtCore.QObject] = None
+
+    dialog: typing.Optional[QtWidgets.QMessageBox] = None
+    accept_button: typing.Optional[QtWidgets.QPushButton] = None
+    result: typing.Optional[trio.Path] = None
+
+    shown = qtrio._qt.Signal(QtWidgets.QMessageBox)
+    finished = qtrio._qt.Signal(int)  # QtWidgets.QDialog.DialogCode
+
+    @classmethod
+    def build_information(
+        cls,
+        title: str,
+        text: str,
+        icon: QtWidgets.QMessageBox.Icon = QtWidgets.QMessageBox.Information,
+        buttons: QtWidgets.QMessageBox.StandardButtons = QtWidgets.QMessageBox.Ok,
+        parent: typing.Optional[QtCore.QObject] = None,
+    ):
+        return cls(icon=icon, title=title, text=text, buttons=buttons, parent=parent)
+
+    def setup(self):
+        self.result = None
+
+        self.dialog = QtWidgets.QMessageBox(
+            self.icon, self.title, self.text, self.buttons, self.parent
+        )
+
+        # TODO: adjust so we can use a context manager?
+        self.dialog.finished.connect(self.finished)
+
+        self.dialog.show()
+
+        buttons = dialog_button_box_buttons_by_role(dialog=self.dialog)
+        self.accept_button = buttons[QtWidgets.QDialogButtonBox.AcceptRole]
+
+        self.shown.emit(self.dialog)
+
+    def teardown(self):
+        if self.dialog is not None:
+            self.dialog.close()
+        self.dialog = None
+        self.accept_button = None
+
+    async def wait(self):
+        with manage(dialog=self) as finished_event:
+            await finished_event.wait()
+
+            result = self.dialog.result()
+
+            if result == QtWidgets.QDialog.Rejected:
+                raise qtrio.UserCancelledError()
+
+
+@async_generator.asynccontextmanager
+async def manage_progress_dialog(
+    title: str,
+    label: str,
+    minimum: int = 0,
+    maximum: int = 0,
+    cancel_button_text: str = "Cancel",
+    parent: QtCore.QObject = None,
+):
+    dialog = QtWidgets.QProgressDialog(
+        label, cancel_button_text, minimum, maximum, parent
+    )
+    try:
+        dialog.setWindowTitle(title)
+        yield dialog
+    finally:
+        dialog.close()