{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathtesting_api.html
More file actions
417 lines (381 loc) · 31.2 KB
/
Copy pathtesting_api.html
File metadata and controls
417 lines (381 loc) · 31.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>matplotlib.testing — Matplotlib 3.3.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.1-2-ge49322daa" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.3.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="matplotlib.text" href="text_api.html" />
<link rel="prev" title="matplotlib.table" href="table_api.html" />
<link rel="top" title="Matplotlib 3.3.1 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/testing_api.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.1). For the latest version see <a href="https://matplotlib.org/stable/api/testing_api.html">https://matplotlib.org/stable/api/testing_api.html</a></div>
<!--
<div id="annc-banner">
</div>
-->
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.3.1</span></div>
<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="text_api.html" title="matplotlib.text"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="table_api.html" title="matplotlib.table"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.testing</span></code></a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">matplotlib.testing</span></code></a><ul>
<li><a class="reference internal" href="#id1"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing</span></code></a></li>
<li><a class="reference internal" href="#module-matplotlib.testing.compare"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing.compare</span></code></a></li>
<li><a class="reference internal" href="#module-matplotlib.testing.decorators"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing.decorators</span></code></a></li>
<li><a class="reference internal" href="#module-matplotlib.testing.exceptions"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing.exceptions</span></code></a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="table_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.table</span></code></a></li>
<li>Next: <a href="text_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.text</span></code></a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/testing_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="matplotlib-testing">
<h1><code class="docutils literal notranslate"><span class="pre">matplotlib.testing</span></code><a class="headerlink" href="#matplotlib-testing" title="Permalink to this headline">¶</a></h1>
<div class="section" id="id1">
<h2><a class="reference internal" href="#module-matplotlib.testing" title="matplotlib.testing"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing</span></code></a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<span class="target" id="module-matplotlib.testing"></span><p>Helper functions for testing.</p>
<dl class="py function">
<dt id="matplotlib.testing.is_called_from_pytest">
<code class="descclassname">matplotlib.testing.</code><code class="descname">is_called_from_pytest</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing.html#is_called_from_pytest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.is_called_from_pytest" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>] Whether we are in a pytest run.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.2.</span></p>
</div>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.testing.set_font_settings_for_testing">
<code class="descclassname">matplotlib.testing.</code><code class="descname">set_font_settings_for_testing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing.html#set_font_settings_for_testing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.set_font_settings_for_testing" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="matplotlib.testing.set_reproducibility_for_testing">
<code class="descclassname">matplotlib.testing.</code><code class="descname">set_reproducibility_for_testing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing.html#set_reproducibility_for_testing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.set_reproducibility_for_testing" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="matplotlib.testing.setup">
<code class="descclassname">matplotlib.testing.</code><code class="descname">setup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing.html#setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.setup" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="module-matplotlib.testing.compare">
<span id="matplotlib-testing-compare"></span><h2><a class="reference internal" href="#module-matplotlib.testing.compare" title="matplotlib.testing.compare"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing.compare</span></code></a><a class="headerlink" href="#module-matplotlib.testing.compare" title="Permalink to this headline">¶</a></h2>
<p>Utilities for comparing image results.</p>
<dl class="py function">
<dt id="matplotlib.testing.compare.comparable_formats">
<code class="descclassname">matplotlib.testing.compare.</code><code class="descname">comparable_formats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing/compare.html#comparable_formats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.compare.comparable_formats" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the list of file formats that <a class="reference internal" href="#matplotlib.testing.compare.compare_images" title="matplotlib.testing.compare.compare_images"><code class="xref py py-obj docutils literal notranslate"><span class="pre">compare_images</span></code></a> can compare
on this system.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>list of str</dt><dd><p>E.g. <code class="docutils literal notranslate"><span class="pre">['png',</span> <span class="pre">'pdf',</span> <span class="pre">'svg',</span> <span class="pre">'eps']</span></code>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.testing.compare.compare_images">
<code class="descclassname">matplotlib.testing.compare.</code><code class="descname">compare_images</code><span class="sig-paren">(</span><em><span class="n">expected</span></em>, <em><span class="n">actual</span></em>, <em><span class="n">tol</span></em>, <em><span class="n">in_decorator</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing/compare.html#compare_images"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.compare.compare_images" title="Permalink to this definition">¶</a></dt>
<dd><p>Compare two "image" files checking differences within a tolerance.</p>
<p>The two given filenames may point to files which are convertible to
PNG via the <code class="xref py py-obj docutils literal notranslate"><span class="pre">converter</span></code> dictionary. The underlying RMS is calculated
with the <code class="xref py py-obj docutils literal notranslate"><span class="pre">calculate_rms</span></code> function.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>expected</strong><span class="classifier">str</span></dt><dd><p>The filename of the expected image.</p>
</dd>
<dt><strong>actual</strong><span class="classifier">str</span></dt><dd><p>The filename of the actual image.</p>
</dd>
<dt><strong>tol</strong><span class="classifier">float</span></dt><dd><p>The tolerance (a color value difference, where 255 is the
maximal difference). The test fails if the average pixel
difference is greater than this value.</p>
</dd>
<dt><strong>in_decorator</strong><span class="classifier">bool</span></dt><dd><p>Determines the output format. If called from image_comparison
decorator, this should be True. (default=False)</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>None or dict or str</dt><dd><p>Return <em>None</em> if the images are equal within the given tolerance.</p>
<p>If the images differ, the return value depends on <em>in_decorator</em>.
If <em>in_decorator</em> is true, a dict with the following entries is
returned:</p>
<ul class="simple">
<li><em>rms</em>: The RMS of the image difference.</li>
<li><em>expected</em>: The filename of the expected image.</li>
<li><em>actual</em>: The filename of the actual image.</li>
<li><em>diff_image</em>: The filename of the difference image.</li>
<li><em>tol</em>: The comparison tolerance.</li>
</ul>
<p>Otherwise, a human-readable multi-line string representation of this
information is returned.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">img1</span> <span class="o">=</span> <span class="s2">"./baseline/plot.png"</span>
<span class="n">img2</span> <span class="o">=</span> <span class="s2">"./output/plot.png"</span>
<span class="n">compare_images</span><span class="p">(</span><span class="n">img1</span><span class="p">,</span> <span class="n">img2</span><span class="p">,</span> <span class="mf">0.001</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="module-matplotlib.testing.decorators">
<span id="matplotlib-testing-decorators"></span><h2><a class="reference internal" href="#module-matplotlib.testing.decorators" title="matplotlib.testing.decorators"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing.decorators</span></code></a><a class="headerlink" href="#module-matplotlib.testing.decorators" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="matplotlib.testing.decorators.CleanupTestCase">
<em class="property">class </em><code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">CleanupTestCase</code><span class="sig-paren">(</span><em><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#CleanupTestCase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.decorators.CleanupTestCase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">unittest.case.TestCase</span></code></p>
<p>A wrapper for unittest.TestCase that includes cleanup operations.</p>
<p>Create an instance of the class that will use the named test
method when executed. Raises a ValueError if the instance does
not have a method with the specified name.</p>
<dl class="py method">
<dt id="matplotlib.testing.decorators.CleanupTestCase.setUpClass">
<em class="property">classmethod </em><code class="descname">setUpClass</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#CleanupTestCase.setUpClass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.decorators.CleanupTestCase.setUpClass" title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method for setting up class fixture before running tests in the class.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.testing.decorators.CleanupTestCase.tearDownClass">
<em class="property">classmethod </em><code class="descname">tearDownClass</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#CleanupTestCase.tearDownClass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.decorators.CleanupTestCase.tearDownClass" title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method for deconstructing the class fixture after running all tests in the class.</p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.testing.decorators.check_figures_equal">
<code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">check_figures_equal</code><span class="sig-paren">(</span><em><span class="o">*</span></em>, <em><span class="n">extensions</span><span class="o">=</span><span class="default_value">'png', 'pdf', 'svg'</span></em>, <em><span class="n">tol</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#check_figures_equal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.decorators.check_figures_equal" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator for test cases that generate and compare two figures.</p>
<p>The decorated function must take two keyword arguments, <em>fig_test</em>
and <em>fig_ref</em>, and draw the test and reference images on them.
After the function returns, the figures are saved and compared.</p>
<p>This decorator should be preferred over <a class="reference internal" href="#matplotlib.testing.decorators.image_comparison" title="matplotlib.testing.decorators.image_comparison"><code class="xref py py-obj docutils literal notranslate"><span class="pre">image_comparison</span></code></a> when possible in
order to keep the size of the test suite from ballooning.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>extensions</strong><span class="classifier">list, default: ["png", "pdf", "svg"]</span></dt><dd><p>The extensions to test.</p>
</dd>
<dt><strong>tol</strong><span class="classifier">float</span></dt><dd><p>The RMS threshold above which the test is considered failed.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<p>Check that calling <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.plot.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.plot</span></code></a> with a single argument plots it against
<code class="docutils literal notranslate"><span class="pre">[0,</span> <span class="pre">1,</span> <span class="pre">2,</span> <span class="pre">...]</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@check_figures_equal</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">test_plot</span><span class="p">(</span><span class="n">fig_test</span><span class="p">,</span> <span class="n">fig_ref</span><span class="p">):</span>
<span class="n">fig_test</span><span class="o">.</span><span class="n">subplots</span><span class="p">()</span><span class="o">.</span><span class="n">plot</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">5</span><span class="p">])</span>
<span class="n">fig_ref</span><span class="o">.</span><span class="n">subplots</span><span class="p">()</span><span class="o">.</span><span class="n">plot</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">5</span><span class="p">])</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.testing.decorators.check_freetype_version">
<code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">check_freetype_version</code><span class="sig-paren">(</span><em><span class="n">ver</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#check_freetype_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.decorators.check_freetype_version" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="matplotlib.testing.decorators.cleanup">
<code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">cleanup</code><span class="sig-paren">(</span><em><span class="n">style</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.decorators.cleanup" title="Permalink to this definition">¶</a></dt>
<dd><p>A decorator to ensure that any global state is reset before
running a test.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>style</strong><span class="classifier">str, dict, or list, optional</span></dt><dd><p>The style(s) to apply. Defaults to <code class="docutils literal notranslate"><span class="pre">["classic",</span>
<span class="pre">"_classic_test_patch"]</span></code>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.testing.decorators.image_comparison">
<code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">image_comparison</code><span class="sig-paren">(</span><em><span class="n">baseline_images</span></em>, <em><span class="n">extensions</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">tol</span><span class="o">=</span><span class="default_value">0</span></em>, <em><span class="n">freetype_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">remove_text</span><span class="o">=</span><span class="default_value">False</span></em>, <em><span class="n">savefig_kwarg</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">style</span><span class="o">=</span><span class="default_value">'classic', '_classic_test_patch'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#image_comparison"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.decorators.image_comparison" title="Permalink to this definition">¶</a></dt>
<dd><p>Compare images generated by the test with those specified in
<em>baseline_images</em>, which must correspond, else an <code class="xref py py-obj docutils literal notranslate"><span class="pre">ImageComparisonFailure</span></code>
exception will be raised.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>baseline_images</strong><span class="classifier">list or None</span></dt><dd><p>A list of strings specifying the names of the images generated by
calls to <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.savefig" title="matplotlib.figure.Figure.savefig"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.savefig</span></code></a>.</p>
<p>If <em>None</em>, the test function must use the <code class="docutils literal notranslate"><span class="pre">baseline_images</span></code> fixture,
either as a parameter or with <a class="reference external" href="https://pytest.org/en/stable/reference.html#pytest.mark.usefixtures" title="(in pytest v6.0.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pytest.mark.usefixtures</span></code></a>. This value is
only allowed when using pytest.</p>
</dd>
<dt><strong>extensions</strong><span class="classifier">None or list of str</span></dt><dd><p>The list of extensions to test, e.g. <code class="docutils literal notranslate"><span class="pre">['png',</span> <span class="pre">'pdf']</span></code>.</p>
<p>If <em>None</em>, defaults to all supported extensions: png, pdf, and svg.</p>
<p>When testing a single extension, it can be directly included in the
names passed to <em>baseline_images</em>. In that case, <em>extensions</em> must not
be set.</p>
<p>In order to keep the size of the test suite from ballooning, we only
include the <code class="docutils literal notranslate"><span class="pre">svg</span></code> or <code class="docutils literal notranslate"><span class="pre">pdf</span></code> outputs if the test is explicitly
exercising a feature dependent on that backend (see also the
<a class="reference internal" href="#matplotlib.testing.decorators.check_figures_equal" title="matplotlib.testing.decorators.check_figures_equal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">check_figures_equal</span></code></a> decorator for that purpose).</p>
</dd>
<dt><strong>tol</strong><span class="classifier">float, default: 0</span></dt><dd><p>The RMS threshold above which the test is considered failed.</p>
<p>Due to expected small differences in floating-point calculations, on
32-bit systems an additional 0.06 is added to this threshold.</p>
</dd>
<dt><strong>freetype_version</strong><span class="classifier">str or tuple</span></dt><dd><p>The expected freetype version or range of versions for this test to
pass.</p>
</dd>
<dt><strong>remove_text</strong><span class="classifier">bool</span></dt><dd><p>Remove the title and tick text from the figure before comparison. This
is useful to make the baseline images independent of variations in text
rendering between different versions of FreeType.</p>
<p>This does not remove other, more deliberate, text, such as legends and
annotations.</p>
</dd>
<dt><strong>savefig_kwarg</strong><span class="classifier">dict</span></dt><dd><p>Optional arguments that are passed to the savefig method.</p>
</dd>
<dt><strong>style</strong><span class="classifier">str, dict, or list</span></dt><dd><p>The optional style(s) to apply to the image test. The test itself
can also apply additional styles if desired. Defaults to <code class="docutils literal notranslate"><span class="pre">["classic",</span>
<span class="pre">"_classic_test_patch"]</span></code>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.testing.decorators.remove_ticks_and_titles">
<code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">remove_ticks_and_titles</code><span class="sig-paren">(</span><em><span class="n">figure</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#remove_ticks_and_titles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.decorators.remove_ticks_and_titles" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="module-matplotlib.testing.exceptions">
<span id="matplotlib-testing-exceptions"></span><h2><a class="reference internal" href="#module-matplotlib.testing.exceptions" title="matplotlib.testing.exceptions"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing.exceptions</span></code></a><a class="headerlink" href="#module-matplotlib.testing.exceptions" title="Permalink to this headline">¶</a></h2>
<dl class="py exception">
<dt id="matplotlib.testing.exceptions.ImageComparisonFailure">
<em class="property">exception </em><code class="descclassname">matplotlib.testing.exceptions.</code><code class="descname">ImageComparisonFailure</code><a class="reference internal" href="../_modules/matplotlib/testing/exceptions.html#ImageComparisonFailure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.testing.exceptions.ImageComparisonFailure" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AssertionError" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionError</span></code></a></p>
<p>Raise this exception to mark a test as a comparison between two images.</p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2020 The Matplotlib development team.
<br />
Last updated on Aug 14, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.
Doc version v3.3.1-2-ge49322daa.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.