{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathMEP13.html
More file actions
381 lines (348 loc) · 31 KB
/
Copy pathMEP13.html
File metadata and controls
381 lines (348 loc) · 31 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MEP13: Use properties for Artists — Matplotlib 2.1.1 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.1.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.1.1 documentation"
href="../../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html"
/>
<link rel="search" title="Search" href="../../search.html"
/>
<link rel="top" title="Matplotlib 2.1.1 documentation" href="../../index.html" />
<link rel="up" title="Matplotlib Enhancement Proposals" href="index.html" />
<link rel="next" title="MEP14: Text handling" href="MEP14.html" />
<link rel="prev" title="MEP12: Improve Gallery and Examples" href="MEP12.html" />
<link rel="canonical" href="https://matplotlib.org/stable/devel/MEP/MEP13.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.1.1). For the latest version see <a href="https://matplotlib.org/stable/devel/MEP/MEP13.html">https://matplotlib.org/stable/devel/MEP/MEP13.html</a></div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../../index.html"><img src="../../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="MEP14.html" title="MEP14: Text handling"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="MEP12.html" title="MEP12: Improve Gallery and Examples"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../gallery/index.html">examples</a>| </li>
<li><a href="../../tutorials/index.html">tutorials</a>| </li>
<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>
<li><a href="../../contents.html">docs</a> »</li>
<li><a href="../index.html" >The Matplotlib Developers’ Guide</a> »</li>
<li><a href="index.html" accesskey="U">Matplotlib Enhancement Proposals</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><a href="https://www.numfocus.org">
<image src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A">
</a>
<br/>
<a href="http://depsy.org/package/python/matplotlib">
<img src="../../_static/depsy_badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">MEP13: Use properties for Artists</a><ul>
<li><a class="reference internal" href="#status">Status</a></li>
<li><a class="reference internal" href="#branches-and-pull-requests">Branches and Pull requests</a></li>
<li><a class="reference internal" href="#abstract">Abstract</a></li>
<li><a class="reference internal" href="#detailed-description">Detailed description</a></li>
<li><a class="reference internal" href="#implementation">Implementation</a></li>
<li><a class="reference internal" href="#backward-compatibility">Backward compatibility</a></li>
<li><a class="reference internal" href="#examples">Examples</a><ul>
<li><a class="reference internal" href="#axes-axes-set-axis-off-set-axis-on">axes.Axes.set_axis_off/set_axis_on</a></li>
<li><a class="reference internal" href="#axes-axes-get-xlim-set-xlim-and-get-autoscalex-on-set-autoscalex-on">axes.Axes.get_xlim/set_xlim and get_autoscalex_on/set_autoscalex_on</a></li>
<li><a class="reference internal" href="#axes-axes-get-title-set-title">axes.Axes.get_title/set_title</a></li>
<li><a class="reference internal" href="#axes-axes-get-xticklabels-set-xticklabels">axes.Axes.get_xticklabels/set_xticklabels</a></li>
</ul>
</li>
<li><a class="reference internal" href="#alternatives">Alternatives</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">The Matplotlib Developers’ Guide</a><ul>
<li><a href="index.html">Matplotlib Enhancement Proposals</a><ul>
<li>Previous: <a href="MEP12.html" title="previous chapter">MEP12: Improve Gallery and Examples</a></li>
<li>Next: <a href="MEP14.html" title="next chapter">MEP14: Text handling</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/devel/MEP/MEP13.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="mep13-use-properties-for-artists">
<h1>MEP13: Use properties for Artists<a class="headerlink" href="#mep13-use-properties-for-artists" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#status" id="id1">Status</a></li>
<li><a class="reference internal" href="#branches-and-pull-requests" id="id2">Branches and Pull requests</a></li>
<li><a class="reference internal" href="#abstract" id="id3">Abstract</a></li>
<li><a class="reference internal" href="#detailed-description" id="id4">Detailed description</a></li>
<li><a class="reference internal" href="#implementation" id="id5">Implementation</a></li>
<li><a class="reference internal" href="#backward-compatibility" id="id6">Backward compatibility</a></li>
<li><a class="reference internal" href="#examples" id="id7">Examples</a><ul>
<li><a class="reference internal" href="#axes-axes-set-axis-off-set-axis-on" id="id8">axes.Axes.set_axis_off/set_axis_on</a></li>
<li><a class="reference internal" href="#axes-axes-get-xlim-set-xlim-and-get-autoscalex-on-set-autoscalex-on" id="id9">axes.Axes.get_xlim/set_xlim and get_autoscalex_on/set_autoscalex_on</a></li>
<li><a class="reference internal" href="#axes-axes-get-title-set-title" id="id10">axes.Axes.get_title/set_title</a></li>
<li><a class="reference internal" href="#axes-axes-get-xticklabels-set-xticklabels" id="id11">axes.Axes.get_xticklabels/set_xticklabels</a></li>
</ul>
</li>
<li><a class="reference internal" href="#alternatives" id="id12">Alternatives</a></li>
</ul>
</div>
<div class="section" id="status">
<h2><a class="toc-backref" href="#id1">Status</a><a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><strong>Discussion</strong></li>
</ul>
</div>
<div class="section" id="branches-and-pull-requests">
<h2><a class="toc-backref" href="#id2">Branches and Pull requests</a><a class="headerlink" href="#branches-and-pull-requests" title="Permalink to this headline">¶</a></h2>
<p>None</p>
</div>
<div class="section" id="abstract">
<h2><a class="toc-backref" href="#id3">Abstract</a><a class="headerlink" href="#abstract" title="Permalink to this headline">¶</a></h2>
<p>Wrap all of the matplotlib getter and setter methods with python
<a class="reference external" href="https://docs.python.org/3/library/functions.html#property">properties</a>, allowing
them to be read and written like class attributes.</p>
</div>
<div class="section" id="detailed-description">
<h2><a class="toc-backref" href="#id4">Detailed description</a><a class="headerlink" href="#detailed-description" title="Permalink to this headline">¶</a></h2>
<p>Currently matplotlib uses getter and setter functions (usually
prefixed with get_ and set_, respectively) for reading and writing
data related to classes. However, since 2.6 python supports
properties, which allow such setter and getter functions to be
accessed as though they were attributes. This proposal would
implement all existing setter and getter methods as properties.</p>
</div>
<div class="section" id="implementation">
<h2><a class="toc-backref" href="#id5">Implementation</a><a class="headerlink" href="#implementation" title="Permalink to this headline">¶</a></h2>
<ol class="arabic simple">
<li>All existing getter and setter methods will need to have two
aliases, one with the get_ or set_ prefix and one without.
Getter methods that currently lack prefixes should be recording in
a text file.</li>
<li>Classes should be reorganized so setter and getter methods are
sequential in the code, with getter methods first.</li>
<li>Getter and setter methods the provide additional optional optional
arguments should have those arguments accessible in another manner,
either as additional getter or setter methods or attributes of
other classes. If those classes are not accessible, getters for
them should be added.</li>
<li>Property decorators will be added to the setter and getter methods
without the prefix. Those with the prefix will be marked as
deprecated.</li>
<li>Docstrings will need to be rewritten so the getter with the prefix
has the current docstring and the getter without the prefix has a
generic docstring appropriate for an attribute.</li>
<li>Automatic alias generation will need to be modified so it will also
create aliases for the properties.</li>
<li>All instances of getter and setter method calls will need to be
changed to attribute access.</li>
<li>All setter and getter aliases with prefixes will be removed</li>
</ol>
<p>The following steps can be done simultaneously: 1, 2, and 3; 4 and 5;
6 and 7.</p>
<p>Only the following steps must be done in the same release: 4, 5,
and 6. All other changes can be done in separate releases. 8 should
be done several major releases after everything else.</p>
</div>
<div class="section" id="backward-compatibility">
<h2><a class="toc-backref" href="#id6">Backward compatibility</a><a class="headerlink" href="#backward-compatibility" title="Permalink to this headline">¶</a></h2>
<p>All existing getter methods that do not have a prefix (such as get_)
will need to be changed from function calls to attribute access. In
most cases this will only require removing the parenthesis.</p>
<p>setter and getter methods that have additional optional arguments will
need to have those arguments implemented in another way, either as a
separate property in the same class or as attributes or properties of
another class.</p>
<p>Cases where the setter returns a value will need to be changed to
using the setter followed by the getter.</p>
<p>Cases where there are set_ATTR_on() and set_ATTR_off() methods will be
changed to ATTR_on properties.</p>
</div>
<div class="section" id="examples">
<h2><a class="toc-backref" href="#id7">Examples</a><a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<div class="section" id="axes-axes-set-axis-off-set-axis-on">
<h3><a class="toc-backref" href="#id8">axes.Axes.set_axis_off/set_axis_on</a><a class="headerlink" href="#axes-axes-set-axis-off-set-axis-on" title="Permalink to this headline">¶</a></h3>
<p>Current implementation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">set_axis_off</span><span class="p">()</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">set_axis_on</span><span class="p">()</span>
</pre></div>
</div>
<p>New implementation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kc">True</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">axis_on</span>
<span class="kc">False</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">axis_on</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">axis_on</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">axis_on</span> <span class="o">=</span> <span class="kc">False</span>
</pre></div>
</div>
</div>
<div class="section" id="axes-axes-get-xlim-set-xlim-and-get-autoscalex-on-set-autoscalex-on">
<h3><a class="toc-backref" href="#id9">axes.Axes.get_xlim/set_xlim and get_autoscalex_on/set_autoscalex_on</a><a class="headerlink" href="#axes-axes-get-xlim-set-xlim-and-get-autoscalex-on-set-autoscalex-on" title="Permalink to this headline">¶</a></h3>
<p>Current implementation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">get_xlim</span><span class="p">()</span>
<span class="n">auto</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">get_autoscalex_on</span><span class="p">()</span>
<span class="p">[</span><span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">set_xlim</span><span class="p">(</span><span class="n">left</span><span class="o">=</span><span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="o">=</span><span class="n">right</span><span class="p">,</span> <span class="n">emit</span><span class="o">=</span><span class="n">emit</span><span class="p">,</span> <span class="n">auto</span><span class="o">=</span><span class="n">auto</span><span class="p">)</span>
<span class="p">[</span><span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">set_xlim</span><span class="p">(</span><span class="n">left</span><span class="o">=</span><span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">emit</span><span class="o">=</span><span class="n">emit</span><span class="p">,</span> <span class="n">auto</span><span class="o">=</span><span class="n">auto</span><span class="p">)</span>
<span class="p">[</span><span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">set_xlim</span><span class="p">(</span><span class="n">left</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">right</span><span class="o">=</span><span class="n">right</span><span class="p">,</span> <span class="n">emit</span><span class="o">=</span><span class="n">emit</span><span class="p">,</span> <span class="n">auto</span><span class="o">=</span><span class="n">auto</span><span class="p">)</span>
<span class="p">[</span><span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">set_xlim</span><span class="p">(</span><span class="n">left</span><span class="o">=</span><span class="n">left</span><span class="p">,</span> <span class="n">emit</span><span class="o">=</span><span class="n">emit</span><span class="p">,</span> <span class="n">auto</span><span class="o">=</span><span class="n">auto</span><span class="p">)</span>
<span class="p">[</span><span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">set_xlim</span><span class="p">(</span><span class="n">right</span><span class="o">=</span><span class="n">right</span><span class="p">,</span> <span class="n">emit</span><span class="o">=</span><span class="n">emit</span><span class="p">,</span> <span class="n">auto</span><span class="o">=</span><span class="n">auto</span><span class="p">)</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">set_autoscalex_on</span><span class="p">(</span><span class="n">auto</span><span class="p">)</span>
</pre></div>
</div>
<p>New implementation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">axes_xlim</span>
<span class="n">auto</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">autoscalex_on</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">axes_xlim</span> <span class="o">=</span> <span class="p">[</span><span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">]</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">axes_xlim</span> <span class="o">=</span> <span class="p">[</span><span class="n">left</span><span class="p">,</span> <span class="kc">None</span><span class="p">]</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">axes_xlim</span> <span class="o">=</span> <span class="p">[</span><span class="kc">None</span><span class="p">,</span> <span class="n">right</span><span class="p">]</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">axes_xlim</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">left</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">axes_xlim</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">right</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">autoscalex_on</span> <span class="o">=</span> <span class="n">auto</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">emit_xlim</span> <span class="o">=</span> <span class="n">emit</span>
</pre></div>
</div>
</div>
<div class="section" id="axes-axes-get-title-set-title">
<h3><a class="toc-backref" href="#id10">axes.Axes.get_title/set_title</a><a class="headerlink" href="#axes-axes-get-title-set-title" title="Permalink to this headline">¶</a></h3>
<p>Current implementation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">string</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">get_title</span><span class="p">()</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="n">string</span><span class="p">,</span> <span class="n">fontdict</span><span class="o">=</span><span class="n">fontdict</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>New implementation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">string</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">title</span>
<span class="n">string</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">title_text</span><span class="o">.</span><span class="n">text</span>
<span class="n">text</span><span class="o">.</span><span class="n">Text</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">title_text</span>
<span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="o">.<</span><span class="n">attribute</span><span class="o">></span> <span class="o">=</span> <span class="n">attribute</span>
<span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="o">.</span><span class="n">fontdict</span> <span class="o">=</span> <span class="n">fontdict</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">title</span> <span class="o">=</span> <span class="n">string</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">title</span> <span class="o">=</span> <span class="n">text</span><span class="o">.</span><span class="n">Text</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">title_text</span> <span class="o">=</span> <span class="n">string</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">title_text</span> <span class="o">=</span> <span class="n">text</span><span class="o">.</span><span class="n">Text</span>
</pre></div>
</div>
</div>
<div class="section" id="axes-axes-get-xticklabels-set-xticklabels">
<h3><a class="toc-backref" href="#id11">axes.Axes.get_xticklabels/set_xticklabels</a><a class="headerlink" href="#axes-axes-get-xticklabels-set-xticklabels" title="Permalink to this headline">¶</a></h3>
<p>Current implementation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">get_xticklabels</span><span class="p">()</span>
<span class="p">[</span><span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">get_xticklabels</span><span class="p">(</span><span class="n">minor</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="p">[</span><span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">get_xticklabels</span><span class="p">(</span><span class="n">minor</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="p">[</span><span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="p">([</span><span class="n">string</span><span class="p">],</span> <span class="n">fontdict</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="p">[</span><span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="p">([</span><span class="n">string</span><span class="p">],</span> <span class="n">fontdict</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">minor</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="p">[</span><span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="p">([</span><span class="n">string</span><span class="p">],</span> <span class="n">fontdict</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">minor</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>New implementation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">xticklabels</span>
<span class="p">[</span><span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="p">]</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">xminorticklabels</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">xticklabels</span> <span class="o">=</span> <span class="p">[</span><span class="n">string</span><span class="p">]</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">xminorticklabels</span> <span class="o">=</span> <span class="p">[</span><span class="n">string</span><span class="p">]</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">xticklabels</span> <span class="o">=</span> <span class="p">[</span><span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="p">]</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="o">.</span><span class="n">xminorticklabels</span> <span class="o">=</span> <span class="p">[</span><span class="n">text</span><span class="o">.</span><span class="n">Text</span><span class="p">]</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="alternatives">
<h2><a class="toc-backref" href="#id12">Alternatives</a><a class="headerlink" href="#alternatives" title="Permalink to this headline">¶</a></h2>
<p>Instead of using decorators, it is also possible to use the property
function. This would change the procedure so that all getter methods
that lack a prefix will need to be renamed or removed. This makes
handling docstrings more difficult and harder to read.</p>
<p>It is not necessary to deprecate the setter and getter methods, but
leaving them in will complicate the code.</p>
<p>This could also serve as an opportunity to rewrite or even remove
automatic alias generation.</p>
<p>Another alternate proposal:</p>
<p>Convert <code class="docutils literal"><span class="pre">set_xlim</span></code>, <code class="docutils literal"><span class="pre">set_xlabel</span></code>, <code class="docutils literal"><span class="pre">set_title</span></code>, etc. to <code class="docutils literal"><span class="pre">xlim</span></code>,
<code class="docutils literal"><span class="pre">xlabel</span></code>, <code class="docutils literal"><span class="pre">title</span></code>,… to make the transition from <code class="docutils literal"><span class="pre">plt</span></code>
functions to <code class="docutils literal"><span class="pre">axes</span></code> methods significantly simpler. These would still
be methods, not properties, but it’s still a great usability
enhancement while retaining the interface.</p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2017 The Matplotlib development team.
Last updated on Dec 11, 2017.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
</div>
</body>
<footer>
</footer>
</html>
You can’t perform that action at this time.