Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e7bfa99

Browse files
timhoffmmeeseeksmachine
timhoffm
authored and
meeseeksmachine
committed
Backport PR #29872: TST: Use placeholders for text in layout tests
1 parent 6c394db commit e7bfa99

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+2809
-9112
lines changed

‎doc/devel/testing.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,9 +161,10 @@ the tests, they should now pass.
161161

162162
It is preferred that new tests use ``style='mpl20'`` as this leads to smaller
163163
figures and reflects the newer look of default Matplotlib plots. Also, if the
164-
texts (labels, tick labels, etc) are not really part of what is tested, use
165-
``remove_text=True`` as this will lead to smaller figures and reduce possible
166-
issues with font mismatch on different platforms.
164+
texts (labels, tick labels, etc) are not really part of what is tested, use the
165+
``remove_text=True`` argument or add the ``text_placeholders`` fixture as this
166+
will lead to smaller figures and reduce possible issues with font mismatch on
167+
different platforms.
167168

168169

169170
Compare two methods of creating an image

‎lib/matplotlib/testing/conftest.py

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,3 +125,54 @@ def test_imshow_xarray(xr):
125125

126126
xr = pytest.importorskip('xarray')
127127
return xr
128+
129+
130+
@pytest.fixture
131+
def text_placeholders(monkeypatch):
132+
"""
133+
Replace texts with placeholder rectangles.
134+
135+
The rectangle size only depends on the font size and the number of characters. It is
136+
thus insensitive to font properties and rendering details. This should be used for
137+
tests that depend on text geometries but not the actual text rendering, e.g. layout
138+
tests.
139+
"""
140+
from matplotlib.patches import Rectangle
141+
142+
def patched_get_text_metrics_with_cache(renderer, text, fontprop, ismath, dpi):
143+
"""
144+
Replace ``_get_text_metrics_with_cache`` with fixed results.
145+
146+
The usual ``renderer.get_text_width_height_descent`` would depend on font
147+
metrics; instead the fixed results are based on font size and the length of the
148+
string only.
149+
"""
150+
# While get_window_extent returns pixels and font size is in points, font size
151+
# includes ascenders and descenders. Leaving out this factor and setting
152+
# descent=0 ends up with a box that is relatively close to DejaVu Sans.
153+
height = fontprop.get_size()
154+
width = len(text) * height / 1.618 # Golden ratio for character size.
155+
descent = 0
156+
return width, height, descent
157+
158+
def patched_text_draw(self, renderer):
159+
"""
160+
Replace ``Text.draw`` with a fixed bounding box Rectangle.
161+
162+
The bounding box corresponds to ``Text.get_window_extent``, which ultimately
163+
depends on the above patched ``_get_text_metrics_with_cache``.
164+
"""
165+
if renderer is not None:
166+
self._renderer = renderer
167+
if not self.get_visible():
168+
return
169+
if self.get_text() == '':
170+
return
171+
bbox = self.get_window_extent()
172+
rect = Rectangle(bbox.p0, bbox.width, bbox.height,
173+
facecolor=self.get_color(), edgecolor='none')
174+
rect.draw(renderer)
175+
176+
monkeypatch.setattr('matplotlib.text._get_text_metrics_with_cache',
177+
patched_get_text_metrics_with_cache)
178+
monkeypatch.setattr('matplotlib.text.Text.draw', patched_text_draw)

‎lib/matplotlib/testing/conftest.pyi

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@ def mpl_test_settings(request: pytest.FixtureRequest) -> None: ...
1010
def pd() -> ModuleType: ...
1111
@pytest.fixture
1212
def xr() -> ModuleType: ...
13+
@pytest.fixture
14+
def text_placeholders(monkeypatch: pytest.MonkeyPatch) -> None: ...

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout1.png

-17.9 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout10.png

-18.7 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout11.png

-20.3 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout11rat.png

-20 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout12.png

-27.9 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout13.png

-27.4 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout14.png

-25.7 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout15.png

-20.7 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout16.png

-18 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout17.png

-24.8 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout2.png

-27.5 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout3.png

-32.5 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout4.png

-30 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout5.png

-28.3 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout6.png

-27.5 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout8.png

-23.5 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/constrained_layout9.png

-23.8 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/test_colorbars_no_overlapH.png

-2.41 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_constrainedlayout/test_colorbars_no_overlapV.png

-3.56 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_table/table_cell_manipulation.png

-6.31 KB
Loading

‎lib/matplotlib/tests/baseline_images/test_tightlayout/tight_layout1.pdf

-5.35 KB
Binary file not shown.

‎lib/matplotlib/tests/baseline_images/test_tightlayout/tight_layout1.png

-18.4 KB
Loading

0 commit comments

Comments
 (0)