Merge pull request #25 from int-brain-lab/develop

0.6.1

Author: bimac

.github/workflows/documentation.yaml

@@ -18,16 +18,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: pdm-project/setup-pdm@v4
-        with:
-          cache: true
-          python-version: '3.10'
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
       - name: Install dependencies
-        run: pdm install -dG doc
-      - name: Install PyQt5
-        run: pdm add PyQt5
+        run: uv sync --no-default-groups --group doc --extra pyqt6
+      - name: Install libegl1
+        uses: awalsh128/cache-apt-pkgs-action@latest
+        with:
+          packages: libegl1
+          version: 1.0
       - name: Sphinx build
-        run: pdm run sphinx-build docs/source docs/build
+        run: uv run sphinx-build docs/source docs/build
       - uses: peaceiris/actions-gh-pages@v4
         with:
           publish_branch: gh-pages

.github/workflows/publish.yaml

@@ -13,6 +13,9 @@ jobs:
       id-token: write
     steps:
       - uses: actions/checkout@v4
-      - uses: pdm-project/setup-pdm@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Build package
+        run: uv build
       - name: Publish package
-        run: pdm publish
+        run: uv publish

CHANGELOG.md

@@ -6,6 +6,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.1] - 2025-07-15
+
+### Changed
+- `widgets.RestrictedWebView`: additional parameters to control tool-tips and status-tips
+
 ## [0.6.0] - 2025-07-15
 
 ### Added
@@ -130,6 +135,7 @@ _First release._
   providing color-mapped numerical data.
 - `widgets.StatefulButton`: A `QPushButton` that maintains an active/inactive state.
 
+[0.6.1]: https://github.com/int-brain-lab/iblqt/releases/tag/v0.6.1
 [0.6.0]: https://github.com/int-brain-lab/iblqt/releases/tag/v0.6.0
 [0.5.0]: https://github.com/int-brain-lab/iblqt/releases/tag/v0.5.0
 [0.4.4]: https://github.com/int-brain-lab/iblqt/releases/tag/v0.4.4

docs/source/conf.py

@@ -25,6 +25,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.viewcode',
+    'sphinx_copybutton',
     'sphinx_design',
     'sphinx_qt_documentation',
     'myst_parser',
@@ -83,3 +84,5 @@
 napoleon_preprocess_types = True
 napoleon_type_aliases = None
 napoleon_attr_annotations = True
+
+copybutton_exclude = '.linenos, .gp'

docs/source/dev_guide.rst

@@ -31,12 +31,34 @@ Installing developer dependencies
 To set up your development environment, you need to install the necessary
 dependencies. The following command will synchronize your environment with the
 dependencies specified in the ``pyproject.toml`` file, including development
-dependencies and PyQt6:
+dependencies and Qt:
 
-.. code-block:: console
+.. tab-set::
+
+   .. tab-item:: PyQt5
+
+      .. code-block:: console
+
+         $ uv sync --extra pyqt5
+
+   .. tab-item:: PyQt6
+
+      .. code-block:: console
+
+         $ uv sync --extra pyqt6
+
+   .. tab-item:: PySide6
+
+      .. code-block:: console
+
+         $ uv sync --extra pyside6
+
+The virtualenv will default to Python 3.13 unless you specify another version of the
+interpreter, for instance:
 
-   $ uv sync --extra pyqt6
+   .. code-block:: console
 
+      $ uv sync --extra pyside6 --python 3.10
 
 Running the unit-tests
 ----------------------

iblqt/__init__.py

@@ -1,3 +1,3 @@
 """A collection of extensions to the Qt framework."""
 
-__version__ = '0.6.0'
+__version__ = '0.6.1'

iblqt/widgets.py

@@ -662,6 +662,8 @@ def __init__(
         self,
         url: QUrl | str,
         trusted_url_prefix: str | None = None,
+        use_tool_tips: bool = True,
+        use_status_tips: bool = False,
         parent: QWidget | None = None,
     ):
         """
@@ -675,6 +677,10 @@ def __init__(
             Prefix of trusted URLs. Clicking on links to matching URLs will open
             in the widget's web engine view, while other links will open in the default
             web browser. Defaults to the value of `url`.
+        use_tool_tips : bool, optional
+            Whether to set default tool tips for the buttons. Default is True.
+        use_status_tips : bool, optional
+            Whether to set default status tips for the buttons. Default is False.
         parent : QWidget or None, optional
             The parent widget.
         """
