{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy path_api_api.html
More file actions
467 lines (428 loc) · 40 KB
/
Copy path_api_api.html
File metadata and controls
467 lines (428 loc) · 40 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
<!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._api — Matplotlib 3.4.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.4.0-2-gcb03754703" 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/plot_directive.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.4.0 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="next" title="matplotlib._enums" href="_enums_api.html" />
<link rel="prev" title="matplotlib.widgets" href="widgets_api.html" />
<link rel="top" title="Matplotlib 3.4.0 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/_api_api.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" />
<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 (v3.4.0). For the latest version see <a href="https://matplotlib.org/stable/api/_api_api.html">https://matplotlib.org/stable/api/_api_api.html</a></div>
<!--
<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.4.0</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 class="right" >
<a href="_enums_api.html" title="matplotlib._enums"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="widgets_api.html" title="matplotlib.widgets"
accesskey="P">previous</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" accesskey="U">API Overview</a> »</li>
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib._api</span></code></a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/_api_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-matplotlib._api">
<span id="matplotlib-api"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib._api</span></code><a class="headerlink" href="#module-matplotlib._api" title="Permalink to this headline">¶</a></h1>
<p>Helper functions for managing the Matplotlib API.</p>
<p>This documentation is only relevant for Matplotlib developers, not for users.</p>
<dl class="py function">
<dt id="matplotlib._api.check_getitem">
<code class="descclassname">matplotlib._api.</code><code class="descname">check_getitem</code><span class="sig-paren">(</span><em><span class="n">_mapping</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api.html#check_getitem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.check_getitem" title="Permalink to this definition">¶</a></dt>
<dd><p><em>kwargs</em> must consist of a single <em>key, value</em> pair. If <em>key</em> is in
<em>_mapping</em>, return <code class="docutils literal notranslate"><span class="pre">_mapping[value]</span></code>; else, raise an appropriate
ValueError.</p>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">_api</span><span class="o">.</span><span class="n">check_getitem</span><span class="p">({</span><span class="s2">"foo"</span><span class="p">:</span> <span class="s2">"bar"</span><span class="p">},</span> <span class="n">arg</span><span class="o">=</span><span class="n">arg</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt id="matplotlib._api.check_in_list">
<code class="descclassname">matplotlib._api.</code><code class="descname">check_in_list</code><span class="sig-paren">(</span><em><span class="n">_values</span></em>, <em><span class="o">*</span></em>, <em><span class="n">_print_supported_values</span><span class="o">=</span><span class="default_value">True</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api.html#check_in_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.check_in_list" title="Permalink to this definition">¶</a></dt>
<dd><p>For each <em>key, value</em> pair in <em>kwargs</em>, check that <em>value</em> is in <em>_values</em>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>_values</strong><span class="classifier">iterable</span></dt><dd><p>Sequence of values to check on.</p>
</dd>
<dt><strong>_print_supported_values</strong><span class="classifier">bool, default: True</span></dt><dd><p>Whether to print <em>_values</em> when raising ValueError.</p>
</dd>
<dt><strong>**kwargs</strong><span class="classifier">dict</span></dt><dd><p><em>key, value</em> pairs as keyword arguments to find in <em>_values</em>.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><dl class="first last docutils">
<dt>ValueError</dt><dd><p>If any <em>value</em> in <em>kwargs</em> is not found in <em>_values</em>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">_api</span><span class="o">.</span><span class="n">check_in_list</span><span class="p">([</span><span class="s2">"foo"</span><span class="p">,</span> <span class="s2">"bar"</span><span class="p">],</span> <span class="n">arg</span><span class="o">=</span><span class="n">arg</span><span class="p">,</span> <span class="n">other_arg</span><span class="o">=</span><span class="n">other_arg</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt id="matplotlib._api.check_isinstance">
<code class="descclassname">matplotlib._api.</code><code class="descname">check_isinstance</code><span class="sig-paren">(</span><em><span class="n">_types</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api.html#check_isinstance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.check_isinstance" title="Permalink to this definition">¶</a></dt>
<dd><p>For each <em>key, value</em> pair in <em>kwargs</em>, check that <em>value</em> is an instance
of one of <em>_types</em>; if not, raise an appropriate TypeError.</p>
<p>As a special case, a <code class="docutils literal notranslate"><span class="pre">None</span></code> entry in <em>_types</em> is treated as NoneType.</p>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">_api</span><span class="o">.</span><span class="n">check_isinstance</span><span class="p">((</span><span class="n">SomeClass</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span> <span class="n">arg</span><span class="o">=</span><span class="n">arg</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt id="matplotlib._api.check_shape">
<code class="descclassname">matplotlib._api.</code><code class="descname">check_shape</code><span class="sig-paren">(</span><em><span class="n">_shape</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api.html#check_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.check_shape" title="Permalink to this definition">¶</a></dt>
<dd><p>For each <em>key, value</em> pair in <em>kwargs</em>, check that <em>value</em> has the shape
<em>_shape</em>, if not, raise an appropriate ValueError.</p>
<p><em>None</em> in the shape is treated as a "free" size that can have any length.
e.g. (None, 2) -> (N, 2)</p>
<p>The values checked must be numpy arrays.</p>
<p class="rubric">Examples</p>
<p>To check for (N, 2) shaped arrays</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">_api</span><span class="o">.</span><span class="n">check_shape</span><span class="p">((</span><span class="kc">None</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="n">arg</span><span class="o">=</span><span class="n">arg</span><span class="p">,</span> <span class="n">other_arg</span><span class="o">=</span><span class="n">other_arg</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py class">
<dt id="matplotlib._api.classproperty">
<em class="property">class </em><code class="descclassname">matplotlib._api.</code><code class="descname">classproperty</code><span class="sig-paren">(</span><em><span class="n">fget</span></em>, <em><span class="n">fset</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">fdel</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">doc</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api.html#classproperty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.classproperty" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Like <a class="reference external" href="https://docs.python.org/3/library/functions.html#property" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">property</span></code></a>, but also triggers on access via the class, and it is the
<em>class</em> that's passed as argument.</p>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">C</span><span class="p">:</span>
<span class="nd">@classproperty</span>
<span class="k">def</span> <span class="nf">foo</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span>
<span class="k">assert</span> <span class="n">C</span><span class="o">.</span><span class="n">foo</span> <span class="o">==</span> <span class="s2">"C"</span>
</pre></div>
</div>
<dl class="py method">
<dt id="matplotlib._api.classproperty.fget">
<em class="property">property </em><code class="descname">fget</code><a class="headerlink" href="#matplotlib._api.classproperty.fget" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt id="matplotlib._api.warn_external">
<code class="descclassname">matplotlib._api.</code><code class="descname">warn_external</code><span class="sig-paren">(</span><em><span class="n">message</span></em>, <em><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api.html#warn_external"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.warn_external" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://docs.python.org/3/library/warnings.html#warnings.warn" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">warnings.warn</span></code></a> wrapper that sets <em>stacklevel</em> to "outside Matplotlib".</p>
<p>The original emitter of the warning can be obtained by patching this
function back to <a class="reference external" href="https://docs.python.org/3/library/warnings.html#warnings.warn" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">warnings.warn</span></code></a>, i.e. <code class="docutils literal notranslate"><span class="pre">_api.warn_external</span> <span class="pre">=</span>
<span class="pre">warnings.warn</span></code> (or <code class="docutils literal notranslate"><span class="pre">functools.partial(warnings.warn,</span> <span class="pre">stacklevel=2)</span></code>,
etc.).</p>
</dd></dl>
<span class="target" id="module-matplotlib._api.deprecation"></span><p>Helper functions for deprecating parts of the Matplotlib API.</p>
<p>This documentation is only relevant for Matplotlib developers, not for users.</p>
<dl class="py exception">
<dt id="matplotlib._api.deprecation.MatplotlibDeprecationWarning">
<em class="property">exception </em><code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">MatplotlibDeprecationWarning</code><a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#MatplotlibDeprecationWarning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.deprecation.MatplotlibDeprecationWarning" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#UserWarning" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">UserWarning</span></code></a></p>
<p>A class for issuing deprecation warnings for Matplotlib users.</p>
<p>In light of the fact that Python builtin DeprecationWarnings are ignored
by default as of Python 2.7 (see link below), this class was put in to
allow for the signaling of deprecation, but via UserWarnings which are not
ignored by default.</p>
<p><a class="reference external" href="https://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x">https://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x</a></p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib._api.deprecation.delete_parameter">
<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">delete_parameter</code><span class="sig-paren">(</span><em><span class="n">since</span></em>, <em><span class="n">name</span></em>, <em><span class="n">func</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#delete_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.deprecation.delete_parameter" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator indicating that parameter <em>name</em> of <em>func</em> is being deprecated.</p>
<p>The actual implementation of <em>func</em> should keep the <em>name</em> parameter in its
signature, or accept a <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code> argument (through which <em>name</em> would be
passed).</p>
<p>Parameters that come after the deprecated parameter effectively become
keyword-only (as they cannot be passed positionally without triggering the
DeprecationWarning on the deprecated parameter), and should be marked as
such after the deprecation period has passed and the deprecated parameter
is removed.</p>
<p>Parameters other than <em>since</em>, <em>name</em>, and <em>func</em> are keyword-only and
forwarded to <a class="reference internal" href="#matplotlib._api.deprecation.warn_deprecated" title="matplotlib._api.deprecation.warn_deprecated"><code class="xref py py-obj docutils literal notranslate"><span class="pre">warn_deprecated</span></code></a>.</p>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@_api</span><span class="o">.</span><span class="n">delete_parameter</span><span class="p">(</span><span class="s2">"3.1"</span><span class="p">,</span> <span class="s2">"unused"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">used_arg</span><span class="p">,</span> <span class="n">other_arg</span><span class="p">,</span> <span class="n">unused</span><span class="p">,</span> <span class="n">more_args</span><span class="p">):</span> <span class="o">...</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt id="matplotlib._api.deprecation.deprecate_method_override">
<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">deprecate_method_override</code><span class="sig-paren">(</span><em><span class="n">method</span></em>, <em><span class="n">obj</span></em>, <em><span class="o">*</span></em>, <em><span class="n">allow_empty</span><span class="o">=</span><span class="default_value">False</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#deprecate_method_override"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.deprecation.deprecate_method_override" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">obj.method</span></code> with a deprecation if it was overridden, else None.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>method</strong></dt><dd><p>An unbound method, i.e. an expression of the form
<code class="docutils literal notranslate"><span class="pre">Class.method_name</span></code>. Remember that within the body of a method, one
can always use <code class="docutils literal notranslate"><span class="pre">__class__</span></code> to refer to the class that is currently
being defined.</p>
</dd>
<dt><strong>obj</strong></dt><dd><p>Either an object of the class where <em>method</em> is defined, or a subclass
of that class.</p>
</dd>
<dt><strong>allow_empty</strong><span class="classifier">bool, default: False</span></dt><dd><p>Whether to allow overrides by "empty" methods without emitting a
warning.</p>
</dd>
<dt><strong>**kwargs</strong></dt><dd><p>Additional parameters passed to <a class="reference internal" href="#matplotlib._api.deprecation.warn_deprecated" title="matplotlib._api.deprecation.warn_deprecated"><code class="xref py py-obj docutils literal notranslate"><span class="pre">warn_deprecated</span></code></a> to generate the
deprecation warning; must at least include the "since" key.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py class">
<dt id="matplotlib._api.deprecation.deprecate_privatize_attribute">
<em class="property">class </em><code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">deprecate_privatize_attribute</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#deprecate_privatize_attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.deprecation.deprecate_privatize_attribute" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Helper to deprecate public access to an attribute.</p>
<p>This helper should only be used at class scope, as follows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Foo</span><span class="p">:</span>
<span class="n">attr</span> <span class="o">=</span> <span class="n">_deprecate_privatize_attribute</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>
</pre></div>
</div>
<p>where <em>all</em> parameters are forwarded to <a class="reference internal" href="#matplotlib._api.deprecation.deprecated" title="matplotlib._api.deprecation.deprecated"><code class="xref py py-obj docutils literal notranslate"><span class="pre">deprecated</span></code></a>. This form makes
<code class="docutils literal notranslate"><span class="pre">attr</span></code> a property which forwards access to <code class="docutils literal notranslate"><span class="pre">self._attr</span></code> (same name but
with a leading underscore), with a deprecation warning. Note that the
attribute name is derived from <em>the name this helper is assigned to</em>.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib._api.deprecation.deprecated">
<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">deprecated</code><span class="sig-paren">(</span><em><span class="n">since</span></em>, <em><span class="o">*</span></em>, <em><span class="n">message</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">name</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">alternative</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">pending</span><span class="o">=</span><span class="default_value">False</span></em>, <em><span class="n">obj_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">addendum</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">removal</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#deprecated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.deprecation.deprecated" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator to mark a function, a class, or a property as deprecated.</p>
<p>When deprecating a classmethod, a staticmethod, or a property, the
<code class="docutils literal notranslate"><span class="pre">@deprecated</span></code> decorator should go <em>under</em> <code class="docutils literal notranslate"><span class="pre">@classmethod</span></code> and
<code class="docutils literal notranslate"><span class="pre">@staticmethod</span></code> (i.e., <a class="reference internal" href="#matplotlib._api.deprecation.deprecated" title="matplotlib._api.deprecation.deprecated"><code class="xref py py-obj docutils literal notranslate"><span class="pre">deprecated</span></code></a> should directly decorate the
underlying callable), but <em>over</em> <code class="docutils literal notranslate"><span class="pre">@property</span></code>.</p>
<p>When deprecating a class <code class="docutils literal notranslate"><span class="pre">C</span></code> intended to be used as a base class in a
multiple inheritance hierarchy, <code class="docutils literal notranslate"><span class="pre">C</span></code> <em>must</em> define an <code class="docutils literal notranslate"><span class="pre">__init__</span></code> method
(if <code class="docutils literal notranslate"><span class="pre">C</span></code> instead inherited its <code class="docutils literal notranslate"><span class="pre">__init__</span></code> from its own base class, then
<code class="docutils literal notranslate"><span class="pre">@deprecated</span></code> would mess up <code class="docutils literal notranslate"><span class="pre">__init__</span></code> inheritance when installing its
own (deprecation-emitting) <code class="docutils literal notranslate"><span class="pre">C.__init__</span></code>).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>since</strong><span class="classifier">str</span></dt><dd><p>The release at which this API became deprecated.</p>
</dd>
<dt><strong>message</strong><span class="classifier">str, optional</span></dt><dd><p>Override the default deprecation message. The <code class="docutils literal notranslate"><span class="pre">%(since)s</span></code>,
<code class="docutils literal notranslate"><span class="pre">%(name)s</span></code>, <code class="docutils literal notranslate"><span class="pre">%(alternative)s</span></code>, <code class="docutils literal notranslate"><span class="pre">%(obj_type)s</span></code>, <code class="docutils literal notranslate"><span class="pre">%(addendum)s</span></code>,
and <code class="docutils literal notranslate"><span class="pre">%(removal)s</span></code> format specifiers will be replaced by the values
of the respective arguments passed to this function.</p>
</dd>
<dt><strong>name</strong><span class="classifier">str, optional</span></dt><dd><p>The name used in the deprecation message; if not provided, the name
is automatically determined from the deprecated object.</p>
</dd>
<dt><strong>alternative</strong><span class="classifier">str, optional</span></dt><dd><p>An alternative API that the user may use in place of the deprecated
API. The deprecation warning will tell the user about this alternative
if provided.</p>
</dd>
<dt><strong>pending</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, uses a PendingDeprecationWarning instead of a
DeprecationWarning. Cannot be used together with <em>removal</em>.</p>
</dd>
<dt><strong>obj_type</strong><span class="classifier">str, optional</span></dt><dd><p>The object type being deprecated; by default, 'class' if decorating
a class, 'attribute' if decorating a property, 'function' otherwise.</p>
</dd>
<dt><strong>addendum</strong><span class="classifier">str, optional</span></dt><dd><p>Additional text appended directly to the final message.</p>
</dd>
<dt><strong>removal</strong><span class="classifier">str, optional</span></dt><dd><p>The expected removal version. With the default (an empty string), a
removal version is automatically computed from <em>since</em>. Set to other
Falsy values to not schedule a removal date. Cannot be used together
with <em>pending</em>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<p>Basic example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@deprecated</span><span class="p">(</span><span class="s1">'1.4.0'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">the_function_to_deprecate</span><span class="p">():</span>
<span class="k">pass</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt id="matplotlib._api.deprecation.make_keyword_only">
<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">make_keyword_only</code><span class="sig-paren">(</span><em><span class="n">since</span></em>, <em><span class="n">name</span></em>, <em><span class="n">func</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#make_keyword_only"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.deprecation.make_keyword_only" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator indicating that passing parameter <em>name</em> (or any of the following
ones) positionally to <em>func</em> is being deprecated.</p>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib._api.deprecation.mplDeprecation">
<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">mplDeprecation</code><a class="headerlink" href="#matplotlib._api.deprecation.mplDeprecation" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib._api.deprecation.MatplotlibDeprecationWarning" title="matplotlib._api.deprecation.MatplotlibDeprecationWarning"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib._api.deprecation.MatplotlibDeprecationWarning</span></code></a></p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib._api.deprecation.rename_parameter">
<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">rename_parameter</code><span class="sig-paren">(</span><em><span class="n">since</span></em>, <em><span class="n">old</span></em>, <em><span class="n">new</span></em>, <em><span class="n">func</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#rename_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.deprecation.rename_parameter" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator indicating that parameter <em>old</em> of <em>func</em> is renamed to <em>new</em>.</p>
<p>The actual implementation of <em>func</em> should use <em>new</em>, not <em>old</em>. If <em>old</em>
is passed to <em>func</em>, a DeprecationWarning is emitted, and its value is
used, even if <em>new</em> is also passed by keyword (this is to simplify pyplot
wrapper functions, which always pass <em>new</em> explicitly to the Axes method).
If <em>new</em> is also passed but positionally, a TypeError will be raised by the
underlying function during argument binding.</p>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@_api</span><span class="o">.</span><span class="n">rename_parameter</span><span class="p">(</span><span class="s2">"3.1"</span><span class="p">,</span> <span class="s2">"bad_name"</span><span class="p">,</span> <span class="s2">"good_name"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">good_name</span><span class="p">):</span> <span class="o">...</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt id="matplotlib._api.deprecation.suppress_matplotlib_deprecation_warning">
<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">suppress_matplotlib_deprecation_warning</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#suppress_matplotlib_deprecation_warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.deprecation.suppress_matplotlib_deprecation_warning" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="matplotlib._api.deprecation.warn_deprecated">
<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">warn_deprecated</code><span class="sig-paren">(</span><em><span class="n">since</span></em>, <em><span class="o">*</span></em>, <em><span class="n">message</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">name</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">alternative</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">pending</span><span class="o">=</span><span class="default_value">False</span></em>, <em><span class="n">obj_type</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">addendum</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">removal</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#warn_deprecated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib._api.deprecation.warn_deprecated" title="Permalink to this definition">¶</a></dt>
<dd><p>Display a standardized deprecation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>since</strong><span class="classifier">str</span></dt><dd><p>The release at which this API became deprecated.</p>
</dd>
<dt><strong>message</strong><span class="classifier">str, optional</span></dt><dd><p>Override the default deprecation message. The <code class="docutils literal notranslate"><span class="pre">%(since)s</span></code>,
<code class="docutils literal notranslate"><span class="pre">%(name)s</span></code>, <code class="docutils literal notranslate"><span class="pre">%(alternative)s</span></code>, <code class="docutils literal notranslate"><span class="pre">%(obj_type)s</span></code>, <code class="docutils literal notranslate"><span class="pre">%(addendum)s</span></code>,
and <code class="docutils literal notranslate"><span class="pre">%(removal)s</span></code> format specifiers will be replaced by the values
of the respective arguments passed to this function.</p>
</dd>
<dt><strong>name</strong><span class="classifier">str, optional</span></dt><dd><p>The name of the deprecated object.</p>
</dd>
<dt><strong>alternative</strong><span class="classifier">str, optional</span></dt><dd><p>An alternative API that the user may use in place of the deprecated
API. The deprecation warning will tell the user about this alternative
if provided.</p>
</dd>
<dt><strong>pending</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, uses a PendingDeprecationWarning instead of a
DeprecationWarning. Cannot be used together with <em>removal</em>.</p>
</dd>
<dt><strong>obj_type</strong><span class="classifier">str, optional</span></dt><dd><p>The object type being deprecated.</p>
</dd>
<dt><strong>addendum</strong><span class="classifier">str, optional</span></dt><dd><p>Additional text appended directly to the final message.</p>
</dd>
<dt><strong>removal</strong><span class="classifier">str, optional</span></dt><dd><p>The expected removal version. With the default (an empty string), a
removal version is automatically computed from <em>since</em>. Set to other
Falsy values to not schedule a removal date. Cannot be used together
with <em>pending</em>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<p>Basic example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># To warn of the deprecation of "matplotlib.name_of_module"</span>
<span class="n">warn_deprecated</span><span class="p">(</span><span class="s1">'1.4.0'</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'matplotlib.name_of_module'</span><span class="p">,</span>
<span class="n">obj_type</span><span class="o">=</span><span class="s1">'module'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</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 - 2021 The Matplotlib development team.
<br />
Last updated on Mar 26, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.
Doc version v3.4.0-2-gcb03754703.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.