add qmlbot

.github/workflows/main.yml

@@ -2,6 +2,11 @@ name: build
 
 on: [push, pull_request]
 
+# Cancel running jobs for the same branch and workflow.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build:
 

.gitignore

@@ -16,3 +16,6 @@ src/pytest_qt.egg-info
 
 # auto-generated by setuptools_scm
 /src/pytestqt/_version.py
+
+# pycharm
+.idea

.pre-commit-config.yaml

@@ -28,7 +28,7 @@ repos:
     rev: 1.13.0
     hooks:
     -   id: blacken-docs
-        additional_dependencies: [black==20.8b1]
+        additional_dependencies: [black>=22.1.0]
         language_version: python3
 -   repo: https://github.com/PyCQA/flake8
     rev: 6.0.0

CHANGELOG.rst

@@ -1,3 +1,12 @@
+4.3.0 (UNRELEASED)
+------------------
+
+- New ``qmlbot`` fixture to help test QtQuick applications (`#476`_). Thanks `@nrbnlulu`_ for the PR.
+
+.. _#476: https://github.com/pytest-dev/pytest-qt/pull/476
+.. _@nrbnlulu: https://github.com/nrbnlulu
+
+
 4.2.0 (2022-10-25)
 ------------------
 

docs/index.rst

@@ -19,6 +19,7 @@ pytest-qt
     virtual_methods
     modeltester
     qapplication
+    qmlbot
     note_dialogs
     debugging
     troubleshooting

docs/qmlbot.rst

@@ -0,0 +1,36 @@
+=========
+qmlbot
+=========
+
+Fixture that helps interacting with QML.
+
+Example - load qml from string:
+
+.. code-block:: python
+
+    def test_say_hello(qmlbot):
+        qml = """
+        import QtQuick 2.0
+
+        Rectangle{
+            objectName: "sample";
+            property string hello: "world"
+        }
+        """
+        item = qmlbot.loads(qml)
+        assert item.property("hello") == "world"
+
+
+Example - load qml from file:
+
+.. code-block:: python
+
+    from pathlib import Path
+
+
+    def test_say_hello(qmlbot):
+        item = qmlbot.load(Path("sayhello.qml"))
+        assert item.property("hello") == "world"
+
+Note: if your components depends on any instances or ``@QmlElement``'s you need
+to make sure it is acknowledge by ``qmlbot.engine``

setup.py

@@ -8,6 +8,8 @@
     packages=find_packages(where="src"),
     package_dir={"": "src"},
     entry_points={"pytest11": ["pytest-qt = pytestqt.plugin"]},
+    include_package_data=True,
+    package_data={"pytestqt": ["**/*.qml"]},
     install_requires=["pytest>=3.0.0"],
     extras_require={
         "doc": ["sphinx", "sphinx_rtd_theme"],

src/pytestqt/__init__.py

@@ -1,4 +1,8 @@
 # _version is automatically generated by setuptools_scm
 from pytestqt._version import version
 
+from .qml.qmlbot import QmlBot
+
 __version__ = version
+
+__all__ = ["QmlBot", "__version__"]

src/pytestqt/exceptions.py

@@ -79,7 +79,7 @@ def format_captured_exceptions(exceptions):
     stream.write("Exceptions caught in Qt event loop:\n")
     sep = "_" * 80 + "\n"
     stream.write(sep)
-    for (exc_type, value, tback) in exceptions:
+    for exc_type, value, tback in exceptions:
         traceback.print_exception(exc_type, value, tback, file=stream)
         stream.write(sep)
     return stream.getvalue()

src/pytestqt/modeltest.py

@@ -54,7 +54,6 @@
 
 
 class _ChangeInFlight(enum.Enum):
-
     COLUMNS_INSERTED = enum.auto()
     COLUMNS_MOVED = enum.auto()
     COLUMNS_REMOVED = enum.auto()

src/pytestqt/plugin.py

@@ -7,6 +7,7 @@
     _QtExceptionCaptureManager,
 )
 from pytestqt.logging import QtLoggingPlugin, _QtMessageCapture
+from pytestqt.qml.qmlbot import QmlBot
 from pytestqt.qt_compat import qt_api
 from pytestqt.qtbot import QtBot, _close_widgets
 
@@ -93,6 +94,11 @@ def qtbot(qapp, request):
     return result
 
 
+@pytest.fixture
+def qmlbot(qapp) -> QmlBot:
+    return QmlBot()
+
+
 @pytest.fixture
 def qtlog(request):
     """Fixture that can access messages captured during testing"""

