Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Implemented fallback save behavior for `pytest --show_diff` (#2981)

Benjamin Hackl0835d4b39e00
diff --git a/manim/utils/testing/_frames_testers.py b/manim/utils/testing/_frames_testers.py
index 0496583c1..7c7fa4678 100644
--- a/manim/utils/testing/_frames_testers.py
+++ b/manim/utils/testing/_frames_testers.py
@@ -49,7 +49,12 @@ class _FramesTester:
self._frames_compared += 1
except AssertionError as e:
if self._show_diff:
- show_diff_helper(frame_number, frame, self._frames[frame_number])
+ show_diff_helper(
+ frame_number,
+ frame,
+ self._frames[frame_number],
+ self._file_path.name,
+ )
raise e
diff --git a/manim/utils/testing/_show_diff.py b/manim/utils/testing/_show_diff.py
index 0e80295ef..0cb2aab0f 100644
--- a/manim/utils/testing/_show_diff.py
+++ b/manim/utils/testing/_show_diff.py
@@ -1,5 +1,8 @@
from __future__ import annotations
+import logging
+import warnings
+
import numpy as np
@@ -7,6 +10,7 @@ def show_diff_helper(
frame_number: int,
frame_data: np.ndarray,
expected_frame_data: np.ndarray,
+ control_data_filename: str,
):
"""Will visually display with matplotlib differences between frame generated and the one expected."""
import matplotlib.gridspec as gridspec
@@ -18,11 +22,11 @@ def show_diff_helper(
ax = fig.add_subplot(gs[0, 0])
ax.imshow(frame_data)
- ax.set_title("Generated :")
+ ax.set_title("Generated")
ax = fig.add_subplot(gs[0, 1])
ax.imshow(expected_frame_data)
- ax.set_title("Expected :")
+ ax.set_title("Expected")
ax = fig.add_subplot(gs[1, :])
diff_im = expected_frame_data.copy()
@@ -37,6 +41,16 @@ def show_diff_helper(
np.array([255, 0, 0, 255], dtype="uint8"),
) # Set any different pixels to red
ax.imshow(diff_im, interpolation="nearest")
- ax.set_title("Differences summary : (green = same, red = different)")
-
- plt.show()
+ ax.set_title("Difference summary: (green = same, red = different)")
+
+ with warnings.catch_warnings():
+ warnings.simplefilter("error")
+ try:
+ plt.show()
+ except UserWarning:
+ filename = f"{control_data_filename[:-4]}-diff.pdf"
+ plt.savefig(filename)
+ logging.warning(
+ "Interactive matplotlib interface not available,"
+ f" diff saved to {filename}."
+ )