forked from UWPCE-PythonCert/IntroPython-2017
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathStaticAndClassMethods.html
More file actions
231 lines (207 loc) · 13.8 KB
/
StaticAndClassMethods.html
File metadata and controls
231 lines (207 loc) · 13.8 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
<!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>Static and Class Methods — PythonCert 4.0 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '4.0',
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>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Subclassing and Inheritance" href="SubclassingAndInheritance.html" />
<link rel="prev" title="Special Methods & Protocols" href="SpecialMethodsAndProtocols.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 class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="static-and-class-methods">
<h1>Static and Class Methods<a class="headerlink" href="#static-and-class-methods" title="Permalink to this headline">¶</a></h1>
<div class="left build docutils container">
<p>You’ve seen how methods of a class are <em>bound</em> to an instance when it is
created.</p>
<p>And you’ve seen how the argument <code class="docutils literal"><span class="pre">self</span></code> is then automatically passed to
the method when it is called.</p>
<p>And you’ve seen how you can call <em>unbound</em> methods on a class object so
long as you pass an instance of that class as the first argument.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p class="centered"><strong>But what if you don’t want or need an instance?</strong></p>
</div>
<div class="section" id="static-methods">
<h2>Static Methods<a class="headerlink" href="#static-methods" title="Permalink to this headline">¶</a></h2>
<p>A <em>static method</em> is a method that doesn’t get self:</p>
<div class="highlight-ipython"><div class="highlight"><pre><span></span><span class="gp">In [36]: </span><span class="k">class</span> <span class="nc">StaticAdder</span><span class="p">:</span>
<span class="gp"> ....: </span> <span class="nd">@staticmethod</span>
<span class="gp"> ....: </span> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">):</span>
<span class="gp"> ....: </span> <span class="k">return</span> <span class="n">a</span> <span class="o">+</span> <span class="n">b</span>
<span class="gp"> ....:</span>
<span class="gp">In [37]: </span><span class="n">StaticAdder</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">6</span><span class="p">)</span>
<span class="gh">Out[37]: </span><span class="go">9</span>
</pre></div>
</div>
<div class="build docutils container">
<p>Where are static methods useful?</p>
<p>Usually they aren’t. It is often better just to write a module-level function.</p>
<p>An example from the Standard Library (tarfile.py):</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">TarInfo</span><span class="p">:</span>
<span class="c1"># ...</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">_create_payload</span><span class="p">(</span><span class="n">payload</span><span class="p">):</span>
<span class="sd">"""Return the string payload filled with zero bytes</span>
<span class="sd"> up to the next 512 byte border.</span>
<span class="sd"> """</span>
<span class="n">blocks</span><span class="p">,</span> <span class="n">remainder</span> <span class="o">=</span> <span class="nb">divmod</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">payload</span><span class="p">),</span> <span class="n">BLOCKSIZE</span><span class="p">)</span>
<span class="k">if</span> <span class="n">remainder</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="n">payload</span> <span class="o">+=</span> <span class="p">(</span><span class="n">BLOCKSIZE</span> <span class="o">-</span> <span class="n">remainder</span><span class="p">)</span> <span class="o">*</span> <span class="n">NUL</span>
<span class="k">return</span> <span class="n">payload</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="class-methods">
<h2>Class Methods<a class="headerlink" href="#class-methods" title="Permalink to this headline">¶</a></h2>
<p>A class method gets the class object, rather than an instance, as the first
argument</p>
<div class="highlight-ipython"><div class="highlight"><pre><span></span><span class="gp">In [41]: </span><span class="k">class</span> <span class="nc">Classy</span><span class="p">:</span>
<span class="gp"> ....: </span> <span class="n">x</span> <span class="o">=</span> <span class="mi">2</span>
<span class="gp"> ....: </span> <span class="nd">@classmethod</span>
<span class="gp"> ....: </span> <span class="k">def</span> <span class="nf">a_class_method</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
<span class="gp"> ....: </span> <span class="k">print</span><span class="p">(</span><span class="s2">"in a class method: "</span><span class="p">,</span> <span class="bp">cls</span><span class="p">)</span>
<span class="gp"> ....: </span> <span class="k">return</span> <span class="n">y</span> <span class="o">**</span> <span class="bp">cls</span><span class="o">.</span><span class="n">x</span>
<span class="gp"> ....:</span>
<span class="gp">In [42]: </span><span class="n">Classy</span><span class="o">.</span><span class="n">a_class_method</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
<span class="go">in a class method: <class '__main__.Classy'></span>
<span class="gh">Out[42]: </span><span class="go">16</span>
</pre></div>
</div>
</div>
<div class="centered section" id="why">
<h2>Why?<a class="headerlink" href="#why" title="Permalink to this headline">¶</a></h2>
<div class="build docutils container">
<p>Unlike static methods, class methods are quite common.</p>
<p>They have the advantage of being friendly to subclassing.</p>
<p>Consider this:</p>
<div class="highlight-ipython"><div class="highlight"><pre><span></span><span class="gp">In [44]: </span><span class="k">class</span> <span class="nc">SubClassy</span><span class="p">(</span><span class="n">Classy</span><span class="p">):</span>
<span class="gp"> ....: </span> <span class="n">x</span> <span class="o">=</span> <span class="mi">3</span>
<span class="gp"> ....:</span>
<span class="gp">In [45]: </span><span class="n">SubClassy</span><span class="o">.</span><span class="n">a_class_method</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
<span class="go">in a class method: <class '__main__.SubClassy'></span>
<span class="gh">Out[45]: </span><span class="go">64</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="alternate-constructors">
<h2>Alternate Constructors<a class="headerlink" href="#alternate-constructors" title="Permalink to this headline">¶</a></h2>
<p>Because of this friendliness to subclassing, class methods are often used to
build alternate constructors.</p>
<p>Consider the case of wanting to build a dictionary with a given iterable of
keys:</p>
<div class="highlight-ipython"><div class="highlight"><pre><span></span><span class="gp">In [57]: </span><span class="n">d</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">])</span>
<span class="gt">---------------------------------------------------------------------------</span>
<span class="ne">TypeError</span><span class="g g-Whitespace"> </span>Traceback (most recent call last)
<span class="nn"><ipython-input-57-50c56a77d95f></span> in <span class="ni"><module></span><span class="nt">()</span>
<span class="ne">----> </span><span class="mi">1</span> <span class="n">d</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">])</span>
<span class="ne">TypeError</span>: cannot convert dictionary update sequence element #0 to a sequence
</pre></div>
</div>
<p>The stock constructor for a dictionary won’t work this way. So the dict object
implements an alternate constructor that <em>can</em>.</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">fromkeys</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">iterable</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">'''OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S.</span>
<span class="sd"> If not specified, the value defaults to None.</span>
<span class="sd"> '''</span>
<span class="bp">self</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">iterable</span><span class="p">:</span>
<span class="bp">self</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">return</span> <span class="bp">self</span>
</pre></div>
</div>
<p>(this is actually from the OrderedDict implementation in <code class="docutils literal"><span class="pre">collections.py</span></code>)</p>
<p>See also datetime.datetime.now(), etc….</p>
<p>Properties, Static Methods and Class Methods are powerful features of Python’s
OO model.</p>
<p>They are implemented using an underlying structure called <em>descriptors</em></p>
<p><a class="reference external" href="https://docs.python.org/2/howto/descriptor.html">Here is a low level look</a> at how the descriptor protocol works.</p>
<p>The cool part is that this mechanism is available to you, the programmer, as
well.</p>
<p>For the Circle Lab: use a class method to make an alternate constructor that takes
the diameter instead.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Static and Class Methods</a><ul>
<li><a class="reference internal" href="#static-methods">Static Methods</a></li>
<li><a class="reference internal" href="#class-methods">Class Methods</a></li>
<li><a class="reference internal" href="#why">Why?</a></li>
<li><a class="reference internal" href="#alternate-constructors">Alternate Constructors</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li>Previous: <a href="SpecialMethodsAndProtocols.html" title="previous chapter">Special Methods & Protocols</a></li>
<li>Next: <a href="SubclassingAndInheritance.html" title="next chapter">Subclassing and Inheritance</a></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/modules/StaticAndClassMethods.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="clearer"></div>
</div>
<div class="footer">
©2017, Christopher Barker, Cris Ewing, Christy Heaton, Maria McKinley, Rick Riehle, Joseph Schilz.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.2</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
<a href="../_sources/modules/StaticAndClassMethods.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>