-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathrcsetup.html
More file actions
1586 lines (1339 loc) · 226 KB
/
rcsetup.html
File metadata and controls
1586 lines (1339 loc) · 226 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
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.rcsetup — Matplotlib 2.2.3 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.2.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.2.3 documentation"
href="../../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html"
/>
<link rel="search" title="Search" href="../../search.html"
/>
<link rel="top" title="Matplotlib 2.2.3 documentation" href="../../index.html" />
<link rel="up" title="matplotlib" href="../matplotlib.html" />
<link rel="canonical" href="https://matplotlib.org/3.4.3/_modules/matplotlib/rcsetup.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.3). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 2.2.3</span></div>
<img src="../../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../gallery/index.html">examples</a>| </li>
<li><a href="../../tutorials/index.html">tutorials</a>| </li>
<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>
<li><a href="../../contents.html">docs</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
<li><a href="../matplotlib.html">matplotlib</a><ul>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for matplotlib.rcsetup</h1><div class="highlight"><pre>
<span></span><span class="sd">"""</span>
<span class="sd">The rcsetup module contains the default values and the validation code for</span>
<span class="sd">customization using matplotlib's rc settings.</span>
<span class="sd">Each rc setting is assigned a default value and a function used to validate</span>
<span class="sd">any attempted changes to that setting. The default values and validation</span>
<span class="sd">functions are defined in the rcsetup module, and are used to construct the</span>
<span class="sd">rcParams global object which stores the settings and is referenced throughout</span>
<span class="sd">matplotlib.</span>
<span class="sd">These default values should be consistent with the default matplotlibrc file</span>
<span class="sd">that actually reflects the values given here. Any additions or deletions to the</span>
<span class="sd">parameter set listed here should also be visited to the</span>
<span class="sd">:file:`matplotlibrc.template` in matplotlib's root source directory.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span>
<span class="kn">import</span> <span class="nn">six</span>
<span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">Mapping</span>
<span class="kn">from</span> <span class="nn">functools</span> <span class="k">import</span> <span class="n">reduce</span>
<span class="kn">import</span> <span class="nn">operator</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="k">import</span> <span class="n">cbook</span><span class="p">,</span> <span class="n">testing</span>
<span class="kn">from</span> <span class="nn">matplotlib.cbook</span> <span class="k">import</span> <span class="n">mplDeprecation</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="n">ls_mapper</span>
<span class="kn">from</span> <span class="nn">matplotlib.fontconfig_pattern</span> <span class="k">import</span> <span class="n">parse_fontconfig_pattern</span>
<span class="kn">from</span> <span class="nn">matplotlib.colors</span> <span class="k">import</span> <span class="n">is_color_like</span>
<span class="c1"># Don't let the original cycler collide with our validating cycler</span>
<span class="kn">from</span> <span class="nn">cycler</span> <span class="k">import</span> <span class="n">Cycler</span><span class="p">,</span> <span class="n">cycler</span> <span class="k">as</span> <span class="n">ccycler</span>
<span class="c1"># The capitalized forms are needed for ipython at present; this may</span>
<span class="c1"># change for later versions.</span>
<span class="n">interactive_bk</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'GTK'</span><span class="p">,</span> <span class="s1">'GTKAgg'</span><span class="p">,</span> <span class="s1">'GTKCairo'</span><span class="p">,</span> <span class="s1">'MacOSX'</span><span class="p">,</span>
<span class="s1">'Qt4Agg'</span><span class="p">,</span> <span class="s1">'Qt5Agg'</span><span class="p">,</span> <span class="s1">'TkAgg'</span><span class="p">,</span> <span class="s1">'WX'</span><span class="p">,</span> <span class="s1">'WXAgg'</span><span class="p">,</span>
<span class="s1">'GTK3Cairo'</span><span class="p">,</span> <span class="s1">'GTK3Agg'</span><span class="p">,</span> <span class="s1">'WebAgg'</span><span class="p">,</span> <span class="s1">'nbAgg'</span><span class="p">]</span>
<span class="n">interactive_bk</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'GTK'</span><span class="p">,</span> <span class="s1">'GTKAgg'</span><span class="p">,</span> <span class="s1">'GTKCairo'</span><span class="p">,</span> <span class="s1">'GTK3Agg'</span><span class="p">,</span> <span class="s1">'GTK3Cairo'</span><span class="p">,</span>
<span class="s1">'MacOSX'</span><span class="p">,</span>
<span class="s1">'nbAgg'</span><span class="p">,</span>
<span class="s1">'Qt4Agg'</span><span class="p">,</span> <span class="s1">'Qt4Cairo'</span><span class="p">,</span> <span class="s1">'Qt5Agg'</span><span class="p">,</span> <span class="s1">'Qt5Cairo'</span><span class="p">,</span>
<span class="s1">'TkAgg'</span><span class="p">,</span> <span class="s1">'TkCairo'</span><span class="p">,</span>
<span class="s1">'WebAgg'</span><span class="p">,</span>
<span class="s1">'WX'</span><span class="p">,</span> <span class="s1">'WXAgg'</span><span class="p">,</span> <span class="s1">'WXCairo'</span><span class="p">]</span>
<span class="n">non_interactive_bk</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'agg'</span><span class="p">,</span> <span class="s1">'cairo'</span><span class="p">,</span> <span class="s1">'gdk'</span><span class="p">,</span>
<span class="s1">'pdf'</span><span class="p">,</span> <span class="s1">'pgf'</span><span class="p">,</span> <span class="s1">'ps'</span><span class="p">,</span> <span class="s1">'svg'</span><span class="p">,</span> <span class="s1">'template'</span><span class="p">]</span>
<span class="n">all_backends</span> <span class="o">=</span> <span class="n">interactive_bk</span> <span class="o">+</span> <span class="n">non_interactive_bk</span>
<div class="viewcode-block" id="ValidateInStrings"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.ValidateInStrings">[docs]</a><span class="k">class</span> <span class="nc">ValidateInStrings</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">valid</span><span class="p">,</span> <span class="n">ignorecase</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="s1">'valid is a list of legal strings'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">key</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ignorecase</span> <span class="o">=</span> <span class="n">ignorecase</span>
<span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="n">ignorecase</span><span class="p">:</span>
<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">s</span>
<span class="bp">self</span><span class="o">.</span><span class="n">valid</span> <span class="o">=</span> <span class="p">{</span><span class="n">func</span><span class="p">(</span><span class="n">k</span><span class="p">):</span> <span class="n">k</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">valid</span><span class="p">}</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ignorecase</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">valid</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">valid</span><span class="p">[</span><span class="n">s</span><span class="p">]</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Unrecognized </span><span class="si">%s</span><span class="s1"> string "</span><span class="si">%s</span><span class="s1">": valid strings are </span><span class="si">%s</span><span class="s1">'</span>
<span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="nb">list</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">itervalues</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">valid</span><span class="p">))))</span></div>
<span class="k">def</span> <span class="nf">_listify_validator</span><span class="p">(</span><span class="n">scalar_validator</span><span class="p">,</span> <span class="n">allow_stringlist</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">f</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="n">scalar_validator</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">s</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">','</span><span class="p">)</span>
<span class="k">if</span> <span class="n">v</span><span class="o">.</span><span class="n">strip</span><span class="p">()]</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">if</span> <span class="n">allow_stringlist</span><span class="p">:</span>
<span class="c1"># Sometimes, a list of colors might be a single string</span>
<span class="c1"># of single-letter colornames. So give that a shot.</span>
<span class="k">return</span> <span class="p">[</span><span class="n">scalar_validator</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">s</span> <span class="k">if</span> <span class="n">v</span><span class="o">.</span><span class="n">strip</span><span class="p">()]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span>
<span class="c1"># We should allow any generic sequence type, including generators,</span>
<span class="c1"># Numpy ndarrays, and pandas data structures. However, unordered</span>
<span class="c1"># sequences, such as sets, should be allowed but discouraged unless the</span>
<span class="c1"># user desires pseudorandom behavior.</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">):</span>
<span class="c1"># The condition on this list comprehension will preserve the</span>
<span class="c1"># behavior of filtering out any empty strings (behavior was</span>
<span class="c1"># from the original validate_stringlist()), while allowing</span>
<span class="c1"># any non-string/text scalar values such as numbers and arrays.</span>
<span class="k">return</span> <span class="p">[</span><span class="n">scalar_validator</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">s</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">)</span> <span class="ow">or</span> <span class="n">v</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"</span><span class="si">{!r}</span><span class="s2"> must be of type: string or non-dictionary "</span>
<span class="s2">"iterable"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">s</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{}</span><span class="s2">list"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">scalar_validator</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span> <span class="c1"># class instance.</span>
<span class="n">f</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{}</span><span class="s2">List"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">scalar_validator</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span>
<span class="n">f</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="n">scalar_validator</span><span class="o">.</span><span class="vm">__doc__</span>
<span class="k">return</span> <span class="n">f</span>
<div class="viewcode-block" id="validate_any"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_any">[docs]</a><span class="k">def</span> <span class="nf">validate_any</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">return</span> <span class="n">s</span></div>
<span class="n">validate_anylist</span> <span class="o">=</span> <span class="n">_listify_validator</span><span class="p">(</span><span class="n">validate_any</span><span class="p">)</span>
<div class="viewcode-block" id="validate_path_exists"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_path_exists">[docs]</a><span class="k">def</span> <span class="nf">validate_path_exists</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">"""If s is a path, return s, else False"""</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'"</span><span class="si">%s</span><span class="s1">" should be a path but it does not exist'</span> <span class="o">%</span> <span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_bool"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_bool">[docs]</a><span class="k">def</span> <span class="nf">validate_bool</span><span class="p">(</span><span class="n">b</span><span class="p">):</span>
<span class="sd">"""Convert b to a boolean or raise"""</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">b</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="n">b</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'t'</span><span class="p">,</span> <span class="s1">'y'</span><span class="p">,</span> <span class="s1">'yes'</span><span class="p">,</span> <span class="s1">'on'</span><span class="p">,</span> <span class="s1">'true'</span><span class="p">,</span> <span class="s1">'1'</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="kc">True</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">elif</span> <span class="n">b</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'f'</span><span class="p">,</span> <span class="s1">'n'</span><span class="p">,</span> <span class="s1">'no'</span><span class="p">,</span> <span class="s1">'off'</span><span class="p">,</span> <span class="s1">'false'</span><span class="p">,</span> <span class="s1">'0'</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Could not convert "</span><span class="si">%s</span><span class="s1">" to boolean'</span> <span class="o">%</span> <span class="n">b</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_bool_maybe_none"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_bool_maybe_none">[docs]</a><span class="k">def</span> <span class="nf">validate_bool_maybe_none</span><span class="p">(</span><span class="n">b</span><span class="p">):</span>
<span class="s1">'Convert b to a boolean or raise'</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">b</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="n">b</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">b</span> <span class="o">==</span> <span class="s1">'none'</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">b</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'t'</span><span class="p">,</span> <span class="s1">'y'</span><span class="p">,</span> <span class="s1">'yes'</span><span class="p">,</span> <span class="s1">'on'</span><span class="p">,</span> <span class="s1">'true'</span><span class="p">,</span> <span class="s1">'1'</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="kc">True</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">elif</span> <span class="n">b</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'f'</span><span class="p">,</span> <span class="s1">'n'</span><span class="p">,</span> <span class="s1">'no'</span><span class="p">,</span> <span class="s1">'off'</span><span class="p">,</span> <span class="s1">'false'</span><span class="p">,</span> <span class="s1">'0'</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Could not convert "</span><span class="si">%s</span><span class="s1">" to boolean'</span> <span class="o">%</span> <span class="n">b</span><span class="p">)</span></div>
<div class="viewcode-block" id="deprecate_axes_hold"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.deprecate_axes_hold">[docs]</a><span class="k">def</span> <span class="nf">deprecate_axes_hold</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span> <span class="c1"># converted to True where accessed in figure.py,</span>
<span class="c1"># axes/_base.py</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"axes.hold is deprecated, will be removed in 3.0"</span><span class="p">,</span>
<span class="n">mplDeprecation</span><span class="p">)</span>
<span class="k">return</span> <span class="n">validate_bool</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_float"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_float">[docs]</a><span class="k">def</span> <span class="nf">validate_float</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">"""convert s to float or raise"""</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Could not convert "</span><span class="si">%s</span><span class="s1">" to float'</span> <span class="o">%</span> <span class="n">s</span><span class="p">)</span></div>
<span class="n">validate_floatlist</span> <span class="o">=</span> <span class="n">_listify_validator</span><span class="p">(</span><span class="n">validate_float</span><span class="p">)</span>
<div class="viewcode-block" id="validate_float_or_None"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_float_or_None">[docs]</a><span class="k">def</span> <span class="nf">validate_float_or_None</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">"""convert s to float, None or raise"""</span>
<span class="c1"># values directly from the rc file can only be strings,</span>
<span class="c1"># so we need to recognize the string "None" and convert</span>
<span class="c1"># it into the object. We will be case-sensitive here to</span>
<span class="c1"># avoid confusion between string values of 'none', which</span>
<span class="c1"># can be a valid string value for some other parameters.</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">s</span> <span class="o">==</span> <span class="s1">'None'</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Could not convert "</span><span class="si">%s</span><span class="s1">" to float or None'</span> <span class="o">%</span> <span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_string_or_None"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_string_or_None">[docs]</a><span class="k">def</span> <span class="nf">validate_string_or_None</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">"""convert s to string or raise"""</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">validate_string</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Could not convert "</span><span class="si">%s</span><span class="s1">" to string'</span> <span class="o">%</span> <span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_axisbelow"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_axisbelow">[docs]</a><span class="k">def</span> <span class="nf">validate_axisbelow</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">validate_bool</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="n">s</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'line'</span><span class="p">):</span>
<span class="k">return</span> <span class="s1">'line'</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'</span><span class="si">%s</span><span class="s1"> cannot be interpreted as'</span>
<span class="s1">' True, False, or "line"'</span> <span class="o">%</span> <span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_dpi"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_dpi">[docs]</a><span class="k">def</span> <span class="nf">validate_dpi</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">"""confirm s is string 'figure' or convert s to float or raise"""</span>
<span class="k">if</span> <span class="n">s</span> <span class="o">==</span> <span class="s1">'figure'</span><span class="p">:</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'"</span><span class="si">%s</span><span class="s1">" is not string "figure" or'</span>
<span class="s1">' could not convert "</span><span class="si">%s</span><span class="s1">" to float'</span> <span class="o">%</span> <span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">s</span><span class="p">))</span></div>
<div class="viewcode-block" id="validate_int"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_int">[docs]</a><span class="k">def</span> <span class="nf">validate_int</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">"""convert s to int or raise"""</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Could not convert "</span><span class="si">%s</span><span class="s1">" to int'</span> <span class="o">%</span> <span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_int_or_None"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_int_or_None">[docs]</a><span class="k">def</span> <span class="nf">validate_int_or_None</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">"""if not None, tries to validate as an int"""</span>
<span class="k">if</span> <span class="n">s</span><span class="o">==</span><span class="s1">'None'</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Could not convert "</span><span class="si">%s</span><span class="s1">" to int'</span> <span class="o">%</span> <span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_fonttype"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_fonttype">[docs]</a><span class="k">def</span> <span class="nf">validate_fonttype</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> confirm that this is a Postscript of PDF font type that we know how to</span>
<span class="sd"> convert to</span>
<span class="sd"> """</span>
<span class="n">fonttypes</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'type3'</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
<span class="s1">'truetype'</span><span class="p">:</span> <span class="mi">42</span><span class="p">}</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">fonttype</span> <span class="o">=</span> <span class="n">validate_int</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">fonttypes</span><span class="p">[</span><span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">'Supported Postscript/PDF font types are </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="nb">list</span><span class="p">(</span><span class="n">fonttypes</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">fonttype</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">six</span><span class="o">.</span><span class="n">itervalues</span><span class="p">(</span><span class="n">fonttypes</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">'Supported Postscript/PDF font types are </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span>
<span class="nb">list</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">itervalues</span><span class="p">(</span><span class="n">fonttypes</span><span class="p">)))</span>
<span class="k">return</span> <span class="n">fonttype</span></div>
<span class="n">_validate_standard_backends</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span>
<span class="s1">'backend'</span><span class="p">,</span> <span class="n">all_backends</span><span class="p">,</span> <span class="n">ignorecase</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<div class="viewcode-block" id="validate_backend"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_backend">[docs]</a><span class="k">def</span> <span class="nf">validate_backend</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="n">s</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'module://'</span><span class="p">):</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_validate_standard_backends</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_qt4"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_qt4">[docs]</a><span class="k">def</span> <span class="nf">validate_qt4</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">return</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s2">"backend.qt4"</span><span class="p">,</span> <span class="p">[</span><span class="s1">'PyQt4'</span><span class="p">,</span> <span class="s1">'PySide'</span><span class="p">,</span> <span class="s1">'PyQt4v2'</span><span class="p">])(</span><span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_qt5"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_qt5">[docs]</a><span class="k">def</span> <span class="nf">validate_qt5</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">return</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s2">"backend.qt5"</span><span class="p">,</span> <span class="p">[</span><span class="s1">'PyQt5'</span><span class="p">,</span> <span class="s1">'PySide2'</span><span class="p">])(</span><span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_toolbar"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_toolbar">[docs]</a><span class="k">def</span> <span class="nf">validate_toolbar</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">validator</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span>
<span class="s1">'toolbar'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'None'</span><span class="p">,</span> <span class="s1">'toolbar2'</span><span class="p">,</span> <span class="s1">'toolmanager'</span><span class="p">],</span>
<span class="n">ignorecase</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">validator</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>
<span class="n">_seq_err_msg</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'You must supply exactly </span><span class="si">{n}</span><span class="s1"> values, you provided </span><span class="si">{num}</span><span class="s1"> '</span>
<span class="s1">'values: </span><span class="si">{s}</span><span class="s1">'</span><span class="p">)</span>
<span class="n">_str_err_msg</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'You must supply exactly </span><span class="si">{n}</span><span class="s1"> comma-separated values, you '</span>
<span class="s1">'provided </span><span class="si">{num}</span><span class="s1"> comma-separated values: </span><span class="si">{s}</span><span class="s1">'</span><span class="p">)</span>
<div class="viewcode-block" id="validate_nseq_float"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_nseq_float">[docs]</a><span class="k">class</span> <span class="nc">validate_nseq_float</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">allow_none</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">n</span> <span class="o">=</span> <span class="n">n</span>
<span class="bp">self</span><span class="o">.</span><span class="n">allow_none</span> <span class="o">=</span> <span class="n">allow_none</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="sd">"""return a seq of n floats or raise"""</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">s</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">','</span><span class="p">)]</span>
<span class="n">err_msg</span> <span class="o">=</span> <span class="n">_str_err_msg</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">err_msg</span> <span class="o">=</span> <span class="n">_seq_err_msg</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">n</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">n</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">err_msg</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">n</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">n</span><span class="p">,</span> <span class="n">num</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">),</span> <span class="n">s</span><span class="o">=</span><span class="n">s</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="nb">float</span><span class="p">(</span><span class="n">val</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">allow_none</span> <span class="ow">or</span> <span class="n">val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="n">val</span>
<span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">s</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Could not convert all entries to floats'</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_nseq_int"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_nseq_int">[docs]</a><span class="k">class</span> <span class="nc">validate_nseq_int</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">n</span> <span class="o">=</span> <span class="n">n</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="sd">"""return a seq of n ints or raise"""</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">s</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">','</span><span class="p">)]</span>
<span class="n">err_msg</span> <span class="o">=</span> <span class="n">_str_err_msg</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">err_msg</span> <span class="o">=</span> <span class="n">_seq_err_msg</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">n</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">n</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">err_msg</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">n</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">n</span><span class="p">,</span> <span class="n">num</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">),</span> <span class="n">s</span><span class="o">=</span><span class="n">s</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="nb">int</span><span class="p">(</span><span class="n">val</span><span class="p">)</span> <span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">s</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Could not convert all entries to ints'</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_color_or_inherit"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_color_or_inherit">[docs]</a><span class="k">def</span> <span class="nf">validate_color_or_inherit</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="s1">'return a valid color arg'</span>
<span class="k">if</span> <span class="n">s</span> <span class="o">==</span> <span class="s1">'inherit'</span><span class="p">:</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">return</span> <span class="n">validate_color</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_color_or_auto"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_color_or_auto">[docs]</a><span class="k">def</span> <span class="nf">validate_color_or_auto</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="n">s</span> <span class="o">==</span> <span class="s1">'auto'</span><span class="p">:</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">return</span> <span class="n">validate_color</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_color_for_prop_cycle"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_color_for_prop_cycle">[docs]</a><span class="k">def</span> <span class="nf">validate_color_for_prop_cycle</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="c1"># Special-case the N-th color cycle syntax, this obviously can not</span>
<span class="c1"># go in the color cycle.</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
<span class="n">match</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">b</span><span class="s1">'^C[0-9]$'</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span>
<span class="k">if</span> <span class="n">match</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Can not put cycle reference (</span><span class="si">{cn!r}</span><span class="s1">) in '</span>
<span class="s1">'prop_cycler'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">cn</span><span class="o">=</span><span class="n">s</span><span class="p">))</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">match</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">'^C[0-9]$'</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span>
<span class="k">if</span> <span class="n">match</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Can not put cycle reference (</span><span class="si">{cn!r}</span><span class="s1">) in '</span>
<span class="s1">'prop_cycler'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">cn</span><span class="o">=</span><span class="n">s</span><span class="p">))</span>
<span class="k">return</span> <span class="n">validate_color</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_color"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_color">[docs]</a><span class="k">def</span> <span class="nf">validate_color</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="s1">'return a valid color arg'</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'none'</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">'none'</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">==</span> <span class="mi">6</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">==</span> <span class="mi">8</span><span class="p">:</span>
<span class="n">stmp</span> <span class="o">=</span> <span class="s1">'#'</span> <span class="o">+</span> <span class="n">s</span>
<span class="k">if</span> <span class="n">is_color_like</span><span class="p">(</span><span class="n">stmp</span><span class="p">):</span>
<span class="k">return</span> <span class="n">stmp</span>
<span class="k">if</span> <span class="n">is_color_like</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">return</span> <span class="n">s</span>
<span class="c1"># If it is still valid, it must be a tuple.</span>
<span class="n">colorarg</span> <span class="o">=</span> <span class="n">s</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s1">''</span>
<span class="k">if</span> <span class="n">s</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">','</span><span class="p">)</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">:</span>
<span class="c1"># get rid of grouping symbols</span>
<span class="n">stmp</span> <span class="o">=</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">c</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">s</span> <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">isdigit</span><span class="p">()</span> <span class="ow">or</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'.'</span> <span class="ow">or</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">','</span><span class="p">])</span>
<span class="n">vals</span> <span class="o">=</span> <span class="n">stmp</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">','</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">vals</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">]:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">Color tuples must be of length 3 or 4'</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">colorarg</span> <span class="o">=</span> <span class="p">[</span><span class="nb">float</span><span class="p">(</span><span class="n">val</span><span class="p">)</span> <span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">vals</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">Could not convert all entries to floats'</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">msg</span> <span class="ow">and</span> <span class="n">is_color_like</span><span class="p">(</span><span class="n">colorarg</span><span class="p">):</span>
<span class="k">return</span> <span class="n">colorarg</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'</span><span class="si">%s</span><span class="s1"> does not look like a color arg</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">msg</span><span class="p">))</span></div>
<span class="n">validate_colorlist</span> <span class="o">=</span> <span class="n">_listify_validator</span><span class="p">(</span><span class="n">validate_color</span><span class="p">,</span> <span class="n">allow_stringlist</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">validate_colorlist</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">'return a list of colorspecs'</span>
<div class="viewcode-block" id="validate_string"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_string">[docs]</a><span class="k">def</span> <span class="nf">validate_string</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">)):</span>
<span class="c1"># Always leave str as str and unicode as unicode</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>
<span class="n">validate_stringlist</span> <span class="o">=</span> <span class="n">_listify_validator</span><span class="p">(</span><span class="nb">str</span><span class="p">)</span>
<span class="n">validate_stringlist</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">'return a list'</span>
<span class="n">validate_orientation</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span>
<span class="s1">'orientation'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'landscape'</span><span class="p">,</span> <span class="s1">'portrait'</span><span class="p">])</span>
<div class="viewcode-block" id="validate_aspect"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_aspect">[docs]</a><span class="k">def</span> <span class="nf">validate_aspect</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'auto'</span><span class="p">,</span> <span class="s1">'equal'</span><span class="p">):</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'not a valid aspect specification'</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_fontsize"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_fontsize">[docs]</a><span class="k">def</span> <span class="nf">validate_fontsize</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">fontsizes</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'xx-small'</span><span class="p">,</span> <span class="s1">'x-small'</span><span class="p">,</span> <span class="s1">'small'</span><span class="p">,</span> <span class="s1">'medium'</span><span class="p">,</span> <span class="s1">'large'</span><span class="p">,</span>
<span class="s1">'x-large'</span><span class="p">,</span> <span class="s1">'xx-large'</span><span class="p">,</span> <span class="s1">'smaller'</span><span class="p">,</span> <span class="s1">'larger'</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">fontsizes</span><span class="p">:</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> is not a valid font size. Valid font sizes "</span>
<span class="s2">"are </span><span class="si">%s</span><span class="s2">."</span> <span class="o">%</span> <span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">fontsizes</span><span class="p">)))</span></div>
<span class="n">validate_fontsizelist</span> <span class="o">=</span> <span class="n">_listify_validator</span><span class="p">(</span><span class="n">validate_fontsize</span><span class="p">)</span>
<div class="viewcode-block" id="validate_font_properties"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_font_properties">[docs]</a><span class="k">def</span> <span class="nf">validate_font_properties</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">parse_fontconfig_pattern</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">return</span> <span class="n">s</span></div>
<span class="n">validate_fontset</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span>
<span class="s1">'fontset'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'dejavusans'</span><span class="p">,</span> <span class="s1">'dejavuserif'</span><span class="p">,</span> <span class="s1">'cm'</span><span class="p">,</span> <span class="s1">'stix'</span><span class="p">,</span> <span class="s1">'stixsans'</span><span class="p">,</span> <span class="s1">'custom'</span><span class="p">])</span>
<span class="n">validate_mathtext_default</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span>
<span class="s1">'default'</span><span class="p">,</span>
<span class="s2">"rm cal it tt sf bf default bb frak circled scr regular"</span><span class="o">.</span><span class="n">split</span><span class="p">())</span>
<span class="n">validate_verbose</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span>
<span class="s1">'verbose'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'silent'</span><span class="p">,</span> <span class="s1">'helpful'</span><span class="p">,</span> <span class="s1">'debug'</span><span class="p">,</span> <span class="s1">'debug-annoying'</span><span class="p">])</span>
<span class="n">_validate_alignment</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span>
<span class="s1">'alignment'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'center'</span><span class="p">,</span> <span class="s1">'top'</span><span class="p">,</span> <span class="s1">'bottom'</span><span class="p">,</span> <span class="s1">'baseline'</span><span class="p">,</span>
<span class="s1">'center_baseline'</span><span class="p">])</span>
<div class="viewcode-block" id="validate_whiskers"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_whiskers">[docs]</a><span class="k">def</span> <span class="nf">validate_whiskers</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="n">s</span> <span class="o">==</span> <span class="s1">'range'</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">'range'</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="n">validate_nseq_float</span><span class="p">(</span><span class="mi">2</span><span class="p">)(</span><span class="n">s</span><span class="p">)</span>
<span class="k">return</span> <span class="n">v</span>
<span class="k">except</span> <span class="p">(</span><span class="ne">TypeError</span><span class="p">,</span> <span class="ne">ValueError</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">return</span> <span class="n">v</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Not a valid whisker value ['range', float, "</span>
<span class="s2">"(float, float)]"</span><span class="p">)</span></div>
<div class="viewcode-block" id="update_savefig_format"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.update_savefig_format">[docs]</a><span class="k">def</span> <span class="nf">update_savefig_format</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="c1"># The old savefig.extension could also have a value of "auto", but</span>
<span class="c1"># the new savefig.format does not. We need to fix this here.</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">validate_string</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s1">'auto'</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="s1">'png'</span>
<span class="k">return</span> <span class="n">value</span></div>
<span class="n">validate_ps_papersize</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span>
<span class="s1">'ps_papersize'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'auto'</span><span class="p">,</span> <span class="s1">'letter'</span><span class="p">,</span> <span class="s1">'legal'</span><span class="p">,</span> <span class="s1">'ledger'</span><span class="p">,</span>
<span class="s1">'a0'</span><span class="p">,</span> <span class="s1">'a1'</span><span class="p">,</span> <span class="s1">'a2'</span><span class="p">,</span> <span class="s1">'a3'</span><span class="p">,</span> <span class="s1">'a4'</span><span class="p">,</span> <span class="s1">'a5'</span><span class="p">,</span> <span class="s1">'a6'</span><span class="p">,</span> <span class="s1">'a7'</span><span class="p">,</span> <span class="s1">'a8'</span><span class="p">,</span> <span class="s1">'a9'</span><span class="p">,</span> <span class="s1">'a10'</span><span class="p">,</span>
<span class="s1">'b0'</span><span class="p">,</span> <span class="s1">'b1'</span><span class="p">,</span> <span class="s1">'b2'</span><span class="p">,</span> <span class="s1">'b3'</span><span class="p">,</span> <span class="s1">'b4'</span><span class="p">,</span> <span class="s1">'b5'</span><span class="p">,</span> <span class="s1">'b6'</span><span class="p">,</span> <span class="s1">'b7'</span><span class="p">,</span> <span class="s1">'b8'</span><span class="p">,</span> <span class="s1">'b9'</span><span class="p">,</span> <span class="s1">'b10'</span><span class="p">,</span>
<span class="p">],</span> <span class="n">ignorecase</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<div class="viewcode-block" id="validate_ps_distiller"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_ps_distiller">[docs]</a><span class="k">def</span> <span class="nf">validate_ps_distiller</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'none'</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">elif</span> <span class="n">s</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'false'</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">elif</span> <span class="n">s</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'ghostscript'</span><span class="p">,</span> <span class="s1">'xpdf'</span><span class="p">):</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'matplotlibrc ps.usedistiller must either be none, '</span>
<span class="s1">'ghostscript or xpdf'</span><span class="p">)</span></div>
<span class="n">validate_joinstyle</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s1">'joinstyle'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'miter'</span><span class="p">,</span> <span class="s1">'round'</span><span class="p">,</span> <span class="s1">'bevel'</span><span class="p">],</span>
<span class="n">ignorecase</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">validate_joinstylelist</span> <span class="o">=</span> <span class="n">_listify_validator</span><span class="p">(</span><span class="n">validate_joinstyle</span><span class="p">)</span>
<span class="n">validate_capstyle</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s1">'capstyle'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'butt'</span><span class="p">,</span> <span class="s1">'round'</span><span class="p">,</span> <span class="s1">'projecting'</span><span class="p">],</span>
<span class="n">ignorecase</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">validate_capstylelist</span> <span class="o">=</span> <span class="n">_listify_validator</span><span class="p">(</span><span class="n">validate_capstyle</span><span class="p">)</span>
<span class="n">validate_fillstyle</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s1">'markers.fillstyle'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'full'</span><span class="p">,</span> <span class="s1">'left'</span><span class="p">,</span> <span class="s1">'right'</span><span class="p">,</span> <span class="s1">'bottom'</span><span class="p">,</span>
<span class="s1">'top'</span><span class="p">,</span> <span class="s1">'none'</span><span class="p">])</span>
<span class="n">validate_fillstylelist</span> <span class="o">=</span> <span class="n">_listify_validator</span><span class="p">(</span><span class="n">validate_fillstyle</span><span class="p">)</span>
<span class="n">_validate_negative_linestyle</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s1">'negative_linestyle'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'solid'</span><span class="p">,</span> <span class="s1">'dashed'</span><span class="p">],</span>
<span class="n">ignorecase</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<div class="viewcode-block" id="validate_negative_linestyle"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_negative_linestyle">[docs]</a><span class="nd">@deprecated</span><span class="p">(</span><span class="s1">'2.1'</span><span class="p">,</span>
<span class="n">addendum</span><span class="o">=</span><span class="p">(</span><span class="s2">" See 'validate_negative_linestyle_legacy' "</span> <span class="o">+</span>
<span class="s2">"deprecation warning for more information."</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">validate_negative_linestyle</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_validate_negative_linestyle</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_negative_linestyle_legacy"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_negative_linestyle_legacy">[docs]</a><span class="nd">@deprecated</span><span class="p">(</span><span class="s1">'2.1'</span><span class="p">,</span>
<span class="n">addendum</span><span class="o">=</span><span class="p">(</span><span class="s2">" The 'contour.negative_linestyle' rcParam now "</span> <span class="o">+</span>
<span class="s2">"follows the same validation as the other rcParams "</span> <span class="o">+</span>
<span class="s2">"that are related to line style."</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">validate_negative_linestyle_legacy</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">validate_negative_linestyle</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">return</span> <span class="n">res</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="n">dashes</span> <span class="o">=</span> <span class="n">validate_nseq_float</span><span class="p">(</span><span class="mi">2</span><span class="p">)(</span><span class="n">s</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">dashes</span><span class="p">)</span> <span class="c1"># (offset, (solid, blank))</span></div>
<span class="n">validate_legend_loc</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span>
<span class="s1">'legend_loc'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'best'</span><span class="p">,</span>
<span class="s1">'upper right'</span><span class="p">,</span>
<span class="s1">'upper left'</span><span class="p">,</span>
<span class="s1">'lower left'</span><span class="p">,</span>
<span class="s1">'lower right'</span><span class="p">,</span>
<span class="s1">'right'</span><span class="p">,</span>
<span class="s1">'center left'</span><span class="p">,</span>
<span class="s1">'center right'</span><span class="p">,</span>
<span class="s1">'lower center'</span><span class="p">,</span>
<span class="s1">'upper center'</span><span class="p">,</span>
<span class="s1">'center'</span><span class="p">],</span> <span class="n">ignorecase</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<div class="viewcode-block" id="validate_svg_fonttype"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_svg_fonttype">[docs]</a><span class="k">def</span> <span class="nf">validate_svg_fonttype</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"none"</span><span class="p">,</span> <span class="s2">"path"</span><span class="p">]:</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">if</span> <span class="n">s</span> <span class="o">==</span> <span class="s2">"svgfont"</span><span class="p">:</span>
<span class="n">cbook</span><span class="o">.</span><span class="n">warn_deprecated</span><span class="p">(</span>
<span class="s2">"2.2"</span><span class="p">,</span> <span class="s2">"'svgfont' support for svg.fonttype is deprecated."</span><span class="p">)</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Unrecognized svg.fonttype string '</span><span class="si">{}</span><span class="s2">'; "</span>
<span class="s2">"valid strings are 'none', 'path'"</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_hinting"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_hinting">[docs]</a><span class="k">def</span> <span class="nf">validate_hinting</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">in</span> <span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">if</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'auto'</span><span class="p">,</span> <span class="s1">'native'</span><span class="p">,</span> <span class="s1">'either'</span><span class="p">,</span> <span class="s1">'none'</span><span class="p">):</span>
<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"hinting should be 'auto', 'native', 'either' or 'none'"</span><span class="p">)</span></div>
<span class="n">validate_pgf_texsystem</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s1">'pgf.texsystem'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'xelatex'</span><span class="p">,</span> <span class="s1">'lualatex'</span><span class="p">,</span> <span class="s1">'pdflatex'</span><span class="p">])</span>
<span class="n">validate_movie_writer</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s1">'animation.writer'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'ffmpeg'</span><span class="p">,</span> <span class="s1">'ffmpeg_file'</span><span class="p">,</span>
<span class="s1">'avconv'</span><span class="p">,</span> <span class="s1">'avconv_file'</span><span class="p">,</span>
<span class="s1">'imagemagick'</span><span class="p">,</span> <span class="s1">'imagemagick_file'</span><span class="p">,</span>
<span class="s1">'html'</span><span class="p">])</span>
<span class="n">validate_movie_frame_fmt</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s1">'animation.frame_format'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'png'</span><span class="p">,</span> <span class="s1">'jpeg'</span><span class="p">,</span> <span class="s1">'tiff'</span><span class="p">,</span> <span class="s1">'raw'</span><span class="p">,</span> <span class="s1">'rgba'</span><span class="p">])</span>
<span class="n">validate_axis_locator</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s1">'major'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'minor'</span><span class="p">,</span> <span class="s1">'both'</span><span class="p">,</span> <span class="s1">'major'</span><span class="p">])</span>
<span class="n">validate_movie_html_fmt</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s1">'animation.html'</span><span class="p">,</span>
<span class="p">[</span><span class="s1">'html5'</span><span class="p">,</span> <span class="s1">'jshtml'</span><span class="p">,</span> <span class="s1">'none'</span><span class="p">])</span>
<div class="viewcode-block" id="validate_bbox"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_bbox">[docs]</a><span class="k">def</span> <span class="nf">validate_bbox</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="n">s</span> <span class="o">==</span> <span class="s1">'tight'</span><span class="p">:</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">if</span> <span class="n">s</span> <span class="o">==</span> <span class="s1">'standard'</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"bbox should be 'tight' or 'standard'"</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">s</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Backwards compatibility. None is equivalent to 'standard'.</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"bbox should be 'tight' or 'standard'"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">s</span></div>
<div class="viewcode-block" id="validate_sketch"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_sketch">[docs]</a><span class="k">def</span> <span class="nf">validate_sketch</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="n">s</span> <span class="o">==</span> <span class="s1">'none'</span> <span class="ow">or</span> <span class="n">s</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">result</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">([</span><span class="nb">float</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">s</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">','</span><span class="p">)])</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="n">result</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">([</span><span class="nb">float</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">s</span><span class="p">])</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">3</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"path.sketch must be a tuple (scale, length, randomness)"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span></div>
<div class="viewcode-block" id="ValidateInterval"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.ValidateInterval">[docs]</a><span class="k">class</span> <span class="nc">ValidateInterval</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Value must be in interval</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vmin</span><span class="p">,</span> <span class="n">vmax</span><span class="p">,</span> <span class="n">closedmin</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">closedmax</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vmin</span> <span class="o">=</span> <span class="n">vmin</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vmax</span> <span class="o">=</span> <span class="n">vmax</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cmin</span> <span class="o">=</span> <span class="n">closedmin</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cmax</span> <span class="o">=</span> <span class="n">closedmax</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'Value must be a float; found "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="n">s</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmin</span> <span class="ow">and</span> <span class="n">s</span> <span class="o"><</span> <span class="bp">self</span><span class="o">.</span><span class="n">vmin</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'Value must be >= </span><span class="si">%f</span><span class="s1">; found "</span><span class="si">%f</span><span class="s1">"'</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">vmin</span><span class="p">,</span> <span class="n">s</span><span class="p">))</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmin</span> <span class="ow">and</span> <span class="n">s</span> <span class="o"><=</span> <span class="bp">self</span><span class="o">.</span><span class="n">vmin</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'Value must be > </span><span class="si">%f</span><span class="s1">; found "</span><span class="si">%f</span><span class="s1">"'</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">vmin</span><span class="p">,</span> <span class="n">s</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmax</span> <span class="ow">and</span> <span class="n">s</span> <span class="o">></span> <span class="bp">self</span><span class="o">.</span><span class="n">vmax</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'Value must be <= </span><span class="si">%f</span><span class="s1">; found "</span><span class="si">%f</span><span class="s1">"'</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">vmax</span><span class="p">,</span> <span class="n">s</span><span class="p">))</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmax</span> <span class="ow">and</span> <span class="n">s</span> <span class="o">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">vmax</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'Value must be < </span><span class="si">%f</span><span class="s1">; found "</span><span class="si">%f</span><span class="s1">"'</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">vmax</span><span class="p">,</span> <span class="n">s</span><span class="p">))</span>
<span class="k">return</span> <span class="n">s</span></div>
<span class="n">validate_grid_axis</span> <span class="o">=</span> <span class="n">ValidateInStrings</span><span class="p">(</span><span class="s1">'axes.grid.axis'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'x'</span><span class="p">,</span> <span class="s1">'y'</span><span class="p">,</span> <span class="s1">'both'</span><span class="p">])</span>
<div class="viewcode-block" id="validate_hatch"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_hatch">[docs]</a><span class="k">def</span> <span class="nf">validate_hatch</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Validate a hatch pattern.</span>
<span class="sd"> A hatch pattern string can have any sequence of the following</span>
<span class="sd"> characters: ``\\ / | - + * . x o O``.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Hatch pattern must be a string"</span><span class="p">)</span>
<span class="n">unknown</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">-</span> <span class="p">{</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'/'</span><span class="p">,</span> <span class="s1">'|'</span><span class="p">,</span> <span class="s1">'-'</span><span class="p">,</span> <span class="s1">'+'</span><span class="p">,</span> <span class="s1">'*'</span><span class="p">,</span> <span class="s1">'.'</span><span class="p">,</span> <span class="s1">'x'</span><span class="p">,</span> <span class="s1">'o'</span><span class="p">,</span> <span class="s1">'O'</span><span class="p">}</span>
<span class="k">if</span> <span class="n">unknown</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Unknown hatch symbol(s): </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="nb">list</span><span class="p">(</span><span class="n">unknown</span><span class="p">))</span>
<span class="k">return</span> <span class="n">s</span></div>
<span class="n">validate_hatchlist</span> <span class="o">=</span> <span class="n">_listify_validator</span><span class="p">(</span><span class="n">validate_hatch</span><span class="p">)</span>
<span class="n">validate_dashlist</span> <span class="o">=</span> <span class="n">_listify_validator</span><span class="p">(</span><span class="n">validate_nseq_float</span><span class="p">(</span><span class="n">allow_none</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span>
<span class="n">_prop_validators</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'color'</span><span class="p">:</span> <span class="n">_listify_validator</span><span class="p">(</span><span class="n">validate_color_for_prop_cycle</span><span class="p">,</span>
<span class="n">allow_stringlist</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span>
<span class="s1">'linewidth'</span><span class="p">:</span> <span class="n">validate_floatlist</span><span class="p">,</span>
<span class="s1">'linestyle'</span><span class="p">:</span> <span class="n">validate_stringlist</span><span class="p">,</span>
<span class="s1">'facecolor'</span><span class="p">:</span> <span class="n">validate_colorlist</span><span class="p">,</span>
<span class="s1">'edgecolor'</span><span class="p">:</span> <span class="n">validate_colorlist</span><span class="p">,</span>
<span class="s1">'joinstyle'</span><span class="p">:</span> <span class="n">validate_joinstylelist</span><span class="p">,</span>
<span class="s1">'capstyle'</span><span class="p">:</span> <span class="n">validate_capstylelist</span><span class="p">,</span>
<span class="s1">'fillstyle'</span><span class="p">:</span> <span class="n">validate_fillstylelist</span><span class="p">,</span>
<span class="s1">'markerfacecolor'</span><span class="p">:</span> <span class="n">validate_colorlist</span><span class="p">,</span>
<span class="s1">'markersize'</span><span class="p">:</span> <span class="n">validate_floatlist</span><span class="p">,</span>
<span class="s1">'markeredgewidth'</span><span class="p">:</span> <span class="n">validate_floatlist</span><span class="p">,</span>
<span class="s1">'markeredgecolor'</span><span class="p">:</span> <span class="n">validate_colorlist</span><span class="p">,</span>
<span class="s1">'alpha'</span><span class="p">:</span> <span class="n">validate_floatlist</span><span class="p">,</span>
<span class="s1">'marker'</span><span class="p">:</span> <span class="n">validate_stringlist</span><span class="p">,</span>
<span class="s1">'hatch'</span><span class="p">:</span> <span class="n">validate_hatchlist</span><span class="p">,</span>
<span class="s1">'dashes'</span><span class="p">:</span> <span class="n">validate_dashlist</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">_prop_aliases</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'c'</span><span class="p">:</span> <span class="s1">'color'</span><span class="p">,</span>
<span class="s1">'lw'</span><span class="p">:</span> <span class="s1">'linewidth'</span><span class="p">,</span>
<span class="s1">'ls'</span><span class="p">:</span> <span class="s1">'linestyle'</span><span class="p">,</span>
<span class="s1">'fc'</span><span class="p">:</span> <span class="s1">'facecolor'</span><span class="p">,</span>
<span class="s1">'ec'</span><span class="p">:</span> <span class="s1">'edgecolor'</span><span class="p">,</span>
<span class="s1">'mfc'</span><span class="p">:</span> <span class="s1">'markerfacecolor'</span><span class="p">,</span>
<span class="s1">'mec'</span><span class="p">:</span> <span class="s1">'markeredgecolor'</span><span class="p">,</span>
<span class="s1">'mew'</span><span class="p">:</span> <span class="s1">'markeredgewidth'</span><span class="p">,</span>
<span class="s1">'ms'</span><span class="p">:</span> <span class="s1">'markersize'</span><span class="p">,</span>
<span class="p">}</span>
<div class="viewcode-block" id="cycler"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.cycler">[docs]</a><span class="k">def</span> <span class="nf">cycler</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Creates a `~cycler.Cycler` object much like :func:`cycler.cycler`,</span>
<span class="sd"> but includes input validation.</span>
<span class="sd"> Call signatures::</span>
<span class="sd"> cycler(cycler)</span>
<span class="sd"> cycler(label=values[, label2=values2[, ...]])</span>
<span class="sd"> cycler(label, values)</span>
<span class="sd"> Form 1 copies a given `~cycler.Cycler` object.</span>
<span class="sd"> Form 2 creates a `~cycler.Cycler` which cycles over one or more</span>
<span class="sd"> properties simultaneously. If multiple properties are given, their</span>
<span class="sd"> value lists must have the same length.</span>
<span class="sd"> Form 3 creates a `~cycler.Cycler` for a single property. This form</span>
<span class="sd"> exists for compatibility with the original cycler. Its use is</span>
<span class="sd"> discouraged in favor of the kwarg form, i.e. ``cycler(label=values)``.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> cycler : Cycler</span>
<span class="sd"> Copy constructor for Cycler.</span>
<span class="sd"> label : str</span>
<span class="sd"> The property key. Must be a valid `.Artist` property.</span>
<span class="sd"> For example, 'color' or 'linestyle'. Aliases are allowed,</span>
<span class="sd"> such as 'c' for 'color' and 'lw' for 'linewidth'.</span>
<span class="sd"> values : iterable</span>
<span class="sd"> Finite-length iterable of the property values. These values</span>
<span class="sd"> are validated and will raise a ValueError if invalid.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> cycler : Cycler</span>
<span class="sd"> A new :class:`~cycler.Cycler` for the given properties.</span>
<span class="sd"> Examples</span>
<span class="sd"> --------</span>
<span class="sd"> Creating a cycler for a single property:</span>
<span class="sd"> >>> c = cycler(color=['red', 'green', 'blue'])</span>
<span class="sd"> Creating a cycler for simultaneously cycling over multiple properties</span>
<span class="sd"> (e.g. red circle, green plus, blue cross):</span>
<span class="sd"> >>> c = cycler(color=['red', 'green', 'blue'],</span>
<span class="sd"> ... marker=['o', '+', 'x'])</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">args</span> <span class="ow">and</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"cycler() can only accept positional OR keyword "</span>
<span class="s2">"arguments -- not both."</span><span class="p">)</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">args</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"cycler() must have positional OR keyword arguments"</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">Cycler</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"If only one positional argument given, it must "</span>
<span class="s2">" be a Cycler instance."</span><span class="p">)</span>
<span class="k">return</span> <span class="n">validate_cycler</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">pairs</span> <span class="o">=</span> <span class="p">[(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">])]</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">></span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"No more than 2 positional arguments allowed"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">pairs</span> <span class="o">=</span> <span class="n">six</span><span class="o">.</span><span class="n">iteritems</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">validated</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">prop</span><span class="p">,</span> <span class="n">vals</span> <span class="ow">in</span> <span class="n">pairs</span><span class="p">:</span>
<span class="n">norm_prop</span> <span class="o">=</span> <span class="n">_prop_aliases</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">prop</span><span class="p">,</span> <span class="n">prop</span><span class="p">)</span>
<span class="n">validator</span> <span class="o">=</span> <span class="n">_prop_validators</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">norm_prop</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">validator</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"Unknown artist property: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">prop</span><span class="p">)</span>
<span class="n">vals</span> <span class="o">=</span> <span class="n">validator</span><span class="p">(</span><span class="n">vals</span><span class="p">)</span>
<span class="c1"># We will normalize the property names as well to reduce</span>
<span class="c1"># the amount of alias handling code elsewhere.</span>
<span class="n">validated</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">norm_prop</span><span class="p">,</span> <span class="n">vals</span><span class="p">))</span>
<span class="k">return</span> <span class="n">reduce</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span> <span class="p">(</span><span class="n">ccycler</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">validated</span><span class="p">))</span></div>
<div class="viewcode-block" id="validate_cycler"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_cycler">[docs]</a><span class="k">def</span> <span class="nf">validate_cycler</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="s1">'return a Cycler object from a string repr or the object itself'</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># TODO: We might want to rethink this...</span>
<span class="c1"># While I think I have it quite locked down,</span>
<span class="c1"># it is execution of arbitrary code without</span>
<span class="c1"># sanitation.</span>
<span class="c1"># Combine this with the possibility that rcparams</span>
<span class="c1"># might come from the internet (future plans), this</span>
<span class="c1"># could be downright dangerous.</span>
<span class="c1"># I locked it down by only having the 'cycler()' function</span>
<span class="c1"># available.</span>
<span class="c1"># UPDATE: Partly plugging a security hole.</span>
<span class="c1"># I really should have read this:</span>
<span class="c1"># http://nedbatchelder.com/blog/201206/eval_really_is_dangerous.html</span>
<span class="c1"># We should replace this eval with a combo of PyParsing and</span>
<span class="c1"># ast.literal_eval()</span>
<span class="k">if</span> <span class="s1">'.__'</span> <span class="ow">in</span> <span class="n">s</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"'</span><span class="si">%s</span><span class="s2">' seems to have dunder methods. Raising"</span>
<span class="s2">" an exception for your safety"</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <span class="nb">eval</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="p">{</span><span class="s1">'cycler'</span><span class="p">:</span> <span class="n">cycler</span><span class="p">,</span> <span class="s1">'__builtins__'</span><span class="p">:</span> <span class="p">{}})</span>
<span class="k">except</span> <span class="ne">BaseException</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"'</span><span class="si">%s</span><span class="s2">' is not a valid cycler construction: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">e</span><span class="p">))</span>
<span class="c1"># Should make sure what comes from the above eval()</span>
<span class="c1"># is a Cycler object.</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">Cycler</span><span class="p">):</span>
<span class="n">cycler_inst</span> <span class="o">=</span> <span class="n">s</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"object was not a string or Cycler instance: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">s</span><span class="p">)</span>
<span class="n">unknowns</span> <span class="o">=</span> <span class="n">cycler_inst</span><span class="o">.</span><span class="n">keys</span> <span class="o">-</span> <span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">_prop_validators</span><span class="p">)</span> <span class="o">|</span> <span class="nb">set</span><span class="p">(</span><span class="n">_prop_aliases</span><span class="p">))</span>
<span class="k">if</span> <span class="n">unknowns</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Unknown artist properties: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">unknowns</span><span class="p">)</span>
<span class="c1"># Not a full validation, but it'll at least normalize property names</span>
<span class="c1"># A fuller validation would require v0.10 of cycler.</span>
<span class="n">checker</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="n">cycler_inst</span><span class="o">.</span><span class="n">keys</span><span class="p">:</span>
<span class="n">norm_prop</span> <span class="o">=</span> <span class="n">_prop_aliases</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">prop</span><span class="p">,</span> <span class="n">prop</span><span class="p">)</span>
<span class="k">if</span> <span class="n">norm_prop</span> <span class="o">!=</span> <span class="n">prop</span> <span class="ow">and</span> <span class="n">norm_prop</span> <span class="ow">in</span> <span class="n">cycler_inst</span><span class="o">.</span><span class="n">keys</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Cannot specify both '</span><span class="si">{0}</span><span class="s2">' and alias '</span><span class="si">{1}</span><span class="s2">'"</span>
<span class="s2">" in the same prop_cycle"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">norm_prop</span><span class="p">,</span> <span class="n">prop</span><span class="p">))</span>
<span class="k">if</span> <span class="n">norm_prop</span> <span class="ow">in</span> <span class="n">checker</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Another property was already aliased to '</span><span class="si">{0}</span><span class="s2">'."</span>
<span class="s2">" Collision normalizing '</span><span class="si">{1}</span><span class="s2">'."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">norm_prop</span><span class="p">,</span>
<span class="n">prop</span><span class="p">))</span>
<span class="n">checker</span><span class="o">.</span><span class="n">update</span><span class="p">([</span><span class="n">norm_prop</span><span class="p">])</span>
<span class="c1"># This is just an extra-careful check, just in case there is some</span>
<span class="c1"># edge-case I haven't thought of.</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">checker</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">cycler_inst</span><span class="o">.</span><span class="n">keys</span><span class="p">)</span>
<span class="c1"># Now, it should be safe to mutate this cycler</span>
<span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="n">cycler_inst</span><span class="o">.</span><span class="n">keys</span><span class="p">:</span>
<span class="n">norm_prop</span> <span class="o">=</span> <span class="n">_prop_aliases</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">prop</span><span class="p">,</span> <span class="n">prop</span><span class="p">)</span>
<span class="n">cycler_inst</span><span class="o">.</span><span class="n">change_key</span><span class="p">(</span><span class="n">prop</span><span class="p">,</span> <span class="n">norm_prop</span><span class="p">)</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">vals</span> <span class="ow">in</span> <span class="n">cycler_inst</span><span class="o">.</span><span class="n">by_key</span><span class="p">()</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">_prop_validators</span><span class="p">[</span><span class="n">key</span><span class="p">](</span><span class="n">vals</span><span class="p">)</span>
<span class="k">return</span> <span class="n">cycler_inst</span></div>
<div class="viewcode-block" id="validate_hist_bins"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_hist_bins">[docs]</a><span class="k">def</span> <span class="nf">validate_hist_bins</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span> <span class="o">==</span> <span class="s1">'auto'</span><span class="p">:</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="p">(</span><span class="ne">TypeError</span><span class="p">,</span> <span class="ne">ValueError</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">validate_floatlist</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"'hist.bins' must be 'auto', an int or "</span> <span class="o">+</span>
<span class="s2">"a sequence of floats"</span><span class="p">)</span></div>