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
|
# Copyright Crown and Cartopy Contributors
#
# This file is part of Cartopy and is released under the BSD 3-clause license.
# See LICENSE in the root of the repository for full licensing details.
"""
Handles matplotlib styling in a single consistent place.
"""
import warnings
warnings.warn('The style module is deprecated and will be removed in a future release.',
DeprecationWarning, stacklevel=2)
# Define the matplotlib style aliases that cartopy can expand.
# Note: This should not contain the plural aliases
# (e.g. linewidths -> linewidth).
# This is an intended duplication of
# https://github.com/matplotlib/matplotlib/blob/\
# 2d2dab511d22b6cc9c812cfbcca6df3f9bf3094a/lib/matplotlib/patches.py#L20-L26
# Duplication intended to simplify readability, given the small number of
# aliases.
_ALIASES = {
'lw': 'linewidth',
'ls': 'linestyle',
'fc': 'facecolor',
'ec': 'edgecolor',
}
def merge(*style_dicts):
"""
Merge together multiple matplotlib style dictionaries in a predictable way
The approach taken is:
For each style:
* Expand aliases, such as "lw" -> "linewidth", but always prefer
the full form if over-specified (i.e. lw AND linewidth
are both set)
* "color" overwrites "facecolor" and "edgecolor" (as per
matplotlib), UNLESS facecolor == "never", which will be expanded
at finalization to 'none'
>>> style = merge({"lw": 1, "edgecolor": "black", "facecolor": "never"},
... {"linewidth": 2, "color": "gray"})
>>> sorted(style.items())
[('edgecolor', 'gray'), ('facecolor', 'never'), ('linewidth', 2)]
"""
style = {}
facecolor = None
for orig_style in style_dicts:
this_style = orig_style.copy()
for alias_from, alias_to in _ALIASES.items():
alias = this_style.pop(alias_from, None)
if alias_from in orig_style:
# n.b. alias_from doesn't trump alias_to
# (e.g. 'lw' doesn't trump 'linewidth').
this_style.setdefault(alias_to, alias)
color = this_style.pop('color', None)
if 'color' in orig_style:
this_style['edgecolor'] = color
this_style['facecolor'] = color
if isinstance(facecolor, str) and facecolor == 'never':
requested_color = this_style.pop('facecolor', None)
setting_color = not (
isinstance(requested_color, str) and
requested_color.lower() == 'none')
if (('fc' in orig_style or 'facecolor' in orig_style) and
setting_color):
warnings.warn('facecolor will have no effect as it has been '
'defined as "never".')
else:
facecolor = this_style.get('facecolor', facecolor)
# Push the remainder of the style into the merged style.
style.update(this_style)
return style
def finalize(style):
"""
Update the given matplotlib style according to cartopy's style rules.
Rules:
1. A facecolor of 'never' is replaced with 'none'.
"""
# Expand 'never' to 'none' if we have it.
facecolor = style.get('facecolor', None)
if facecolor == 'never':
style['facecolor'] = 'none'
return style
|
