matplotlib.github.com/3.3.1/api/testing_api.html at main · matplotlib/matplotlib.github.com

History

417 lines (381 loc) · 31.2 KB

Raw

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">

<head>

<title>matplotlib.testing — Matplotlib 3.3.1 documentation</title>

title="Search within Matplotlib 3.3.1 documentation"

href="../_static/opensearch.xml"/>

</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>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.3.1</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<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>

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="text_api.html" title="matplotlib.text"

accesskey="N">next</a> |</li>

<a href="table_api.html" title="matplotlib.table"

accesskey="P">previous</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">matplotlib.testing</code></a></li>

</ul>

</div>

<h3><a href="../contents.html">Table of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#"><code class="docutils literal notranslate">matplotlib.testing</code></a><ul>

<li><a class="reference internal" href="#id1"><code class="xref py py-mod docutils literal notranslate">matplotlib.testing</code></a></li>

<li><a class="reference internal" href="#module-matplotlib.testing.compare"><code class="xref py py-mod docutils literal notranslate">matplotlib.testing.compare</code></a></li>

<li><a class="reference internal" href="#module-matplotlib.testing.decorators"><code class="xref py py-mod docutils literal notranslate">matplotlib.testing.decorators</code></a></li>

<li><a class="reference internal" href="#module-matplotlib.testing.exceptions"><code class="xref py py-mod docutils literal notranslate">matplotlib.testing.exceptions</code></a></li>

</ul>

</li>

</ul>

<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">matplotlib.table</code></a></li>

<li>Next: <a href="text_api.html" title="next chapter"><code class="docutils literal notranslate">matplotlib.text</code></a></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>

<h1><code class="docutils literal notranslate">matplotlib.testing</code><a class="headerlink" href="#matplotlib-testing" title="Permalink to this headline">¶</a></h1>

<h2><a class="reference internal" href="#module-matplotlib.testing" title="matplotlib.testing"><code class="xref py py-mod docutils literal notranslate">matplotlib.testing</code></a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>

Helper functions for testing.

<code class="descclassname">matplotlib.testing.</code><code class="descname">is_called_from_pytest</code>()<a class="reference internal" href="../_modules/matplotlib/testing.html#is_called_from_pytest">[source]</a><a class="headerlink" href="#matplotlib.testing.is_called_from_pytest" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated] Whether we are in a pytest run.

Notes

Deprecated since version 3.2.

</div>

</dd></dl>

<code class="descclassname">matplotlib.testing.</code><code class="descname">set_font_settings_for_testing</code>()<a class="reference internal" href="../_modules/matplotlib/testing.html#set_font_settings_for_testing">[source]</a><a class="headerlink" href="#matplotlib.testing.set_font_settings_for_testing" title="Permalink to this definition">¶</a></dt>

<code class="descclassname">matplotlib.testing.</code><code class="descname">set_reproducibility_for_testing</code>()<a class="reference internal" href="../_modules/matplotlib/testing.html#set_reproducibility_for_testing">[source]</a><a class="headerlink" href="#matplotlib.testing.set_reproducibility_for_testing" title="Permalink to this definition">¶</a></dt>

<code class="descclassname">matplotlib.testing.</code><code class="descname">setup</code>()<a class="reference internal" href="../_modules/matplotlib/testing.html#setup">[source]</a><a class="headerlink" href="#matplotlib.testing.setup" title="Permalink to this definition">¶</a></dt>

</div>

<h2><a class="reference internal" href="#module-matplotlib.testing.compare" title="matplotlib.testing.compare"><code class="xref py py-mod docutils literal notranslate">matplotlib.testing.compare</code></a><a class="headerlink" href="#module-matplotlib.testing.compare" title="Permalink to this headline">¶</a></h2>

Utilities for comparing image results.

<code class="descclassname">matplotlib.testing.compare.</code><code class="descname">comparable_formats</code>()<a class="reference internal" href="../_modules/matplotlib/testing/compare.html#comparable_formats">[source]</a><a class="headerlink" href="#matplotlib.testing.compare.comparable_formats" title="Permalink to this definition">¶</a></dt>

<dd>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">compare_images</code></a> can compare

on this system.

