ENH: Cleaner forward solution plotting options (#13313)

Author: larsoner

azure-pipelines.yml

@@ -198,15 +198,15 @@ stages:
               set -eo pipefail
               mne sys_info -pd
               mne sys_info -pd | grep "qtpy .* (PyQt6=.*)$"
-              PYTEST_QT_API=PyQt6 pytest ${TEST_OPTIONS}
+              PYTEST_QT_API=PyQt6 pytest -m "not ultraslowtest" ${TEST_OPTIONS}
               python -m pip uninstall -yq PyQt6 PyQt6-sip PyQt6-Qt6
             displayName: 'PyQt6'
           - bash: |
               set -eo pipefail
               python -m pip install "PySide6!=6.8.0,!=6.8.0.1,!=6.9.1"
               mne sys_info -pd
               mne sys_info -pd | grep "qtpy .* (PySide6=.*)$"
-              PYTEST_QT_API=PySide6 pytest ${TEST_OPTIONS}
+              PYTEST_QT_API=PySide6 pytest -m "not ultraslowtest" ${TEST_OPTIONS}
               python -m pip uninstall -yq PySide6
             displayName: 'PySide6'
           # PyQt5 leaves cruft behind, so run it last
@@ -215,7 +215,7 @@ stages:
               python -m pip install PyQt5
               mne sys_info -pd
               mne sys_info -pd | grep "qtpy .* (PyQt5=.*)$"
-              PYTEST_QT_API=PyQt5 pytest ${TEST_OPTIONS}
+              PYTEST_QT_API=PyQt5 pytest -m "not ultraslowtest" ${TEST_OPTIONS}
               python -m pip uninstall -yq PyQt5 PyQt5-sip PyQt5-Qt5
             displayName: 'PyQt5'
           # Coverage

mne/_fiff/tests/test_constants.py

@@ -10,6 +10,7 @@
 import numpy as np
 import pooch
 import pytest
+from flaky import flaky
 
 from mne._fiff.constants import (
     FIFF,
@@ -117,7 +118,9 @@
 )
 
 
+@flaky
 @requires_good_network
+@pytest.mark.ultraslowtest  # not that slow, just doesn't need to run very often
 def test_constants(tmp_path):
     """Test compensation."""
     fname = "fiff.zip"

mne/bem.py

@@ -1019,7 +1019,7 @@ def get_fitting_dig(info, dig_kinds="auto", exclude_frontal=True, verbose=None):
     .. versionadded:: 0.14
     """
     _validate_type(info, "info")
-    if info["dig"] is None:
+    if info.get("dig", None) is None:  # "dig" can be missing for fwd/inv
         raise RuntimeError(
             'Cannot fit headshape without digitization, info["dig"] is None'
         )

mne/conftest.py

@@ -84,12 +84,13 @@
 def pytest_configure(config: pytest.Config):
     """Configure pytest options."""
     # Markers
+    # can be queried with `pytest --markers` for example
     for marker in (
-        "slowtest",
-        "ultraslowtest",
-        "pgtest",
-        "pvtest",
-        "allow_unclosed",
+        "slowtest: mark a test as slow",
+        "ultraslowtest: mark a test as ultraslow or to be run rarely",
+        "pgtest: mark a test as relevant for mne-qt-browser",
+        "pvtest: mark a test as relevant for pyvistaqt",
+        "allow_unclosed: allow unclosed pyvistaqt instances",
     ):
         config.addinivalue_line("markers", marker)
 
@@ -203,6 +204,13 @@ def pytest_configure(config: pytest.Config):
             config.addinivalue_line("filterwarnings", warning_line)
 
 
+def pytest_collection_modifyitems(items: list[pytest.Item]):
+    """Add slowtest marker automatically to anything marked ultraslow."""
+    for item in items:
+        if len(list(item.iter_markers("ultraslowtest"))):
+            item.add_marker(pytest.mark.slowtest)
+
+
 # Have to be careful with autouse=True, but this is just an int comparison
 # so it shouldn't really add appreciable overhead
 @pytest.fixture(autouse=True)
@@ -1197,7 +1205,8 @@ def pytest_runtest_makereport(item, call):
     outcome = yield
     rep: pytest.TestReport = outcome.get_result()
     item.stash.setdefault(_phase_report_key, {})[rep.when] = rep
-    _modify_report_skips(rep)
+    if rep.outcome == "passed":  # only check for skips etc. if otherwise green
+        _modify_report_skips(rep)
     return rep
 
 

mne/datasets/tests/test_datasets.py

@@ -175,7 +175,7 @@ def _error_download_2(self, fname, downloader, processor):
 
 
 @flaky(max_runs=3)
-@pytest.mark.slowtest
+@pytest.mark.ultraslowtest  # not really ultraslow, but flakes out a lot
 @testing.requires_testing_data
 @requires_good_network
 def test_fetch_parcellations(tmp_path):

mne/html_templates/report/forward.html.jinja

@@ -2,4 +2,5 @@
 {% block html_content %}
 {{repr | safe}}
 {{sensitivity_maps | safe}}
+{{source_space | safe}}
 {% endblock html_content %}

mne/html_templates/report/image.html.jinja

@@ -1,4 +1,6 @@
+{% if not embedded %}
 {% extends "section.html.jinja" %}
+{% endif %}
 {% block html_content %}
       <figure class="figure mx-auto d-block">
         {% if image_format == 'svg' %}

mne/preprocessing/tests/test_fine_cal.py

@@ -88,8 +88,8 @@ def test_compute_fine_cal(kind):
         angle_limit = 10
         cl["grad"] = (0.0, 0.1)
         gwoma = [48, 52]
-        ggoma = [13, 67]
-        ggwma = [13, 120]
+        ggoma = [13, 82]
+        ggwma = [13, 135]
         sfs = [34, 35, 27, 28, 50, 53, 75, 79]  # ours is better!
         cl3 = [-0.3, -0.1]
     raw = read_raw_fif(erm)