-
Notifications
You must be signed in to change notification settings - Fork 95
Expand file tree
/
Copy pathrcsetup.py
More file actions
2096 lines (1999 loc) · 66.5 KB
/
Copy pathrcsetup.py
File metadata and controls
2096 lines (1999 loc) · 66.5 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
#!/usr/bin/env python3
"""
Utilities for global configuration.
"""
import functools
import re
from collections.abc import MutableMapping
from numbers import Integral, Real
import matplotlib.rcsetup as msetup
import numpy as np
from cycler import Cycler
from matplotlib import RcParams
from matplotlib import rcParamsDefault as _rc_matplotlib_native
from matplotlib.colors import Colormap
from matplotlib.font_manager import font_scalings
from matplotlib.fontconfig_pattern import parse_fontconfig_pattern
from . import ic # noqa: F401
from . import warnings
from .versions import _version_mpl
# Regex for "probable" unregistered named colors. Try to retain warning message for
# colors that were most likely a failed literal string evaluation during startup.
REGEX_NAMED_COLOR = re.compile(r'\A[a-zA-Z0-9:_ -]*\Z')
# Configurable validation settings
# NOTE: These are set to True inside __init__.py
# NOTE: We really cannot delay creation of 'rc' until after registration because
# colormap creation depends on rc['cmap.lut'] and rc['cmap.listedthresh'].
# And anyway to revoke that dependence would require other uglier kludges.
VALIDATE_REGISTERED_CMAPS = False
VALIDATE_REGISTERED_COLORS = False
# Initial synced properties
# NOTE: Important that LINEWIDTH is less than matplotlib default of 0.8.
# In general want axes lines to look about as thick as text.
# NOTE: Important that default values are equivalent to the *validated* values
# used in the RcParams dictionaries. Otherwise _user_settings() detects changes.
# NOTE: We *could* just leave some settings empty and leave it up to Configurator
# to sync them when proplot is imported... but also sync them here so that we can
# simply compare any Configurator state to these dictionaries and use save() to
# save only the settings changed by the user.
BLACK = 'black'
CYCLE = 'colorblind'
CMAPCYC = 'twilight'
CMAPDIV = 'BuRd'
CMAPSEQ = 'Fire'
CMAPCAT = 'colorblind10'
DIVERGING = 'div'
FRAMEALPHA = 0.8 # legend and colorbar
FONTNAME = 'sans-serif'
FONTSIZE = 9.0
GRIDALPHA = 0.1
GRIDBELOW = 'line'
GRIDPAD = 3.0
GRIDRATIO = 0.5 # differentiated from major by half size reduction
GRIDSTYLE = '-'
LABELPAD = 4.0 # default is 4.0, previously was 3.0
LARGESIZE = 'med-large'
LINEWIDTH = 0.6
MARGIN = 0.05
MATHTEXT = False
SMALLSIZE = 'medium'
TICKDIR = 'out'
TICKLEN = 4.0
TICKLENRATIO = 0.5 # very noticeable length reduction
TICKMINOR = True
TICKPAD = 2.0
TICKWIDTHRATIO = 0.8 # very slight width reduction
TITLEPAD = 5.0 # default is 6.0, previously was 3.0
WHITE = 'white'
ZLINES = 2 # default zorder for lines
ZPATCHES = 1
# Preset legend locations and aliases
LEGEND_LOCS = {
'fill': 'fill',
'inset': 'best',
'i': 'best',
0: 'best', # offsetbox codes
1: 'upper right',
2: 'upper left',
3: 'lower left',
4: 'lower right',
5: 'center right', # weird, but see _get_anchored_bbox in matplotlib/offsetbox.py
6: 'center left',
7: 'center right',
8: 'lower center',
9: 'upper center',
10: 'center',
'l': 'left', # custom shorthands
'r': 'right',
'b': 'bottom',
't': 'top',
'c': 'center',
'ur': 'upper right',
'ul': 'upper left',
'll': 'lower left',
'lr': 'lower right',
'cl': 'center left',
'cr': 'center right',
'uc': 'upper center',
'lc': 'lower center',
'ne': 'upper right', # BboxBase.anchored shorthands
'nw': 'upper left',
'sw': 'lower left',
'se': 'lower right',
'w': 'center left',
'e': 'center right',
's': 'lower center',
'n': 'upper center',
}
for _loc in set(LEGEND_LOCS.values()):
LEGEND_LOCS[_loc] = _loc # identity assignments
TEXT_LOCS = {
key: val for key, val in LEGEND_LOCS.items() if val in (
'left', 'center', 'right',
'upper left', 'upper center', 'upper right',
'lower left', 'lower center', 'lower right',
)
}
COLORBAR_LOCS = {
key: val for key, val in LEGEND_LOCS.items() if val in (
'fill', 'best',
'left', 'right', 'top', 'bottom',
'upper left', 'upper right', 'lower left', 'lower right',
)
}
PANEL_LOCS = {
key: val for key, val in LEGEND_LOCS.items() if val in (
'left', 'right', 'top', 'bottom'
)
}
ALIGN_LOCS = {
key: val for key, val in LEGEND_LOCS.items() if isinstance(key, str) and val in (
'left', 'right', 'top', 'bottom', 'center',
)
}
# Matplotlib setting categories
EM_KEYS = ( # em-width units
'legend.borderpad',
'legend.labelspacing',
'legend.handlelength',
'legend.handleheight',
'legend.handletextpad',
'legend.borderaxespad',
'legend.columnspacing',
)
PT_KEYS = (
'font.size', # special case
'xtick.major.size',
'xtick.minor.size',
'ytick.major.size',
'ytick.minor.size',
'xtick.major.pad',
'xtick.minor.pad',
'ytick.major.pad',
'ytick.minor.pad',
'xtick.major.width',
'xtick.minor.width',
'ytick.major.width',
'ytick.minor.width',
'axes.labelpad',
'axes.titlepad',
'axes.linewidth',
'grid.linewidth',
'patch.linewidth',
'hatch.linewidth',
'lines.linewidth',
'contour.linewidth',
)
FONT_KEYS = set() # dynamically add to this below
def _get_default_param(key):
"""
Get the default parameter from one of three places. This is used for
the :rc: role when compiling docs and when saving proplotrc files.
"""
sentinel = object()
for dict_ in (
_rc_proplot_default,
_rc_matplotlib_default, # imposed defaults
_rc_matplotlib_native, # native defaults
):
value = dict_.get(key, sentinel)
if value is not sentinel:
return value
raise KeyError(f'Invalid key {key!r}.')
def _validate_abc(value):
"""
Validate a-b-c setting.
"""
try:
if np.iterable(value):
return all(map(_validate_bool, value))
else:
return _validate_bool(value)
except ValueError:
pass
if isinstance(value, str):
if 'a' in value.lower():
return value
else:
if all(isinstance(_, str) for _ in value):
return tuple(value)
raise ValueError(
"A-b-c setting must be string containing 'a' or 'A' or sequence of strings."
)
def _validate_belongs(*options):
"""
Return a validator ensuring the item belongs in the list.
"""
def _validate_belongs(value): # noqa: E306
for opt in options:
if isinstance(value, str) and isinstance(opt, str):
if value.lower() == opt.lower(): # noqa: E501
return opt
elif value is True or value is False or value is None:
if value is opt:
return opt
elif value == opt:
return opt
raise ValueError(
f'Invalid value {value!r}. Options are: '
+ ', '.join(map(repr, options))
+ '.'
)
return _validate_belongs
def _validate_cmap(subtype):
"""
Validate the colormap or cycle. Possibly skip name registration check
and assign the colormap name rather than a colormap instance.
"""
def _validate_cmap(value):
name = value
if isinstance(value, str):
if VALIDATE_REGISTERED_CMAPS:
from ..colors import _get_cmap_subtype
_get_cmap_subtype(name, subtype) # may trigger useful error message
return name
elif isinstance(value, Colormap):
name = getattr(value, 'name', None)
if isinstance(name, str):
from ..colors import _cmap_database # avoid circular imports
_cmap_database[name] = value
return name
raise ValueError(f'Invalid colormap or color cycle name {name!r}.')
return _validate_cmap
def _validate_color(value, alternative=None):
"""
Validate the color. Possibly skip name registration check.
"""
if alternative and isinstance(value, str) and value.lower() == alternative:
return value
try:
return msetup.validate_color(value)
except ValueError:
if (
VALIDATE_REGISTERED_COLORS
or not isinstance(value, str)
or not REGEX_NAMED_COLOR.match(value)
):
raise ValueError(f'{value!r} is not a valid color arg.') from None
return value
except Exception as error:
raise error
def _validate_fontprops(s):
"""
Parse font property with support for ``'regular'`` placeholder.
"""
b = s.startswith('regular')
if b:
s = s.replace('regular', 'sans', 1)
parse_fontconfig_pattern(s)
if b:
s = s.replace('sans', 'regular', 1)
return s
def _validate_fontsize(value):
"""
Validate font size with new scalings and permitting other units.
"""
if value is None and None in font_scalings: # has it always been this way?
return
if isinstance(value, str):
value = value.lower()
if value in font_scalings:
return value
try:
return _validate_pt(value) # note None is also a valid font size!
except ValueError:
pass
raise ValueError(
f'Invalid font size {value!r}. Can be points or one of the '
'preset scalings: ' + ', '.join(map(repr, font_scalings)) + '.'
)
def _validate_labels(labels, lon=True):
"""
Convert labels argument to length-4 boolean array.
"""
if labels is None:
return [None] * 4
which = 'lon' if lon else 'lat'
if isinstance(labels, str):
labels = (labels,)
array = np.atleast_1d(labels).tolist()
if all(isinstance(_, str) for _ in array):
bool_ = [False] * 4
opts = ('left', 'right', 'bottom', 'top')
for string in array:
if string in opts:
string = string[0]
elif set(string) - set('lrbt'):
raise ValueError(
f'Invalid {which}label string {string!r}. Must be one of '
+ ', '.join(map(repr, opts))
+ " or a string of single-letter characters like 'lr'."
)
for char in string:
bool_['lrbt'.index(char)] = True
array = bool_
if len(array) == 1:
array.append(False) # default is to label bottom or left
if len(array) == 2:
if lon:
array = [False, False, *array]
else:
array = [*array, False, False]
if len(array) != 4 or any(isinstance(_, str) for _ in array):
raise ValueError(f'Invalid {which}label spec: {labels}.')
return array
def _validate_or_none(validator):
"""
Allow none otherwise pass to the input validator.
"""
@functools.wraps(validator)
def _validate_or_none(value):
if value is None:
return
if isinstance(value, str) and value.lower() == 'none':
return
return validator(value)
_validate_or_none.__name__ = validator.__name__ + '_or_none'
return _validate_or_none
def _validate_rotation(value):
"""
Valid rotation arguments.
"""
if isinstance(value, str) and value.lower() in ('horizontal', 'vertical'):
return value
return _validate_float(value)
def _validate_units(dest):
"""
Validate the input using the units function.
"""
def _validate_units(value):
if isinstance(value, str):
from ..utils import units # avoid circular imports
value = units(value, dest) # validation happens here
return _validate_float(value)
return _validate_units
def _rst_table():
"""
Return the setting names and descriptions in an RST-style table.
"""
# Initial stuff
colspace = 2 # spaces between each column
descrips = tuple(descrip for (_, _, descrip) in _rc_proplot_table.values())
keylen = len(max((*_rc_proplot_table, 'Key'), key=len)) + 4 # literal backticks
vallen = len(max((*descrips, 'Description'), key=len))
divider = '=' * keylen + ' ' * colspace + '=' * vallen + '\n'
header = 'Key' + ' ' * (keylen - 3 + colspace) + 'Description\n'
# Build table
string = divider + header + divider
for key, (_, _, descrip) in _rc_proplot_table.items():
spaces = ' ' * (keylen - (len(key) + 4) + colspace)
string += f'``{key}``{spaces}{descrip}\n'
string = string + divider
return '.. rst-class:: proplot-rctable\n\n' + string.strip()
def _to_string(value):
"""
Translate setting to a string suitable for saving.
"""
# NOTE: Never safe hex strings with leading '#'. In both matplotlibrc
# and proplotrc this will be read as comment character.
if value is None or isinstance(value, (str, bool, Integral)):
value = str(value)
if value[:1] == '#': # i.e. a HEX string
value = value[1:]
elif isinstance(value, Real):
value = str(round(value, 6)) # truncate decimals
elif isinstance(value, Cycler):
value = repr(value) # special case!
elif isinstance(value, (list, tuple, np.ndarray)):
value = ', '.join(map(_to_string, value)) # sexy recursion
else:
value = None
return value
def _yaml_table(rcdict, comment=True, description=False):
"""
Return the settings as a nicely tabulated YAML-style table.
"""
prefix = '# ' if comment else ''
data = []
for key, args in rcdict.items():
# Optionally append description
includes_descrip = isinstance(args, tuple) and len(args) == 3
if not description:
descrip = ''
value = args[0] if includes_descrip else args
elif includes_descrip:
value, validator, descrip = args
descrip = '# ' + descrip # skip the validator
else:
raise ValueError(f'Unexpected input {key}={args!r}.')
# Translate object to string
value = _to_string(value)
if value is not None:
data.append((key, value, descrip))
else:
warnings._warn_proplot(
f'Failed to write rc setting {key} = {value!r}. Must be None, bool, '
'string, int, float, a list or tuple thereof, or a property cycler.'
)
# Generate string
string = ''
keylen = len(max(rcdict, key=len))
vallen = len(max((tup[1] for tup in data), key=len))
for key, value, descrip in data:
space1 = ' ' * (keylen - len(key) + 1)
space2 = ' ' * (vallen - len(value) + 2) if descrip else ''
string += f'{prefix}{key}:{space1}{value}{space2}{descrip}\n'
return string.strip()
class _RcParams(MutableMapping, dict):
"""
A simple dictionary with locked inputs and validated assignments.
"""
# NOTE: By omitting __delitem__ in MutableMapping we effectively
# disable mutability. Also disables deleting items with pop().
def __init__(self, source, validate):
self._validate = validate
for key, value in source.items():
self.__setitem__(key, value) # trigger validation
def __repr__(self):
return RcParams.__repr__(self)
def __str__(self):
return RcParams.__repr__(self)
def __len__(self):
return dict.__len__(self)
def __iter__(self):
# NOTE: Proplot doesn't add deprecated args to dictionary so
# we don't have to suppress warning messages here.
yield from sorted(dict.__iter__(self))
def __getitem__(self, key):
key, _ = self._check_key(key)
return dict.__getitem__(self, key)
def __setitem__(self, key, value):
key, value = self._check_key(key, value)
if key not in self._validate:
raise KeyError(f'Invalid rc key {key!r}.')
try:
value = self._validate[key](value)
except (ValueError, TypeError) as error:
raise ValueError(f'Key {key}: {error}') from None
if key is not None:
dict.__setitem__(self, key, value)
@staticmethod
def _check_key(key, value=None):
# NOTE: If we assigned from the Configurator then the deprecated key will
# still propagate to the same 'children' as the new key.
# NOTE: This also translates values for special cases of renamed keys.
# Currently the special cases are 'basemap' and 'cartopy.autoextent'.
if key in _rc_renamed:
key_new, version = _rc_renamed[key]
warnings._warn_proplot(
f'The rc setting {key!r} was deprecated in version {version} and may be ' # noqa: E501
f'removed in {warnings._next_release()}. Please use {key_new!r} instead.' # noqa: E501
)
if key == 'basemap': # special case
value = ('cartopy', 'basemap')[int(bool(value))]
if key == 'cartopy.autoextent':
value = ('globe', 'auto')[int(bool(value))]
key = key_new
if key in _rc_removed:
info, version = _rc_removed[key]
raise KeyError(
f'The rc setting {key!r} was removed in version {version}.'
+ (info and ' ' + info)
)
return key, value
def copy(self):
source = {key: dict.__getitem__(self, key) for key in self}
return _RcParams(source, self._validate)
# Borrow validators from matplotlib and construct some new ones
# WARNING: Instead of validate_fontweight matplotlib used validate_string
# until version 3.1.2. So use that as backup here.
# WARNING: We create custom 'or none' validators since their
# availability seems less consistent across matplotlib versions.
_validate_pt = _validate_units('pt')
_validate_em = _validate_units('em')
_validate_in = _validate_units('in')
_validate_bool = msetup.validate_bool
_validate_int = msetup.validate_int
_validate_float = msetup.validate_float
_validate_string = msetup.validate_string
_validate_fontname = msetup.validate_stringlist # same as 'font.family'
_validate_fontweight = getattr(msetup, 'validate_fontweight', _validate_string)
# Special style validators
# See: https://matplotlib.org/stable/api/_as_gen/matplotlib.patches.FancyBboxPatch.html
_validate_boxstyle = _validate_belongs(
'square', 'circle', 'round', 'round4', 'sawtooth', 'roundtooth',
)
if hasattr(msetup, '_validate_linestyle'): # fancy validation including dashes
_validate_linestyle = msetup._validate_linestyle
else: # no dashes allowed then but no big deal
_validate_linestyle = _validate_belongs(
'-', ':', '--', '-.', 'solid', 'dashed', 'dashdot', 'dotted', 'none', ' ', '',
)
# Patch existing matplotlib validators.
# NOTE: validate_fontsizelist is unused in recent matplotlib versions and
# validate_colorlist is only used with prop cycle eval (which we don't care about)
font_scalings['med'] = 1.0 # consistent shorthand
font_scalings['med-small'] = 0.9 # add scaling
font_scalings['med-large'] = 1.1 # add scaling
if not hasattr(RcParams, 'validate'): # not mission critical so skip
warnings._warn_proplot('Failed to update matplotlib rcParams validators.')
else:
_validate = RcParams.validate
_validate['image.cmap'] = _validate_cmap('continuous')
_validate['legend.loc'] = _validate_belongs(*LEGEND_LOCS)
for _key, _validator in _validate.items():
if _validator is getattr(msetup, 'validate_fontsize', None): # should exist
FONT_KEYS.add(_key)
_validate[_key] = _validate_fontsize
if _validator is getattr(msetup, 'validate_fontsize_None', None):
FONT_KEYS.add(_key)
_validate[_key] = _validate_or_none(_validate_fontsize)
if _validator is getattr(msetup, 'validate_font_properties', None):
_validate[_key] = _validate_fontprops
if _validator is getattr(msetup, 'validate_color', None): # should exist
_validate[_key] = _validate_color
if _validator is getattr(msetup, 'validate_color_or_auto', None):
_validate[_key] = functools.partial(_validate_color, alternative='auto')
if _validator is getattr(msetup, 'validate_color_or_inherit', None):
_validate[_key] = functools.partial(_validate_color, alternative='inherit')
for _keys, _validator_replace in ((EM_KEYS, _validate_em), (PT_KEYS, _validate_pt)):
for _key in _keys:
_validator = _validate.get(_key, None)
if _validator is None:
continue
if _validator is msetup.validate_float:
_validate[_key] = _validator_replace
if _validator is getattr(msetup, 'validate_float_or_None'):
_validate[_key] = _validate_or_none(_validator_replace)
# Proplot overrides of matplotlib default style
# WARNING: Critical to include every parameter here that can be changed by a
# "meta" setting so that _get_default_param returns the value imposed by *proplot*
# and so that "changed" settings detected by Configurator.save are correct.
_rc_matplotlib_default = {
'axes.axisbelow': GRIDBELOW,
'axes.formatter.use_mathtext': MATHTEXT,
'axes.grid': True, # enable lightweight transparent grid by default
'axes.grid.which': 'major',
'axes.edgecolor': BLACK,
'axes.labelcolor': BLACK,
'axes.labelpad': LABELPAD, # more compact
'axes.labelsize': SMALLSIZE,
'axes.labelweight': 'normal',
'axes.linewidth': LINEWIDTH,
'axes.titlepad': TITLEPAD, # more compact
'axes.titlesize': LARGESIZE,
'axes.titleweight': 'normal',
'axes.xmargin': MARGIN,
'axes.ymargin': MARGIN,
'errorbar.capsize': 3.0,
'figure.autolayout': False,
'figure.figsize': (4.0, 4.0), # for interactife backends
'figure.dpi': 100,
'figure.facecolor': '#f4f4f4', # similar to MATLAB interface
'figure.titlesize': LARGESIZE,
'figure.titleweight': 'bold', # differentiate from axes titles
'font.serif': [
'TeX Gyre Schola', # Century lookalike
'TeX Gyre Bonum', # Bookman lookalike
'TeX Gyre Termes', # Times New Roman lookalike
'TeX Gyre Pagella', # Palatino lookalike
'DejaVu Serif',
'Bitstream Vera Serif',
'Computer Modern Roman',
'Bookman',
'Century Schoolbook L',
'Charter',
'ITC Bookman',
'New Century Schoolbook',
'Nimbus Roman No9 L',
'Noto Serif',
'Palatino',
'Source Serif Pro',
'Times New Roman',
'Times',
'Utopia',
'serif',
],
'font.sans-serif': [
'TeX Gyre Heros', # Helvetica lookalike
'DejaVu Sans',
'Bitstream Vera Sans',
'Computer Modern Sans Serif',
'Arial',
'Avenir',
'Fira Math',
'Fira Sans',
'Frutiger',
'Geneva',
'Gill Sans',
'Helvetica',
'Lucid',
'Lucida Grande',
'Myriad Pro',
'Noto Sans',
'Roboto',
'Source Sans Pro',
'Tahoma',
'Trebuchet MS',
'Ubuntu',
'Univers',
'Verdana',
'sans-serif',
],
'font.cursive': [
'TeX Gyre Chorus', # Chancery lookalike
'Apple Chancery',
'Felipa',
'Sand',
'Script MT',
'Textile',
'Zapf Chancery',
'cursive',
],
'font.fantasy': [
'TeX Gyre Adventor', # Avant Garde lookalike
'Avant Garde',
'Charcoal',
'Chicago',
'Comic Sans MS',
'Futura',
'Humor Sans',
'Impact',
'Optima',
'Western',
'xkcd',
'fantasy',
],
'font.monospace': [
'TeX Gyre Cursor', # Courier lookalike
'DejaVu Sans Mono',
'Bitstream Vera Sans Mono',
'Computer Modern Typewriter',
'Andale Mono',
'Courier New',
'Courier',
'Fixed',
'Nimbus Mono L',
'Terminal',
'monospace',
],
'font.family': FONTNAME,
'font.size': FONTSIZE,
'grid.alpha': GRIDALPHA, # lightweight unobtrusive gridlines
'grid.color': BLACK, # lightweight unobtrusive gridlines
'grid.linestyle': GRIDSTYLE,
'grid.linewidth': LINEWIDTH,
'hatch.color': BLACK,
'hatch.linewidth': LINEWIDTH,
'image.cmap': CMAPSEQ,
'lines.linestyle': '-',
'lines.linewidth': 1.5,
'lines.markersize': 6.0,
'legend.borderaxespad': 0, # i.e. flush against edge
'legend.borderpad': 0.5, # a bit more roomy
'legend.columnspacing': 1.5, # a bit more compact (see handletextpad)
'legend.edgecolor': BLACK,
'legend.facecolor': WHITE,
'legend.fancybox': False, # i.e. BboxStyle 'square' not 'round'
'legend.fontsize': SMALLSIZE,
'legend.framealpha': FRAMEALPHA,
'legend.handleheight': 1.0, # default is 0.7
'legend.handlelength': 2.0, # default is 2.0
'legend.handletextpad': 0.5, # a bit more compact (see columnspacing)
'mathtext.default': 'it',
'mathtext.fontset': 'custom',
'mathtext.bf': 'regular:bold', # custom settings implemented above
'mathtext.cal': 'cursive',
'mathtext.it': 'regular:italic',
'mathtext.rm': 'regular',
'mathtext.sf': 'regular',
'mathtext.tt': 'monospace',
'patch.linewidth': LINEWIDTH,
'savefig.bbox': None, # do not use 'tight'
'savefig.directory': '', # use the working directory
'savefig.dpi': 1000, # use academic journal recommendation
'savefig.facecolor': WHITE, # use white instead of 'auto'
'savefig.format': 'pdf', # use vector graphics
'savefig.transparent': False,
'xtick.color': BLACK,
'xtick.direction': TICKDIR,
'xtick.labelsize': SMALLSIZE,
'xtick.major.pad': TICKPAD,
'xtick.major.size': TICKLEN,
'xtick.major.width': LINEWIDTH,
'xtick.minor.pad': TICKPAD,
'xtick.minor.size': TICKLEN * TICKLENRATIO,
'xtick.minor.width': LINEWIDTH * TICKWIDTHRATIO,
'xtick.minor.visible': TICKMINOR,
'ytick.color': BLACK,
'ytick.direction': TICKDIR,
'ytick.labelsize': SMALLSIZE,
'ytick.major.pad': TICKPAD,
'ytick.major.size': TICKLEN,
'ytick.major.width': LINEWIDTH,
'ytick.minor.pad': TICKPAD,
'ytick.minor.size': TICKLEN * TICKLENRATIO,
'ytick.minor.width': LINEWIDTH * TICKWIDTHRATIO,
'ytick.minor.visible': TICKMINOR,
}
if 'mathtext.fallback' in _rc_matplotlib_native:
_rc_matplotlib_default['mathtext.fallback'] = 'stixsans'
# Proplot pseudo-setting defaults, validators, and descriptions
# NOTE: Cannot have different a-b-c and title paddings because they are both controlled
# by matplotlib's _title_offset_trans transform and want to keep them aligned anyway.
_addendum_rotation = " Must be 'vertical', 'horizontal', or a float indicating degrees."
_addendum_em = ' Interpreted by `~proplot.utils.units`. Numeric units are em-widths.'
_addendum_in = ' Interpreted by `~proplot.utils.units`. Numeric units are inches.'
_addendum_pt = ' Interpreted by `~proplot.utils.units`. Numeric units are points.'
_addendum_font = (
' Must be a :ref:`relative font size <font_table>` or unit string '
'interpreted by `~proplot.utils.units`. Numeric units are points.'
)
_rc_proplot_table = {
# Stylesheet
'style': (
None,
_validate_or_none(_validate_string),
'The default matplotlib `stylesheet '
'<https://matplotlib.org/stable/gallery/style_sheets/style_sheets_reference.html>`__ ' # noqa: E501
'name. If ``None``, a custom proplot style is used. '
"If ``'default'``, the default matplotlib style is used."
),
# A-b-c labels
'abc': (
False,
_validate_abc,
'If ``False`` then a-b-c labels are disabled. If ``True`` the default label '
'style ``a`` is used. If string this indicates the style and must contain the '
"character ``a`` or ``A``, for example ``'a.'`` or ``'(A)'``."
),
'abc.border': (
True,
_validate_bool,
'Whether to draw a white border around a-b-c labels '
'when :rcraw:`abc.loc` is inside the axes.'
),
'abc.borderwidth': (
1.5,
_validate_pt,
'Width of the white border around a-b-c labels.'
),
'abc.box': (
False,
_validate_bool,
'Whether to draw semi-transparent bounding boxes around a-b-c labels '
'when :rcraw:`abc.loc` is inside the axes.'
),
'abc.boxcolor': (
WHITE,
_validate_color,
'a-b-c label bounding box color.'
),
'abc.boxalpha': (
0.5,
_validate_float,
'a-b-c label bounding box opacity.'
),
'abc.boxstyle': (
'square',
_validate_boxstyle,
'a-b-c label bounding box style.'
),
'abc.boxpad': (
None,
_validate_or_none(_validate_pt),
'Padding for the a-b-c label bounding box. By default this is scaled '
'to make the box flush against the subplot edge.' + _addendum_pt
),
'abc.color': (
BLACK,
_validate_color,
'a-b-c label color.'
),
'abc.loc': (
'left', # left side above the axes
_validate_belongs(*TEXT_LOCS),
'a-b-c label position. '
'For options see the :ref:`location table <title_table>`.'
),
'abc.size': (
LARGESIZE,
_validate_fontsize,
'a-b-c label font size.' + _addendum_font
),
'abc.titlepad': (
LABELPAD,
_validate_pt,
'Padding separating the title and a-b-c label when in the same location.'
+ _addendum_pt
),
'abc.weight': (
'bold',
_validate_fontweight,
'a-b-c label font weight.'
),
# Autoformatting
'autoformat': (
True,
_validate_bool,
'Whether to automatically apply labels from `pandas.Series`, '
'`pandas.DataFrame`, and `xarray.DataArray` objects passed to '
'plotting functions. See also :rcraw:`unitformat`.'
),
# Axes additions
'axes.alpha': (
None,
_validate_or_none(_validate_float),
'Opacity of the background axes patch.'
),
'axes.inbounds': (
True,
_validate_bool,
'Whether to exclude out-of-bounds data when determining the default *y* (*x*) '
'axis limits and the *x* (*y*) axis limits have been locked.'
),
'axes.margin': (
MARGIN,
_validate_float,
'The fractional *x* and *y* axis margins when limits are unset.'
),
# Country borders
'borders': (
False,
_validate_bool,
'Toggles country border lines on and off.'
),
'borders.alpha': (
None,
_validate_or_none(_validate_float),
'Opacity for country border lines.',
),
'borders.color': (
BLACK,
_validate_color,
'Line color for country border lines.'
),
'borders.linewidth': (
LINEWIDTH,
_validate_pt,
'Line width for country border lines.'
),
'borders.zorder': (
ZLINES,
_validate_float,
'Z-order for country border lines.'
),
# Bottom subplot labels
'bottomlabel.color': (
BLACK,
_validate_color,
'Font color for column labels on the bottom of the figure.'
),
'bottomlabel.pad': (
TITLEPAD,
_validate_pt,
'Padding between axes content and column labels on the bottom of the figure.'
+ _addendum_pt
),
'bottomlabel.rotation': (
'horizontal',
_validate_rotation,
'Rotation for column labels at the bottom of the figure.' + _addendum_rotation
),
'bottomlabel.size': (
LARGESIZE,
_validate_fontsize,
'Font size for column labels on the bottom of the figure.' + _addendum_font
),
'bottomlabel.weight': (
'bold',
_validate_fontweight,
'Font weight for column labels on the bottom of the figure.'
),
# Coastlines
'coast': (
False,
_validate_bool,
'Toggles coastline lines on and off.'
),
'coast.alpha': (
None,
_validate_or_none(_validate_float),
'Opacity for coast lines',
),
'coast.color': (
BLACK,
_validate_color,
'Line color for coast lines.'
),
'coast.linewidth': (
LINEWIDTH,
_validate_pt,
'Line width for coast lines.'
),
'coast.zorder': (
ZLINES,
_validate_float,
'Z-order for coast lines.'
),
# Colorbars
'colorbar.edgecolor': (
BLACK,
_validate_color,
'Color for the inset colorbar frame edge.'
),
'colorbar.extend': (
1.3,
_validate_em,
'Length of rectangular or triangular "extensions" for panel colorbars.'
+ _addendum_em
),
'colorbar.fancybox': (
False,
_validate_bool,
'Whether to use a "fancy" round bounding box for inset colorbar frames.'
),
'colorbar.framealpha': (