Update plots before scraping

.github/workflows/testing-and-deployment.yml

@@ -166,6 +166,11 @@ jobs:
           restore-keys: |
             Examples-1-
 
+      - name: Setup xvfb dependencies
+        run: |
+          git clone --depth=1 https://github.com/mne-tools/mne-python.git --branch main --single-branch
+          ./mne-python/tools/setup_xvfb.sh
+
       - name: Build wheel and install pyvista
         run: |
           pip install build

pyvista/plotting/utilities/sphinx_gallery.py

@@ -53,6 +53,14 @@ def html_rst(
     return images_rst
 
 
+def _process_events_before_scraping(plotter):
+    """Process events such as changing the camera or object before scraping."""
+    if plotter.iren is not None and plotter.iren.initialized:
+        plotter.update()
+        if hasattr(plotter, "app") and plotter.app is not None:
+            plotter.app.processEvents()
+
+
 class Scraper:
     """
     Save ``pyvista.Plotter`` objects.
@@ -84,7 +92,8 @@ def __call__(self, block, block_vars, gallery_conf):
         image_names = list()
         image_path_iterator = block_vars["image_path_iterator"]
         figures = pyvista.plotting.plotter._ALL_PLOTTERS
-        for _, plotter in figures.items():
+        for plotter in figures.values():
+            _process_events_before_scraping(plotter)
             fname = next(image_path_iterator)
             if hasattr(plotter, "_gif_filename"):
                 # move gif to fname
@@ -97,7 +106,7 @@ def __call__(self, block, block_vars, gallery_conf):
         return figure_rst(image_names, gallery_conf["src_dir"])
 
 
-class DynamicScraper:
+class DynamicScraper:  # pragma: no cover
     """
     Save ``pyvista.Plotter`` objects dynamically.
 
@@ -110,6 +119,10 @@ class DynamicScraper:
 
     """
 
+    def __repr__(self):
+        """Return a stable representation of the class instance."""
+        return f"<{type(self).__name__} object>"
+
     def __call__(self, block, block_vars, gallery_conf):
         """Save the figures generated after running example code.
 
@@ -122,7 +135,8 @@ def __call__(self, block, block_vars, gallery_conf):
         image_names = list()
         image_path_iterator = block_vars["image_path_iterator"]
         figures = pyvista.plotting.plotter._ALL_PLOTTERS
-        for _, plotter in figures.items():
+        for plotter in figures.values():
+            _process_events_before_scraping(plotter)
             fname = next(image_path_iterator)
             # if hasattr(plotter, '_gif_filename'):
             #     raise RuntimeError('GIFs are not supported with DynamicScraper.')

requirements_test.txt

@@ -12,11 +12,14 @@ meshio<5.4.0
 nest_asyncio<1.5.9
 numpydoc==1.6.0
 param<2.1.0
+PyQt6!=6.6.1,<6.7.0
+PyQt6-Qt6!=6.6.1,<6.7.0
 pytest<7.5.0
 pytest-cov<4.2.0
 pytest-memprof<0.3.0
 pytest-xdist<3.4.0
 pytest_pyvista==0.1.8
+qtpy<2.5.0
 Sphinx<7.2.0
 sphinx-gallery<0.15.0
 sympy<1.13.0

tests/plotting/test_scraper.py

@@ -1,7 +1,9 @@
 import os
 import os.path as op
 
+from matplotlib.pyplot import imread
 import pytest
+from qtpy.QtWidgets import QApplication
 
 import pyvista as pv
 from pyvista.plotting.utilities.sphinx_gallery import Scraper
@@ -10,6 +12,54 @@
 pytestmark = pytest.mark.skip_plotting
 
 
+def test_scraper_with_app(tmpdir, monkeypatch, n_win=2):
+    pytest.importorskip('sphinx_gallery')
+    monkeypatch.setattr(pv, 'BUILDING_GALLERY', True)
+    pv.close_all()
+
+    scraper = Scraper()
+
+    plotters = [pv.Plotter(off_screen=True) for _ in range(n_win)]
+
+    # add cone, change view to test that it takes effect
+    plotters[0].iren.initialize()
+    plotters[0].app = QApplication([])
+    plotters[0].add_mesh(pv.Cone())
+    plotters[0].camera_position = 'xy'
+
+    plotters[1].add_mesh(pv.Cone())
+
+    src_dir = str(tmpdir)
+    out_dir = op.join(str(tmpdir), '_build', 'html')
+    img_fnames = [
+        op.join(src_dir, 'auto_examples', 'images', f'sg_img_{n}.png') for n in range(n_win)
+    ]
+
+    gallery_conf = {"src_dir": src_dir, "builder_name": "html"}
+    target_file = op.join(src_dir, 'auto_examples', 'sg.py')
+    block = None
+    block_vars = dict(
+        image_path_iterator=iter(img_fnames),
+        example_globals=dict(a=1),
+        target_file=target_file,
+    )
+
+    os.makedirs(op.dirname(img_fnames[0]))
+    for img_fname in img_fnames:
+        assert not os.path.isfile(img_fname)
+
+    os.makedirs(out_dir)
+    scraper(block, block_vars, gallery_conf)
+    for img_fname in img_fnames:
+        assert os.path.isfile(img_fname)
+
+    # test that the plot has the camera position updated with a checksum when the Plotter has an app instance
+    assert imread(img_fnames[0]).sum() != imread(img_fnames[1]).sum()
+
+    for plotter in plotters:
+        plotter.close()
+
+
 @pytest.mark.parametrize('n_win', [1, 2])
 def test_scraper(tmpdir, monkeypatch, n_win):
     pytest.importorskip('sphinx_gallery')