Remove the JPEGs used for visual inspection in regression tests

Signed-off-by: Tomas Pereira de Vasconcelos <tomasvasconcelos1@gmail.com>

Author: tpvasconcelos

MANIFEST.in

@@ -39,7 +39,7 @@ recursive-include cicd_utils README.md *.py *.sh
 recursive-include misc *.py *.ipynb *.txt *.png
 recursive-include requirements *.txt
 recursive-include tests *.py
-recursive-include tests/e2e/artifacts *.jpeg *.json
+recursive-include tests/e2e/artifacts *.json
 
 # Globally excluded patterns
 recursive-exclude * *.py[cod] *.egg-info __pycache__ .ipynb_checkpoints/*

cicd_utils/ridgeplot_examples/_base.py

@@ -71,12 +71,11 @@ class Example:
     def __post_init__(self) -> None:
         self.fig = self.figure_factory()  # pyright: ignore[reportUninitializedInstanceVariable]
 
-        # All example figures must set the layout's width to 800 and
-        # explicitly declare the layout's height to a concrete value
+        # Both `width` and `height` should be set in all example plots
         if self.fig.layout.width != 800:
             raise ValueError("All figures must have width 800")
-        if self.fig.layout.height is None:
-            raise ValueError("All figures must have an explicit height declared")
+        if not isinstance(self.fig.layout.height, int):
+            raise ValueError("All figures must have an explicit height declared")  # noqa: TRY004
 
         round_fig_data(self.fig, sig_figs=8)
 
@@ -146,6 +145,8 @@ def write_webp(self, path: Path) -> None:
             engine="kaleido",
         )
 
+    # This method isn't used anywhere anymore but
+    # will be kept here for potential future use
     def write_jpeg(self, path: Path) -> None:
         fig = deepcopy(self.fig)
         fig = tighten_margins(fig, px=40)

docs/reference/changelog.md

@@ -20,6 +20,7 @@ Unreleased changes
 
 ### CI/CD
 
+- Remove the JPEGs used for visual inspection in regression tests ({gh-pr}`364`)
 - Upgrade ruff's target Python version to 3.10 ({gh-pr}`363`)
 - Bump sigstore/gh-action-sigstore-python from 3.1.0 to 3.2.0 ({gh-pr}`359`)
 - Bump actions/download-artifact from 5 to 6 ({gh-pr}`354`)

tests/e2e/artifacts/basic.jpeg

@@ -18,13 +18,6 @@ def test_paths_exist() -> None:
     assert PATH_CHARTS.is_dir()
 
 
-@pytest.mark.parametrize("example", ALL_EXAMPLES, ids=lambda e: e.plot_id)
-def test_examples_width_height_set(example: Example) -> None:
-    msg = "Both `width` and `height` should be set in all example plots."
-    assert isinstance(example.fig.layout.width, int), msg
-    assert isinstance(example.fig.layout.height, int), msg
-
-
 @pytest.mark.parametrize("example", ALL_EXAMPLES, ids=lambda e: e.plot_id)
 def test_json_regressions(example: Example) -> None:
     expected = (PATH_ARTIFACTS / f"{example.plot_id}.json").read_text()
@@ -46,10 +39,6 @@ def _update_all_artifacts() -> None:
         print(f"Updating artifacts for: {example.plot_id!r}")  # noqa: T201
         # Save JSONs for regression tests
         example.write_json(PATH_ARTIFACTS)
-        # We also save JPEGs for visual inspection (e.g., in PRs)
-        # (Don't use JPEGs for regression tests because outputs
-        #  will vary between Plotly versions and platforms)
-        example.write_jpeg(PATH_ARTIFACTS)
         # Just to keep things in sync with the docs, we should also
         # regenerate the WebP images used there. These are tracked
         # by Git because some are used in the README (which needs