forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcore.html
More file actions
380 lines (308 loc) · 32.9 KB
/
Copy pathcore.html
File metadata and controls
380 lines (308 loc) · 32.9 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
<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>matplotlib.style.core — Matplotlib 3.3.3 documentation</title>
<link rel="stylesheet" href="../../../_static/mpl.css?v3.3.3-2-g447bdbbf58" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/gallery-dataframe.css" />
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/language_data.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.3.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 3.3.3 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/3.3.3/_modules/matplotlib/style/core.html" />
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<!--
<div id="annc-banner">
</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 3.3.3</span></div>
<img src="../../../_static/logo2_compressed.svg" 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>
<nav class="main-nav">
<ul>
<li><a href="../../../users/installing.html">Installation</a></li>
<li><a href="../../../contents.html">Documentation</a></li>
<li><a href="../../../gallery/index.html">Examples</a></li>
<li><a href="../../../tutorials/index.html">Tutorials</a></li>
<li><a href="../../../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<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="../../../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-2"><a href="../../matplotlib.html" accesskey="U">matplotlib</a> »</li>
<li class="nav-item nav-item-this"><a href="">matplotlib.style.core</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><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" role="main">
<h1>Source code for matplotlib.style.core</h1><div class="highlight"><pre>
<span></span><span class="sd">"""</span>
<span class="sd">Core functions and attributes for the matplotlib style library:</span>
<span class="sd">``use``</span>
<span class="sd"> Select style sheet to override the current matplotlib settings.</span>
<span class="sd">``context``</span>
<span class="sd"> Context manager to use a style sheet temporarily.</span>
<span class="sd">``available``</span>
<span class="sd"> List available style sheets.</span>
<span class="sd">``library``</span>
<span class="sd"> A dictionary of style names and matplotlib settings.</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">contextlib</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">import</span> <span class="nn">matplotlib</span> <span class="k">as</span> <span class="nn">mpl</span>
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="kn">import</span> <span class="n">cbook</span><span class="p">,</span> <span class="n">rc_params_from_file</span><span class="p">,</span> <span class="n">rcParamsDefault</span>
<span class="n">_log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'use'</span><span class="p">,</span> <span class="s1">'context'</span><span class="p">,</span> <span class="s1">'available'</span><span class="p">,</span> <span class="s1">'library'</span><span class="p">,</span> <span class="s1">'reload_library'</span><span class="p">]</span>
<span class="n">BASE_LIBRARY_PATH</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mpl</span><span class="o">.</span><span class="n">get_data_path</span><span class="p">(),</span> <span class="s1">'stylelib'</span><span class="p">)</span>
<span class="c1"># Users may want multiple library paths, so store a list of paths.</span>
<span class="n">USER_LIBRARY_PATHS</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mpl</span><span class="o">.</span><span class="n">get_configdir</span><span class="p">(),</span> <span class="s1">'stylelib'</span><span class="p">)]</span>
<span class="n">STYLE_EXTENSION</span> <span class="o">=</span> <span class="s1">'mplstyle'</span>
<span class="n">STYLE_FILE_PATTERN</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s1">'([\S]+).</span><span class="si">%s</span><span class="s1">$'</span> <span class="o">%</span> <span class="n">STYLE_EXTENSION</span><span class="p">)</span>
<span class="c1"># A list of rcParams that should not be applied from styles</span>
<span class="n">STYLE_BLACKLIST</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'interactive'</span><span class="p">,</span> <span class="s1">'backend'</span><span class="p">,</span> <span class="s1">'backend.qt4'</span><span class="p">,</span> <span class="s1">'webagg.port'</span><span class="p">,</span> <span class="s1">'webagg.address'</span><span class="p">,</span>
<span class="s1">'webagg.port_retries'</span><span class="p">,</span> <span class="s1">'webagg.open_in_browser'</span><span class="p">,</span> <span class="s1">'backend_fallback'</span><span class="p">,</span>
<span class="s1">'toolbar'</span><span class="p">,</span> <span class="s1">'timezone'</span><span class="p">,</span> <span class="s1">'datapath'</span><span class="p">,</span> <span class="s1">'figure.max_open_warning'</span><span class="p">,</span>
<span class="s1">'figure.raise_window'</span><span class="p">,</span> <span class="s1">'savefig.directory'</span><span class="p">,</span> <span class="s1">'tk.window_focus'</span><span class="p">,</span>
<span class="s1">'docstring.hardcopy'</span><span class="p">,</span> <span class="s1">'date.epoch'</span><span class="p">}</span>
<span class="k">def</span> <span class="nf">_remove_blacklisted_style_params</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">warn</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="n">o</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">d</span><span class="p">:</span> <span class="c1"># prevent triggering RcParams.__getitem__('backend')</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">STYLE_BLACKLIST</span><span class="p">:</span>
<span class="k">if</span> <span class="n">warn</span><span class="p">:</span>
<span class="n">cbook</span><span class="o">.</span><span class="n">_warn_external</span><span class="p">(</span>
<span class="s2">"Style includes a parameter, '</span><span class="si">{0}</span><span class="s2">', that is not related "</span>
<span class="s2">"to style. Ignoring"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">key</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">o</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">d</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="k">return</span> <span class="n">o</span>
<span class="nd">@cbook</span><span class="o">.</span><span class="n">deprecated</span><span class="p">(</span><span class="s2">"3.2"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">is_style_file</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>
<span class="sd">"""Return True if the filename looks like a style file."""</span>
<span class="k">return</span> <span class="n">STYLE_FILE_PATTERN</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">_apply_style</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">warn</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="n">mpl</span><span class="o">.</span><span class="n">rcParams</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">_remove_blacklisted_style_params</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">warn</span><span class="o">=</span><span class="n">warn</span><span class="p">))</span>
<div class="viewcode-block" id="use"><a class="viewcode-back" href="../../../api/style_api.html#matplotlib.style.use">[docs]</a><span class="k">def</span> <span class="nf">use</span><span class="p">(</span><span class="n">style</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Use Matplotlib style settings from a style specification.</span>
<span class="sd"> The style name of 'default' is reserved for reverting back to</span>
<span class="sd"> the default style settings.</span>
<span class="sd"> .. note::</span>
<span class="sd"> This updates the `.rcParams` with the settings from the style.</span>
<span class="sd"> `.rcParams` not defined in the style are kept.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> style : str, dict, Path or list</span>
<span class="sd"> A style specification. Valid options are:</span>
<span class="sd"> +------+-------------------------------------------------------------+</span>
<span class="sd"> | str | The name of a style or a path/URL to a style file. For a |</span>
<span class="sd"> | | list of available style names, see `style.available`. |</span>
<span class="sd"> +------+-------------------------------------------------------------+</span>
<span class="sd"> | dict | Dictionary with valid key/value pairs for |</span>
<span class="sd"> | | `matplotlib.rcParams`. |</span>
<span class="sd"> +------+-------------------------------------------------------------+</span>
<span class="sd"> | Path | A path-like object which is a path to a style file. |</span>
<span class="sd"> +------+-------------------------------------------------------------+</span>
<span class="sd"> | list | A list of style specifiers (str, Path or dict) applied from |</span>
<span class="sd"> | | first to last in the list. |</span>
<span class="sd"> +------+-------------------------------------------------------------+</span>
<span class="sd"> """</span>
<span class="n">style_alias</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'mpl20'</span><span class="p">:</span> <span class="s1">'default'</span><span class="p">,</span>
<span class="s1">'mpl15'</span><span class="p">:</span> <span class="s1">'classic'</span><span class="p">}</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">style</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Path</span><span class="p">))</span> <span class="ow">or</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">style</span><span class="p">,</span> <span class="s1">'keys'</span><span class="p">):</span>
<span class="c1"># If name is a single str, Path or dict, make it a single element list.</span>
<span class="n">styles</span> <span class="o">=</span> <span class="p">[</span><span class="n">style</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">styles</span> <span class="o">=</span> <span class="n">style</span>
<span class="n">styles</span> <span class="o">=</span> <span class="p">(</span><span class="n">style_alias</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">s</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="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="n">s</span>
<span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">styles</span><span class="p">)</span>
<span class="k">for</span> <span class="n">style</span> <span class="ow">in</span> <span class="n">styles</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">style</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Path</span><span class="p">)):</span>
<span class="n">_apply_style</span><span class="p">(</span><span class="n">style</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">style</span> <span class="o">==</span> <span class="s1">'default'</span><span class="p">:</span>
<span class="c1"># Deprecation warnings were already handled when creating</span>
<span class="c1"># rcParamsDefault, no need to reemit them here.</span>
<span class="k">with</span> <span class="n">cbook</span><span class="o">.</span><span class="n">_suppress_matplotlib_deprecation_warning</span><span class="p">():</span>
<span class="n">_apply_style</span><span class="p">(</span><span class="n">rcParamsDefault</span><span class="p">,</span> <span class="n">warn</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">style</span> <span class="ow">in</span> <span class="n">library</span><span class="p">:</span>
<span class="n">_apply_style</span><span class="p">(</span><span class="n">library</span><span class="p">[</span><span class="n">style</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">rc</span> <span class="o">=</span> <span class="n">rc_params_from_file</span><span class="p">(</span><span class="n">style</span><span class="p">,</span> <span class="n">use_default_template</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">_apply_style</span><span class="p">(</span><span class="n">rc</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span>
<span class="s2">"</span><span class="si">{!r}</span><span class="s2"> not found in the style library and input is not a "</span>
<span class="s2">"valid URL or path; see `style.available` for list of "</span>
<span class="s2">"available styles"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">style</span><span class="p">))</span> <span class="kn">from</span> <span class="nn">err</span></div>
<div class="viewcode-block" id="context"><a class="viewcode-back" href="../../../api/style_api.html#matplotlib.style.context">[docs]</a><span class="nd">@contextlib</span><span class="o">.</span><span class="n">contextmanager</span>
<span class="k">def</span> <span class="nf">context</span><span class="p">(</span><span class="n">style</span><span class="p">,</span> <span class="n">after_reset</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Context manager for using style settings temporarily.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> style : str, dict, Path or list</span>
<span class="sd"> A style specification. Valid options are:</span>
<span class="sd"> +------+-------------------------------------------------------------+</span>
<span class="sd"> | str | The name of a style or a path/URL to a style file. For a |</span>
<span class="sd"> | | list of available style names, see `style.available`. |</span>
<span class="sd"> +------+-------------------------------------------------------------+</span>
<span class="sd"> | dict | Dictionary with valid key/value pairs for |</span>
<span class="sd"> | | `matplotlib.rcParams`. |</span>
<span class="sd"> +------+-------------------------------------------------------------+</span>
<span class="sd"> | Path | A path-like object which is a path to a style file. |</span>
<span class="sd"> +------+-------------------------------------------------------------+</span>
<span class="sd"> | list | A list of style specifiers (str, Path or dict) applied from |</span>
<span class="sd"> | | first to last in the list. |</span>
<span class="sd"> +------+-------------------------------------------------------------+</span>
<span class="sd"> after_reset : bool</span>
<span class="sd"> If True, apply style after resetting settings to their defaults;</span>
<span class="sd"> otherwise, apply style on top of the current settings.</span>
<span class="sd"> """</span>
<span class="k">with</span> <span class="n">mpl</span><span class="o">.</span><span class="n">rc_context</span><span class="p">():</span>
<span class="k">if</span> <span class="n">after_reset</span><span class="p">:</span>
<span class="n">mpl</span><span class="o">.</span><span class="n">rcdefaults</span><span class="p">()</span>
<span class="n">use</span><span class="p">(</span><span class="n">style</span><span class="p">)</span>
<span class="k">yield</span></div>
<span class="k">def</span> <span class="nf">load_base_library</span><span class="p">():</span>
<span class="sd">"""Load style library defined in this package."""</span>
<span class="n">library</span> <span class="o">=</span> <span class="n">read_style_directory</span><span class="p">(</span><span class="n">BASE_LIBRARY_PATH</span><span class="p">)</span>
<span class="k">return</span> <span class="n">library</span>
<span class="k">def</span> <span class="nf">iter_user_libraries</span><span class="p">():</span>
<span class="k">for</span> <span class="n">stylelib_path</span> <span class="ow">in</span> <span class="n">USER_LIBRARY_PATHS</span><span class="p">:</span>
<span class="n">stylelib_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="n">stylelib_path</span><span class="p">)</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">stylelib_path</span><span class="p">)</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">stylelib_path</span><span class="p">):</span>
<span class="k">yield</span> <span class="n">stylelib_path</span>
<span class="k">def</span> <span class="nf">update_user_library</span><span class="p">(</span><span class="n">library</span><span class="p">):</span>
<span class="sd">"""Update style library with user-defined rc files."""</span>
<span class="k">for</span> <span class="n">stylelib_path</span> <span class="ow">in</span> <span class="n">iter_user_libraries</span><span class="p">():</span>
<span class="n">styles</span> <span class="o">=</span> <span class="n">read_style_directory</span><span class="p">(</span><span class="n">stylelib_path</span><span class="p">)</span>
<span class="n">update_nested_dict</span><span class="p">(</span><span class="n">library</span><span class="p">,</span> <span class="n">styles</span><span class="p">)</span>
<span class="k">return</span> <span class="n">library</span>
<span class="nd">@cbook</span><span class="o">.</span><span class="n">deprecated</span><span class="p">(</span><span class="s2">"3.2"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">iter_style_files</span><span class="p">(</span><span class="n">style_dir</span><span class="p">):</span>
<span class="sd">"""Yield file path and name of styles in the given directory."""</span>
<span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">style_dir</span><span class="p">):</span>
<span class="n">filename</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="k">if</span> <span class="n">is_style_file</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>
<span class="n">match</span> <span class="o">=</span> <span class="n">STYLE_FILE_PATTERN</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">style_dir</span><span class="p">,</span> <span class="n">path</span><span class="p">))</span>
<span class="k">yield</span> <span class="n">path</span><span class="p">,</span> <span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">read_style_directory</span><span class="p">(</span><span class="n">style_dir</span><span class="p">):</span>
<span class="sd">"""Return dictionary of styles defined in *style_dir*."""</span>
<span class="n">styles</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">Path</span><span class="p">(</span><span class="n">style_dir</span><span class="p">)</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="sa">f</span><span class="s2">"*.</span><span class="si">{</span><span class="n">STYLE_EXTENSION</span><span class="si">}</span><span class="s2">"</span><span class="p">):</span>
<span class="k">with</span> <span class="n">warnings</span><span class="o">.</span><span class="n">catch_warnings</span><span class="p">(</span><span class="n">record</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="k">as</span> <span class="n">warns</span><span class="p">:</span>
<span class="n">styles</span><span class="p">[</span><span class="n">path</span><span class="o">.</span><span class="n">stem</span><span class="p">]</span> <span class="o">=</span> <span class="n">rc_params_from_file</span><span class="p">(</span>
<span class="n">path</span><span class="p">,</span> <span class="n">use_default_template</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">for</span> <span class="n">w</span> <span class="ow">in</span> <span class="n">warns</span><span class="p">:</span>
<span class="n">_log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s1">'In </span><span class="si">%s</span><span class="s1">: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">w</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
<span class="k">return</span> <span class="n">styles</span>
<span class="k">def</span> <span class="nf">update_nested_dict</span><span class="p">(</span><span class="n">main_dict</span><span class="p">,</span> <span class="n">new_dict</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Update nested dict (only level of nesting) with new values.</span>
<span class="sd"> Unlike `dict.update`, this assumes that the values of the parent dict are</span>
<span class="sd"> dicts (or dict-like), so you shouldn't replace the nested dict if it</span>
<span class="sd"> already exists. Instead you should update the sub-dict.</span>
<span class="sd"> """</span>
<span class="c1"># update named styles specified by user</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">rc_dict</span> <span class="ow">in</span> <span class="n">new_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">main_dict</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">rc_dict</span><span class="p">)</span>
<span class="k">return</span> <span class="n">main_dict</span>
<span class="c1"># Load style library</span>
<span class="c1"># ==================</span>
<span class="n">_base_library</span> <span class="o">=</span> <span class="n">load_base_library</span><span class="p">()</span>
<span class="n">library</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">available</span> <span class="o">=</span> <span class="p">[]</span>
<div class="viewcode-block" id="reload_library"><a class="viewcode-back" href="../../../api/style_api.html#matplotlib.style.reload_library">[docs]</a><span class="k">def</span> <span class="nf">reload_library</span><span class="p">():</span>
<span class="sd">"""Reload the style library."""</span>
<span class="k">global</span> <span class="n">library</span>
<span class="n">library</span> <span class="o">=</span> <span class="n">update_user_library</span><span class="p">(</span><span class="n">_base_library</span><span class="p">)</span>
<span class="n">available</span><span class="p">[:]</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">library</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span></div>
<span class="n">reload_library</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2020 The Matplotlib development team.
<br />
Last updated on Nov 12, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.
Doc version v3.3.3-2-g447bdbbf58.
</div>
</footer>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-55954603-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>