src/pytestqt/qml/botloader.qml

@@ -0,0 +1,18 @@
+import QtQuick 2.15
+import QtQuick.Window 2.15
+
+Window {
+    id: root
+    width: 500
+    height: 400
+    visible: true
+
+
+    Item {
+        anchors.fill: parent
+        Loader {
+            objectName: "contentloader"
+            source: ""
+        }
+    }
+}

src/pytestqt/qml/qmlbot.py

@@ -0,0 +1,47 @@
+import os
+from pathlib import Path
+from typing import Any
+
+from pytestqt.qt_compat import qt_api
+
+
+class QmlBot:
+    def __init__(self) -> None:
+        self.engine = qt_api.QtQml.QQmlApplicationEngine()
+        main = Path(__file__).parent / "botloader.qml"
+        self.engine.load(os.fspath(main))
+
+    @property
+    def _loader(self) -> Any:
+        self._root = self.engine.rootObjects()[
+            0
+        ]  # self is needed for it not to be collected by the gc
+        return self._root.findChild(qt_api.QtQuick.QQuickItem, "contentloader")
+
+    def load(self, path: Path) -> Any:
+        """
+        :returns: `QQuickItem` - the initialized component
+        """
+        self._loader.setProperty(
+            "source", qt_api.QtCore.QUrl(path.resolve(True).as_uri())
+        )
+        return self._loader.property("item")
+
+    def loads(self, content: str) -> Any:
+        """
+        :returns: `QQuickItem` - the initialized component
+        """
+        self._comp = qt_api.QtQml.QQmlComponent(
+            self.engine
+        )  # needed for it not to be collected by the gc
+        self._comp.setData(content.encode("utf-8"), qt_api.QtCore.QUrl())
+        if self._comp.status() != qt_api.QtQml.QQmlComponent.Status.Ready:
+            raise RuntimeError(
+                f"component {self._comp} is not Ready:\n"
+                f"STATUS: {self._comp.status()}\n"
+                f"HINT: make sure there are no wrong spaces.\n"
+                f"ERRORS: {self._comp.errors()}"
+            )
+        self._loader.setProperty("source", "")
+        self._loader.setProperty("sourceComponent", self._comp)
+        return self._loader.property("item")

src/pytestqt/qt_compat.py

@@ -110,6 +110,8 @@ def _import_module(module_name):
         self.QtGui = _import_module("QtGui")
         self.QtTest = _import_module("QtTest")
         self.QtWidgets = _import_module("QtWidgets")
+        self.QtQml = _import_module("QtQml")
+        self.QtQuick = _import_module("QtQuick")
 
         self._check_qt_api_version()
 

tests/test_basics.py

@@ -592,7 +592,6 @@ def _fake_is_library_loaded(name, *args):
     ],
 )
 def test_already_loaded_backend(monkeypatch, option_api, backend):
-
     import builtins
 
     class Mock:
@@ -628,6 +627,8 @@ class Mock:
     qbackend.QtCore = qtcore
     qbackend.QtGui = object()
     qbackend.QtTest = object()
+    qbackend.QtQml = object()
+    qbackend.QtQuick = object()
     qbackend.QtWidgets = qtwidgets
 
     import_orig = builtins.__import__

tests/test_qml/sample.qml

@@ -0,0 +1,6 @@
+import QtQuick 2.0
+
+Rectangle{
+    objectName: "sample";
+    property string hello: "world"
+}

tests/test_qml/test_qmlbot.py

@@ -0,0 +1,34 @@
+from pathlib import Path
+from textwrap import dedent
+
+import pytest
+
+from pytestqt import QmlBot
+
+
+def test_load_from_string_wrong_syntax(qmlbot: QmlBot) -> None:
+    qml = "import QtQuick 2.0 Rectangle{"
+    with pytest.raises(RuntimeError):
+        qmlbot.loads(qml)
+
+
+def test_load_from_string(qmlbot: QmlBot) -> None:
+    text = "that's a template!"
+    qml = dedent(
+        """
+        import QtQuick 2.0
+
+        Rectangle{
+            objectName: "sample";
+            property string hello: "%s"
+        }
+        """
+        % text
+    )
+    item = qmlbot.loads(qml)
+    assert item.property("hello") == text
+
+
+def test_load_from_file(qmlbot: QmlBot) -> None:
+    item = qmlbot.load(Path(__file__).parent / "sample.qml")
+    assert item.property("hello") == "world"