@@ -734,6 +740,18 @@ def __init__(
         )
         self.webEngineView.urlChanged.connect(self._on_url_changed)
 
+        # set tool tips / status tips
+        if use_tool_tips:
+            self.uiPushHome.setToolTip('Go to home page')
+            self.uiPushBack.setToolTip('Go back one page')
+            self.uiPushForward.setToolTip('Go forward one page')
+            self.uiPushBrowser.setToolTip('Open page in default browser')
+        if use_status_tips:
+            self.uiPushHome.setStatusTip('Go to home page')
+            self.uiPushBack.setStatusTip('Go back one page')
+            self.uiPushForward.setStatusTip('Go forward one page')
+            self.uiPushBrowser.setStatusTip('Open page in default browser')
+
         # set prefix and initial URL
         self.setUrl(url)
 

pyproject.toml

@@ -53,6 +53,7 @@ doc = [
   "sphinx-qt-documentation>=0.4.1",
   "sphinx-rtd-theme>=2.0.0",
   "sphinx-design>=0.6.1",
+  "sphinx-copybutton>=0.5.2",
 ]
 lint = [
   "ruff>=0.9.2",

tests/test_widgets.py

@@ -389,15 +389,31 @@ def test_threshold_cross_signal_emitted(self, qtbot, monkeypatch):
 )  # TODO
 class TestRestrictedWebView:
     @pytest.fixture
-    def browser_widget(self, qtbot):
-        widget = widgets.RestrictedWebView(
+    def browser_widget_factory(self, qtbot):
+        created_widgets = []
+
+        def _browser_widget(*args, **kwargs):
+            widget = widgets.RestrictedWebView(*args, **kwargs)
+            created_widgets.append(widget)
+            qtbot.addWidget(widget)
+            return widget
+
+        yield _browser_widget
+
+        for widget in created_widgets:
+            try:
+                page = widget.webEngineView.page()
+            except RuntimeError:
+                continue
+            with qtbot.waitSignal(page.destroyed):
+                widget.close()
+
+    @pytest.fixture
+    def browser_widget(self, qtbot, browser_widget_factory):
+        yield browser_widget_factory(
             url=QUrl('http://localhost/trusted/start'),
             trusted_url_prefix='http://localhost/trusted/',
         )
-        qtbot.addWidget(widget)
-        yield widget
-        with qtbot.waitSignal(widget.webEngineView.page().destroyed, timeout=100):
-            widget.close()
 
     def test_default_prefix(self, qtbot):
         widget = widgets.RestrictedWebView(url='http://localhost/')
@@ -416,6 +432,7 @@ def test_get_set_url(self, qtbot, browser_widget):
         assert not browser_widget.setUrl('http://localhost/external/page')
         assert browser_widget.url() == QUrl('http://localhost/trusted/other')
 
+    @pytest.mark.xfail(sys.platform == 'win32', reason='Tends to fail on Windows')
     def test_home_button_loads_home(self, qtbot, browser_widget):
         browser_widget.setUrl('http://localhost/trusted/other')
         with qtbot.waitSignal(browser_widget.webEngineView.urlChanged):
@@ -457,3 +474,18 @@ def test_change_prefix(self, mock_open, qtbot, browser_widget):
         )
         assert result is True
         mock_open.assert_not_called()
+
+    def test_tool_and_status_tips(self, qtbot, browser_widget_factory):
+        widget = browser_widget_factory('http://localhost/')
+        assert len(widget.uiPushHome.toolTip()) > 0
+        assert len(widget.uiPushHome.statusTip()) == 0
+        widget = browser_widget_factory(
+            'http://localhost/', use_tool_tips=False, use_status_tips=True
+        )
+        assert len(widget.uiPushHome.toolTip()) == 0
+        assert len(widget.uiPushHome.statusTip()) > 0
+        widget = browser_widget_factory(
+            'http://localhost/', use_tool_tips=True, use_status_tips=False
+        )
+        assert len(widget.uiPushHome.toolTip()) > 0
+        assert len(widget.uiPushHome.statusTip()) == 0