<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>E.g. <code class="docutils literal notranslate">['png', 'pdf', 'svg', 'eps']</code>.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">matplotlib.testing.compare.</code><code class="descname">compare_images</code>(expected, actual, tol, in_decorator=False)<a class="reference internal" href="../_modules/matplotlib/testing/compare.html#compare_images">[source]</a><a class="headerlink" href="#matplotlib.testing.compare.compare_images" title="Permalink to this definition">¶</a></dt>

<dd>Compare two "image" files checking differences within a tolerance.

The two given filenames may point to files which are convertible to

PNG via the <code class="xref py py-obj docutils literal notranslate">converter</code> dictionary. The underlying RMS is calculated

with the <code class="xref py py-obj docutils literal notranslate">calculate_rms</code> function.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>expectedstr</dt><dd>The filename of the expected image.

</dd>

<dt>actualstr</dt><dd>The filename of the actual image.

</dd>

<dt>tolfloat</dt><dd>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.

</dd>

<dt>in_decoratorbool</dt><dd>Determines the output format. If called from image_comparison

decorator, this should be True. (default=False)

</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>Return None if the images are equal within the given tolerance.

If the images differ, the return value depends on in_decorator.

If in_decorator is true, a dict with the following entries is

returned:

<li>rms: The RMS of the image difference.</li>

<li>expected: The filename of the expected image.</li>

<li>actual: The filename of the actual image.</li>

<li>diff_image: The filename of the difference image.</li>

<li>tol: The comparison tolerance.</li>

</ul>

Otherwise, a human-readable multi-line string representation of this

information is returned.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Examples

<div class="highlight-default notranslate"><div class="highlight"><pre>img1 = "./baseline/plot.png"

img2 = "./output/plot.png"

compare_images(img1, img2, 0.001)

</pre></div>

</div>

</dd></dl>

</div>

<h2><a class="reference internal" href="#module-matplotlib.testing.decorators" title="matplotlib.testing.decorators"><code class="xref py py-mod docutils literal notranslate">matplotlib.testing.decorators</code></a><a class="headerlink" href="#module-matplotlib.testing.decorators" title="Permalink to this headline">¶</a></h2>

class <code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">CleanupTestCase</code>(methodName='runTest')<a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#CleanupTestCase">[source]</a><a class="headerlink" href="#matplotlib.testing.decorators.CleanupTestCase" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">unittest.case.TestCase</code>

A wrapper for unittest.TestCase that includes cleanup operations.

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.

classmethod <code class="descname">setUpClass</code>()<a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#CleanupTestCase.setUpClass">[source]</a><a class="headerlink" href="#matplotlib.testing.decorators.CleanupTestCase.setUpClass" title="Permalink to this definition">¶</a></dt>

<dd>Hook method for setting up class fixture before running tests in the class.

</dd></dl>

classmethod <code class="descname">tearDownClass</code>()<a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#CleanupTestCase.tearDownClass">[source]</a><a class="headerlink" href="#matplotlib.testing.decorators.CleanupTestCase.tearDownClass" title="Permalink to this definition">¶</a></dt>

<dd>Hook method for deconstructing the class fixture after running all tests in the class.

</dd></dl>

<code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">check_figures_equal</code>(*, extensions='png', 'pdf', 'svg', tol=0)<a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#check_figures_equal">[source]</a><a class="headerlink" href="#matplotlib.testing.decorators.check_figures_equal" title="Permalink to this definition">¶</a></dt>

<dd>Decorator for test cases that generate and compare two figures.

The decorated function must take two keyword arguments, fig_test

and fig_ref, and draw the test and reference images on them.

After the function returns, the figures are saved and compared.

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">image_comparison</code></a> when possible in

order to keep the size of the test suite from ballooning.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>extensionslist, default: ["png", "pdf", "svg"]</dt><dd>The extensions to test.

</dd>

<dt>tolfloat</dt><dd>The RMS threshold above which the test is considered failed.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Examples

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">Axes.plot</code></a> with a single argument plots it against

<code class="docutils literal notranslate">[0, 1, 2, ...]</code>:

<div class="highlight-default notranslate"><div class="highlight"><pre>@check_figures_equal()

def test_plot(fig_test, fig_ref):

