-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathtesting_api.html
More file actions
989 lines (769 loc) · 72.6 KB
/
testing_api.html
File metadata and controls
989 lines (769 loc) · 72.6 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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
<!DOCTYPE html>
<html lang="en" data-content_root="../" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>matplotlib.testing — Matplotlib 3.11.0rc1 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../_static/css/style.css?v=522e7f4d" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="../_static/mpl.css?v=5a7e13c8" />
<!-- So that users can add custom icons -->
<script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="../_static/documentation_options.js?v=6987601a"></script>
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=ccdb6887"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'api/testing_api';</script>
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json?v3.11.0rc1-1-g3217fe2227';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'dev';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="canonical" href="https://matplotlib.org/stable/api/testing_api.html" />
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.11.0rc1 documentation"
href="../_static/opensearch.xml"/>
<link rel="icon" href="../_static/favicon.ico"/>
<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" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="3.11.0rc1" />
<meta name="docbuild:last-update" content="Apr 24, 2026"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="bd-header-announcement container-fluid" id="unreleased-message">
<div class="bd-header-announcement__content">
You are reading documentation for the unreleased version of Matplotlib.
<a href="https://matplotlib.org/search.html?q=matplotlib.testing&check_keywords=yes&area=default">
Try searching for the released version of this page instead?
</a>
</div>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="https://matplotlib.org/stable/">
<img src="../_static/logo_light.svg" class="logo__image only-light" alt="Matplotlib 3.11.0rc1 documentation - Home"/>
<img src="../_static/logo_dark.svg" class="logo__image only-dark pst-js-only" alt="Matplotlib 3.11.0rc1 documentation - Home"/>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../devel/index.html">Contribute</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>
</li>
</ul></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
</div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-2"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-2"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-2"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-2">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-gitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Gitter</span></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-discourse fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discourse</span></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../devel/index.html">Contribute</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>
</li>
</ul></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-3"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-3"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-3"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-3">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-gitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Gitter</span></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-discourse fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discourse</span></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="matplotlib_configuration_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="animation_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.animation</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="artist_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.artist</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="axes_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.axes</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="axis_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.axis</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="backend_bases_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.backend_bases</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="backend_managers_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.backend_managers</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="backend_tools_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.backend_tools</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="index_backend_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="bezier_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.bezier</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="category_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.category</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="cbook_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.cbook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="cm_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.cm</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="collections_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.collections</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="colorbar_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.colorbar</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="colorizer_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.colorizer</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="colors_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.colors</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="container_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.container</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="contour_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.contour</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="dates_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.dates</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="dviread.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.dviread</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="figure_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.figure</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="font_manager_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.font_manager</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="ft2font.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.ft2font</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="gridspec_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.gridspec</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hatch_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.hatch</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="image_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.image</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="inset_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.inset</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="layout_engine_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.layout_engine</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="legend_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.legend</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="legend_handler_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.legend_handler</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="lines_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.lines</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="markers_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.markers</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="mathtext_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.mathtext</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="mlab_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.mlab</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="offsetbox_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.offsetbox</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="patches_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.patches</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="path_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.path</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="patheffects_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.patheffects</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="pyplot_summary.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.pyplot</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="projections_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.projections</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="quiver_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.quiver</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="rcsetup_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.rcsetup</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="sankey_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.sankey</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="scale_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.scale</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="sphinxext_mathmpl_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.sphinxext.mathmpl</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="sphinxext_plot_directive_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.sphinxext.plot_directive</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="sphinxext_figmpl_directive_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.sphinxext.figmpl_directive</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="sphinxext_roles.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.sphinxext.roles</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="spines_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.spines</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="style_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.style</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="table_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.table</span></code></a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">matplotlib.testing</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="text_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.text</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="texmanager_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.texmanager</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="ticker_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.ticker</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="transformations.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.transforms</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="tri_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.tri</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="typing_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.typing</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="units_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.units</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="widgets_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.widgets</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="_afm_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib._afm</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="_api_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib._api</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="_docstring_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib._docstring</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="_enums_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib._enums</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="_type1font.html"><code class="docutils literal notranslate"><span class="pre">matplotlib._type1font</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="_tight_bbox_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib._tight_bbox</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="_tight_layout_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib._tight_layout</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="toolkits/mplot3d.html"><code class="docutils literal notranslate"><span class="pre">mpl_toolkits.mplot3d</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="toolkits/axes_grid1.html"><code class="docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid1</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="toolkits/axisartist.html"><code class="docutils literal notranslate"><span class="pre">mpl_toolkits.axisartist</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="pylab.html"><code class="docutils literal notranslate"><span class="pre">pylab</span></code></a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="index.html" class="nav-link">API Reference</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis"><code class="docutils literal notranslate"><span class="pre">matplotlib.testing</span></code></span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="matplotlib-testing">
<h1><code class="docutils literal notranslate"><span class="pre">matplotlib.testing</span></code><a class="headerlink" href="#matplotlib-testing" title="Link to this heading">#</a></h1>
<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="Link to this heading">#</a></h2>
<p id="module-matplotlib.testing">Helper functions for testing.</p>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.ipython_in_subprocess">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.</span></span><span class="sig-name descname"><span class="pre">ipython_in_subprocess</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">requested_backend_or_gui_framework</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">all_expected_backends</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/__init__.py#L219-L250"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.ipython_in_subprocess" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.is_ci_environment">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.</span></span><span class="sig-name descname"><span class="pre">is_ci_environment</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/__init__.py#L253-L271"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.is_ci_environment" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.set_font_settings_for_testing">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.</span></span><span class="sig-name descname"><span class="pre">set_font_settings_for_testing</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/__init__.py#L20-L22"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.set_font_settings_for_testing" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.set_reproducibility_for_testing">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.</span></span><span class="sig-name descname"><span class="pre">set_reproducibility_for_testing</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/__init__.py#L25-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.set_reproducibility_for_testing" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.setup">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/__init__.py#L29-L51"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.setup" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.subprocess_run_for_testing">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.</span></span><span class="sig-name descname"><span class="pre">subprocess_run_for_testing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">60</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capture_output</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/__init__.py#L54-L129"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.subprocess_run_for_testing" title="Link to this definition">#</a></dt>
<dd><p>Create and run a subprocess.</p>
<p>Thin wrapper around <a class="reference external" href="https://docs.python.org/3/library/subprocess.html#subprocess.run" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">subprocess.run</span></code></a>, intended for testing. Will
mark fork() failures on Cygwin as expected failures: not a
success, but not indicating a problem with the code either.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>args</strong><span class="classifier">list of str</span></dt><dd></dd>
<dt><strong>env</strong><span class="classifier">dict[str, str]</span></dt><dd></dd>
<dt><strong>timeout</strong><span class="classifier">float</span></dt><dd></dd>
<dt><strong>stdout, stderr</strong></dt><dd></dd>
<dt><strong>check</strong><span class="classifier">bool</span></dt><dd></dd>
<dt><strong>text</strong><span class="classifier">bool</span></dt><dd><p>Also called <code class="docutils literal notranslate"><span class="pre">universal_newlines</span></code> in subprocess. I chose this
name since the main effect is returning bytes (<a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">False</span></code></a>) vs. str
(<a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a>), though it also tries to normalize newlines across
platforms.</p>
</dd>
<dt><strong>capture_output</strong><span class="classifier">bool</span></dt><dd><p>Set stdout and stderr to subprocess.PIPE</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><dl class="simple">
<dt><strong>proc</strong><span class="classifier">subprocess.Popen</span></dt><dd></dd>
</dl>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt>pytest.skip</dt><dd><p>If running on emscripten, which does not support subprocesses.</p>
</dd>
<dt>pytest.xfail</dt><dd><p>If platform is Cygwin and subprocess reports a fork() failure.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference external" href="https://docs.python.org/3/library/subprocess.html#subprocess.run" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">subprocess.run</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.subprocess_run_helper">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.</span></span><span class="sig-name descname"><span class="pre">subprocess_run_helper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_env</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/__init__.py#L132-L179"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.subprocess_run_helper" title="Link to this definition">#</a></dt>
<dd><p>Run a function in a sub-process.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>func</strong><span class="classifier">function</span></dt><dd><p>The function to be run. It must be in a module that is importable.</p>
</dd>
<dt><strong>*args</strong><span class="classifier">str</span></dt><dd><p>Any additional command line arguments to be passed in
the first argument to <code class="docutils literal notranslate"><span class="pre">subprocess.run</span></code>.</p>
</dd>
<dt><strong>extra_env</strong><span class="classifier">dict[str, str]</span></dt><dd><p>Any additional environment variables to be set for the subprocess.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
</section>
<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="Link to this heading">#</a></h2>
<p>Utilities for comparing image results.</p>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.compare.calculate_rms">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.compare.</span></span><span class="sig-name descname"><span class="pre">calculate_rms</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expected_image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actual_image</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/compare.py#L383-L392"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.compare.calculate_rms" title="Link to this definition">#</a></dt>
<dd><p>Calculate the per-pixel errors, then compute the root mean square error.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.compare.comparable_formats">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.compare.</span></span><span class="sig-name descname"><span class="pre">comparable_formats</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/compare.py#L268-L279"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.compare.comparable_formats" title="Link 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>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<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>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.compare.compare_images">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.compare.</span></span><span class="sig-name descname"><span class="pre">compare_images</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expected</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actual</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_decorator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/compare.py#L409-L505"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.compare.compare_images" title="Link 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
in a similar way to the <a class="reference internal" href="#matplotlib.testing.compare.calculate_rms" title="matplotlib.testing.compare.calculate_rms"><code class="xref py py-obj docutils literal notranslate"><span class="pre">calculate_rms</span></code></a> function.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<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>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><dl>
<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><p><em>rms</em>: The RMS of the image difference.</p></li>
<li><p><em>expected</em>: The filename of the expected image.</p></li>
<li><p><em>actual</em>: The filename of the actual image.</p></li>
<li><p><em>diff_image</em>: The filename of the difference image.</p></li>
<li><p><em>tol</em>: The comparison tolerance.</p></li>
</ul>
<p>Otherwise, a human-readable multi-line string representation of this
information is returned.</p>
</dd>
</dl>
</dd>
</dl>
<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>
</section>
<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="Link to this heading">#</a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.decorators.check_figures_equal">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.decorators.</span></span><span class="sig-name descname"><span class="pre">check_figures_equal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">extensions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('png',)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/decorators.py#L362-L460"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.decorators.check_figures_equal" title="Link 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>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl>
<dt><strong>extensions</strong><span class="classifier">list, default: ["png"]</span></dt><dd><p>The extensions to test. Supported extensions are "png", "pdf", "svg".</p>
<p>Testing with the one default extension is sufficient if the output is not
format dependent, e.g. if you test that a <code class="docutils literal notranslate"><span class="pre">bar()</span></code> plot yields the same
result as some manually placed Rectangles. You should use all extensions
if a renderer property is involved, e.g. correct alpha blending.</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>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><dl class="simple">
<dt>RuntimeError</dt><dd><p>If any new figures are created (and not subsequently closed) inside
the test function.</p>
</dd>
</dl>
</dd>
</dl>
<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="w"> </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 class="sig sig-object py" id="matplotlib.testing.decorators.image_comparison">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.decorators.</span></span><span class="sig-name descname"><span class="pre">image_comparison</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseline_images</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extensions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">freetype_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remove_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">savefig_kwarg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/decorators.py#L263-L359"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.decorators.image_comparison" title="Link 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 <a class="reference internal" href="#matplotlib.testing.exceptions.ImageComparisonFailure" title="matplotlib.testing.exceptions.ImageComparisonFailure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ImageComparisonFailure</span></code></a>
exception will be raised.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl>
<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.savefig.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/reference.html#pytest.mark.usefixtures" title="(in pytest v9.0.3)"><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: 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 style(s) to apply to the image test. The test itself can also apply
additional styles if desired.</p>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 3.11: </span>This defaults to <code class="docutils literal notranslate"><span class="pre">['classic',</span> <span class="pre">'_classic_test_patch']</span></code>, but will be
changing to <code class="docutils literal notranslate"><span class="pre">'mpl20'</span></code> as of Matplotlib 3.13. A warning is raised if not
explicitly passed.</p>
</div>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.decorators.remove_ticks_and_titles">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.decorators.</span></span><span class="sig-name descname"><span class="pre">remove_ticks_and_titles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">figure</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/decorators.py#L57-L75"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.decorators.remove_ticks_and_titles" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</section>
<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="Link to this heading">#</a></h2>
<dl class="py exception">
<dt class="sig sig-object py" id="matplotlib.testing.exceptions.ImageComparisonFailure">
<span class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">matplotlib.testing.exceptions.</span></span><span class="sig-name descname"><span class="pre">ImageComparisonFailure</span></span><a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/v3.11.0rc1/lib/matplotlib/testing/exceptions.py#L1-L4"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matplotlib.testing.exceptions.ImageComparisonFailure" title="Link 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.14)"><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>
</section>
<section id="testing-with-optional-dependencies">
<h2>Testing with optional dependencies<a class="headerlink" href="#testing-with-optional-dependencies" title="Link to this heading">#</a></h2>
<p>For more information on fixtures, see <a class="reference external" href="https://pytest.org/en/stable/explanation/fixtures.html#about-fixtures" title="(in pytest v9.0.3)"><span class="xref std std-ref">pytest fixtures</span></a>.</p>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.conftest.pd">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.conftest.</span></span><span class="sig-name descname"><span class="pre">pd</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.testing.conftest.pd" title="Link to this definition">#</a></dt>
<dd><p>Fixture to import and configure pandas. Using this fixture, the test is skipped when
pandas is not installed. Use this fixture instead of importing pandas in test files.</p>
<p class="rubric">Examples</p>
<p>Request the pandas fixture by passing in <code class="docutils literal notranslate"><span class="pre">pd</span></code> as an argument to the test</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">test_matshow_pandas</span><span class="p">(</span><span class="n">pd</span><span class="p">):</span>
<span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">({</span><span class="s1">'x'</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="mi">3</span><span class="p">],</span> <span class="s1">'y'</span><span class="p">:[</span><span class="mi">4</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">6</span><span class="p">]})</span>
<span class="n">im</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">()</span><span class="o">.</span><span class="n">subplots</span><span class="p">()</span><span class="o">.</span><span class="n">matshow</span><span class="p">(</span><span class="n">df</span><span class="p">)</span>
<span class="n">np</span><span class="o">.</span><span class="n">testing</span><span class="o">.</span><span class="n">assert_array_equal</span><span class="p">(</span><span class="n">im</span><span class="o">.</span><span class="n">get_array</span><span class="p">(),</span> <span class="n">df</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="matplotlib.testing.conftest.xr">
<span class="sig-prename descclassname"><span class="pre">matplotlib.testing.conftest.</span></span><span class="sig-name descname"><span class="pre">xr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.testing.conftest.xr" title="Link to this definition">#</a></dt>
<dd><p>Fixture to import xarray so that the test is skipped when xarray is not installed.
Use this fixture instead of importing xrray in test files.</p>
<p class="rubric">Examples</p>
<p>Request the xarray fixture by passing in <code class="docutils literal notranslate"><span class="pre">xr</span></code> as an argument to the test</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">test_imshow_xarray</span><span class="p">(</span><span class="n">xr</span><span class="p">):</span>
<span class="n">ds</span> <span class="o">=</span> <span class="n">xr</span><span class="o">.</span><span class="n">DataArray</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">))</span>
<span class="n">im</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">()</span><span class="o">.</span><span class="n">subplots</span><span class="p">()</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">ds</span><span class="p">)</span>
<span class="n">np</span><span class="o">.</span><span class="n">testing</span><span class="o">.</span><span class="n">assert_array_equal</span><span class="p">(</span><span class="n">im</span><span class="o">.</span><span class="n">get_array</span><span class="p">(),</span> <span class="n">ds</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</section>
</section>
</article>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#id1"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.ipython_in_subprocess"><code class="docutils literal notranslate"><span class="pre">ipython_in_subprocess()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.is_ci_environment"><code class="docutils literal notranslate"><span class="pre">is_ci_environment()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.set_font_settings_for_testing"><code class="docutils literal notranslate"><span class="pre">set_font_settings_for_testing()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.set_reproducibility_for_testing"><code class="docutils literal notranslate"><span class="pre">set_reproducibility_for_testing()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.setup"><code class="docutils literal notranslate"><span class="pre">setup()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.subprocess_run_for_testing"><code class="docutils literal notranslate"><span class="pre">subprocess_run_for_testing()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.subprocess_run_helper"><code class="docutils literal notranslate"><span class="pre">subprocess_run_helper()</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-matplotlib.testing.compare"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing.compare</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.compare.calculate_rms"><code class="docutils literal notranslate"><span class="pre">calculate_rms()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.compare.comparable_formats"><code class="docutils literal notranslate"><span class="pre">comparable_formats()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.compare.compare_images"><code class="docutils literal notranslate"><span class="pre">compare_images()</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-matplotlib.testing.decorators"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing.decorators</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.decorators.check_figures_equal"><code class="docutils literal notranslate"><span class="pre">check_figures_equal()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.decorators.image_comparison"><code class="docutils literal notranslate"><span class="pre">image_comparison()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.decorators.remove_ticks_and_titles"><code class="docutils literal notranslate"><span class="pre">remove_ticks_and_titles()</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-matplotlib.testing.exceptions"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.testing.exceptions</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.exceptions.ImageComparisonFailure"><code class="docutils literal notranslate"><span class="pre">ImageComparisonFailure</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#testing-with-optional-dependencies">Testing with optional dependencies</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.conftest.pd"><code class="docutils literal notranslate"><span class="pre">pd()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#matplotlib.testing.conftest.xr"><code class="docutils literal notranslate"><span class="pre">xr()</span></code></a></li>
</ul>
</li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2002–2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012–2026 The Matplotlib development team.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Built from v3.11.0rc1-1-g3217fe2227.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>
</div>
</div>
</footer>
</body>
</html>