-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathDocumentation.html
More file actions
240 lines (224 loc) · 16.4 KB
/
Documentation.html
File metadata and controls
240 lines (224 loc) · 16.4 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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Documentation — Programming in Python 7.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" 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/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Packages and Packaging" href="Packaging.html" />
<link rel="prev" title="Code Structure, Modules, and Namespaces" href="Modules.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: #4b2e83" >
<a href="../index.html">
<img src="../_static/UWPCE_logo_full.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Topics in the Program</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../topics/01-setting_up/index.html">1. Setting up your Environment</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/02-basic_python/index.html">2. Basic Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/03-recursion_booleans/index.html">3. Booleans and Recursion</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/04-sequences_iteration/index.html">4. Sequences and Iteration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/05-text_handling/index.html">5. Basic Text Handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/06-exceptions/index.html">6. Exception Handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/07-unit_testing/index.html">7. Unit Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/08-dicts_sets/index.html">8. Dictionaries and Sets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/09-files/index.html">9. File Handling</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../topics/10-modules_packages/index.html">10. Modules and Packages</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="NamingThings.html">Style and Naming</a></li>
<li class="toctree-l2"><a class="reference internal" href="Modules.html">Code Structure, Modules, and Namespaces</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="Packaging.html">Packages and Packaging</a></li>
<li class="toctree-l2"><a class="reference internal" href="../exercises/packaging/package_lab.html">A Small Example Package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../exercises/mailroom/mailroom-pkg.html">Mailroom – as a Python Package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../topics/11-argument_passing/index.html">11. Advanced Argument Passing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/12-comprehensions/index.html">12. Comprehensions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/13-intro_oo/index.html">13. Intro to Object Oriented Programing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/14-magic_methods/index.html">14. Properties and Magic Methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/15-subclassing/index.html">15. Subclassing and Inheritance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/16-multiple_inheritance/index.html">16. Multiple Inheritance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/17-functional_programming/index.html">17. Introduction to Functional Programming</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/18-advanced_testing/index.html">18. Advanced Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/99-extras/index.html">19. Extra Topics</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #4b2e83" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Programming in Python</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> »</li>
<li><a href="../topics/10-modules_packages/index.html"><span class="section-number">10. </span>Modules and Packages</a> »</li>
<li>Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/modules/Documentation.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation">
<a href="Modules.html" class="btn btn-neutral float-left" title="Code Structure, Modules, and Namespaces" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="Packaging.html" class="btn btn-neutral float-right" title="Packages and Packaging" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="documentation">
<span id="id1"></span><h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h1>
<p>It’s often helpful to leave information in your code about what you were
thinking when you wrote it.</p>
<p>This can help reduce the number of <a class="reference external" href="http://www.osnews.com/story/19266/WTFs_m">WTFs per minute</a> when reading it later.</p>
<p>There are two approaches to this in Python:</p>
<ul class="simple">
<li><p>Comments</p></li>
<li><p>Docstrings</p></li>
</ul>
<p>Comments in Python are much the same as any other programing language.</p>
<p>Docstrings are more unusual.</p>
<div class="section" id="comments">
<h2>Comments<a class="headerlink" href="#comments" title="Permalink to this headline"></a></h2>
<p>Comments go inline in the body of your code, to explain reasoning:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="p">(</span><span class="n">frobnaglers</span> <span class="o">></span> <span class="n">whozits</span><span class="p">):</span>
<span class="c1"># borangas are shermed to ensure frobnagler population</span>
<span class="c1"># does not grow out of control</span>
<span class="n">sherm_the_boranga</span><span class="p">()</span>
</pre></div>
</div>
<p>You can use them to mark places you want to revisit later:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">partygoer</span> <span class="ow">in</span> <span class="n">partygoers</span><span class="p">:</span>
<span class="k">for</span> <span class="n">balloon</span> <span class="ow">in</span> <span class="n">balloons</span><span class="p">:</span>
<span class="k">for</span> <span class="n">cupcake</span> <span class="ow">in</span> <span class="n">cupcakes</span><span class="p">:</span>
<span class="c1"># TODO: Reduce time complexity here. It's killing us</span>
<span class="c1"># for large parties.</span>
<span class="n">resolve_party_favor</span><span class="p">(</span><span class="n">partygoer</span><span class="p">,</span> <span class="n">balloon</span><span class="p">,</span> <span class="n">cupcake</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="comments-about-comments">
<h2>Comments about Comments<a class="headerlink" href="#comments-about-comments" title="Permalink to this headline"></a></h2>
<blockquote>
<div><ul class="simple">
<li><p>Be judicious in your use of comments.</p></li>
<li><p>Use them when you need to.</p></li>
<li><p>Make them useful.</p></li>
<li><p>Do not use them merely to restate what the code is / should be doing. Make the code self explanatory!</p></li>
</ul>
</div></blockquote>
<p>This is not useful:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">sponge</span> <span class="ow">in</span> <span class="n">sponges</span><span class="p">:</span>
<span class="c1"># apply soap to each sponge</span>
<span class="n">worker</span><span class="o">.</span><span class="n">apply_soap</span><span class="p">(</span><span class="n">sponge</span><span class="p">)</span>
</pre></div>
</div>
<p>Note: Nothing special about Python here – basic good programing practice. Note that you will need a lot fewer comments if you choose your names well!</p>
</div>
<div class="section" id="docstrings">
<h2>Docstrings<a class="headerlink" href="#docstrings" title="Permalink to this headline"></a></h2>
<p>In Python, “docstrings” are used to provide in-line documentation in a number of places.</p>
<p>The first place we will see is in the definition of functions.</p>
<p>As you know, to define a function you use the <code class="docutils literal notranslate"><span class="pre">def</span></code> keyword.</p>
<p>If a “string literal” is the first thing in the function block following the
<code class="docutils literal notranslate"><span class="pre">def</span></code> line, it is a “docstring”:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">complex_function</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">,</span> <span class="n">kwarg1</span><span class="o">=</span><span class="s1">'banana'</span><span class="p">):</span>
<span class="sd">"""Return a value resulting from a complex calculation."""</span>
<span class="c1"># code block here</span>
</pre></div>
</div>
<p>You can then read this in the interpreter as the <code class="docutils literal notranslate"><span class="pre">__doc__</span></code> attribute of the
function object. Docstrings can also be read and processed by documentation systems and IDEs like iPython and Sphinx.</p>
<div class="section" id="a-function-docstring-should">
<h3>A Function Docstring Should:<a class="headerlink" href="#a-function-docstring-should" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Be a complete sentence in the form of a command describing what the function
does.</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">"""Return</span> <span class="pre">a</span> <span class="pre">list</span> <span class="pre">of</span> <span class="pre">values</span> <span class="pre">based</span> <span class="pre">on</span> <span class="pre">blah</span> <span class="pre">blah"""</span></code> is a good docstring</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"""Returns</span> <span class="pre">a</span> <span class="pre">list</span> <span class="pre">of</span> <span class="pre">values</span> <span class="pre">based</span> <span class="pre">on</span> <span class="pre">blah</span> <span class="pre">blah"""</span></code> is <em>not</em> as good..</p></li>
</ul>
</li>
<li><p>Have a useful single line.</p>
<ul>
<li><p>If more description is needed, make the first line a complete sentence and
add more lines below for enhancement.</p></li>
</ul>
</li>
<li><p>Be enclosed with triple-quotes.</p>
<ul>
<li><p>This allows for easy expansion if required at a later date.</p></li>
</ul>
</li>
</ul>
<p>For any functions that are less than trivial, and particularly if they take multiple parameters, the parameters should be described in the docstring:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">complex_function</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">,</span> <span class="n">kwarg1</span><span class="o">=</span><span class="s1">'banana'</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return a value resulting from a complex calculation.</span>
<span class="sd"> :param arg1: The first very important parameter. And a bit about</span>
<span class="sd"> what it means.</span>
<span class="sd"> :param arg2: The second very important parameter. And now some</span>
<span class="sd"> description of how this is used</span>
<span class="sd"> :param kwarg1='banana': An optional parameter. Some text describing</span>
<span class="sd"> what it means and why you might specify it.</span>
<span class="sd"> """</span>
<span class="c1"># The actual code here</span>
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">:param</span> <span class="pre">arg1:</span></code> notation is “restructured text” – very handy if you want your docstrings to be able to be automatically processed by documentation systems such as <a class="reference external" href="http://sphinx-doc.org/">Sphinx</a></p>
</div>
<div class="section" id="the-docstring-pep">
<h3>The docstring PEP<a class="headerlink" href="#the-docstring-pep" title="Permalink to this headline"></a></h3>
<p>For the full “official” recommendations about docstrings, see <a class="reference external" href="http://legacy.python.org/dev/peps/pep-0257/">PEP 257: Docstring Conventions</a>.</p>
</div>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Modules.html" class="btn btn-neutral float-left" title="Code Structure, Modules, and Namespaces" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="Packaging.html" class="btn btn-neutral float-right" title="Packages and Packaging" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2020, University of Washington, Natasha Aleksandrova, Christopher Barker, Brian Dorsey, Cris Ewing, Christy Heaton, Jon Jacky, Maria McKinley, Andy Miles, Rick Riehle, Joseph Schilz, Joseph Sheedy, Hosung Song. Creative Commons Attribution-ShareAlike 4.0 license.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>