fig_test.subplots().plot([1, 3, 5])

fig_ref.subplots().plot([0, 1, 2], [1, 3, 5])

</pre></div>

</div>

</dd></dl>

<code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">check_freetype_version</code>(ver)<a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#check_freetype_version">[source]</a><a class="headerlink" href="#matplotlib.testing.decorators.check_freetype_version" title="Permalink to this definition">¶</a></dt>

<code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">cleanup</code>(style=None)<a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#cleanup">[source]</a><a class="headerlink" href="#matplotlib.testing.decorators.cleanup" title="Permalink to this definition">¶</a></dt>

<dd>A decorator to ensure that any global state is reset before

running a test.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>stylestr, dict, or list, optional</dt><dd>The style(s) to apply. Defaults to <code class="docutils literal notranslate">["classic",

"_classic_test_patch"]</code>.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">image_comparison</code>(baseline_images, extensions=None, tol=0, freetype_version=None, remove_text=False, savefig_kwarg=None, style='classic', '_classic_test_patch')<a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#image_comparison">[source]</a><a class="headerlink" href="#matplotlib.testing.decorators.image_comparison" title="Permalink to this definition">¶</a></dt>

<dd>Compare images generated by the test with those specified in

baseline_images, which must correspond, else an <code class="xref py py-obj docutils literal notranslate">ImageComparisonFailure</code>

exception will be raised.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>baseline_imageslist or None</dt><dd>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">Figure.savefig</code></a>.

If None, the test function must use the <code class="docutils literal notranslate">baseline_images</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">pytest.mark.usefixtures</code></a>. This value is

only allowed when using pytest.

</dd>

<dt>extensionsNone or list of str</dt><dd>The list of extensions to test, e.g. <code class="docutils literal notranslate">['png', 'pdf']</code>.

If None, defaults to all supported extensions: png, pdf, and svg.

When testing a single extension, it can be directly included in the

names passed to baseline_images. In that case, extensions must not

be set.

In order to keep the size of the test suite from ballooning, we only

include the <code class="docutils literal notranslate">svg</code> or <code class="docutils literal notranslate">pdf</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">check_figures_equal</code></a> decorator for that purpose).

</dd>

<dt>tolfloat, default: 0</dt><dd>The RMS threshold above which the test is considered failed.

Due to expected small differences in floating-point calculations, on

32-bit systems an additional 0.06 is added to this threshold.

</dd>

<dt>freetype_versionstr or tuple</dt><dd>The expected freetype version or range of versions for this test to

pass.

</dd>

<dt>remove_textbool</dt><dd>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.

This does not remove other, more deliberate, text, such as legends and

annotations.

</dd>

<dt>savefig_kwargdict</dt><dd>Optional arguments that are passed to the savefig method.

</dd>

<dt>stylestr, dict, or list</dt><dd>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">["classic",

"_classic_test_patch"]</code>.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">matplotlib.testing.decorators.</code><code class="descname">remove_ticks_and_titles</code>(figure)<a class="reference internal" href="../_modules/matplotlib/testing/decorators.html#remove_ticks_and_titles">[source]</a><a class="headerlink" href="#matplotlib.testing.decorators.remove_ticks_and_titles" title="Permalink to this definition">¶</a></dt>

</div>

<h2><a class="reference internal" href="#module-matplotlib.testing.exceptions" title="matplotlib.testing.exceptions"><code class="xref py py-mod docutils literal notranslate">matplotlib.testing.exceptions</code></a><a class="headerlink" href="#module-matplotlib.testing.exceptions" title="Permalink to this headline">¶</a></h2>

exception <code class="descclassname">matplotlib.testing.exceptions.</code><code class="descname">ImageComparisonFailure</code><a class="reference internal" href="../_modules/matplotlib/testing/exceptions.html#ImageComparisonFailure">[source]</a><a class="headerlink" href="#matplotlib.testing.exceptions.ImageComparisonFailure" title="Permalink to this definition">¶</a></dt>

<dd>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">AssertionError</code></a>

Raise this exception to mark a test as a comparison between two images.

</dd></dl>

</div>

</div>

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>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

testing_api.html

Latest commit

History

testing_api.html

File metadata and controls