<!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" />
<title>Paste Style Guide — Paste 3.0.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Community" href="community/index.html" />
<link rel="prev" title="Python Paste Developer Guide" href="DeveloperGuidelines.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="paste-style-guide">
<h1>Paste Style Guide<a class="headerlink" href="#paste-style-guide" title="Permalink to this headline">¶</a></h1>
<p>Generally you should follow the recommendations in <a class="reference external" href="http://www.python.org/peps/pep-0008.html">PEP 8</a>, the
Python Style Guide. Some things to take particular note of:</p>
<ul>
<li><p class="first"><strong>No tabs</strong>. Not anywhere. Always indent with 4 spaces.</p>
</li>
<li><p class="first">I don’t stress too much on line length. But try to break lines up
by grouping with parenthesis instead of with backslashes (if you
can). Do asserts like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">assert</span> <span class="n">some_condition</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="p">(</span>
<span class="s2">"Some condition failed, </span><span class="si">%r</span><span class="s2"> isn't right!"</span> <span class="o">%</span> <span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">But if you are having problems with line length, maybe you should
just break the expression up into multiple statements.</p>
</li>
<li><p class="first">Blank lines between methods, unless they are very small and closely
bound to each other.</p>
</li>
<li><p class="first">Don’t use the form <code class="docutils literal notranslate"><span class="pre">condition</span> <span class="pre">and</span> <span class="pre">trueValue</span> <span class="pre">or</span> <span class="pre">falseValue</span></code>. Break
it out and use a variable.</p>
</li>
<li><p class="first">I (Ian Bicking) am very picky about whitespace. There’s one and
only one right way to do it. Good examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">short</span> <span class="o">=</span> <span class="mi">3</span>
<span class="n">longerVar</span> <span class="o">=</span> <span class="mi">4</span>
<span class="k">if</span> <span class="n">x</span> <span class="o">==</span> <span class="mi">4</span><span class="p">:</span>
<span class="n">do</span> <span class="n">stuff</span>
<span class="n">func</span><span class="p">(</span><span class="n">arg1</span><span class="o">=</span><span class="s1">'a'</span><span class="p">,</span> <span class="n">arg2</span><span class="o">=</span><span class="s1">'b'</span><span class="p">)</span>
<span class="n">func</span><span class="p">((</span><span class="n">a</span> <span class="o">+</span> <span class="n">b</span><span class="p">)</span><span class="o">*</span><span class="mi">10</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>Bad</strong> examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">short</span> <span class="o">=</span><span class="mi">3</span>
<span class="n">longerVar</span><span class="o">=</span><span class="mi">4</span>
<span class="k">if</span> <span class="n">x</span><span class="o">==</span><span class="mi">4</span><span class="p">:</span> <span class="n">do</span> <span class="n">stuff</span>
<span class="n">func</span><span class="p">(</span><span class="n">arg1</span> <span class="o">=</span> <span class="s1">'a'</span><span class="p">,</span> <span class="n">arg2</span> <span class="o">=</span> <span class="s1">'b'</span><span class="p">)</span>
<span class="n">func</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="n">func</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="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>
</pre></div>
</div>
<p>If the whitespace isn’t right, it’ll annoy me and I’ll feel a need
to fix it. Really, this whitespace stuff shouldn’t be that
controversial should it? Some particular points that I feel
strongly about:</p>
<ul class="simple">
<li>No space after a function name (bad: <code class="docutils literal notranslate"><span class="pre">func</span> <span class="pre">(arg)</span></code>).</li>
<li>No space after or before a parenthesis (bad: <code class="docutils literal notranslate"><span class="pre">func(</span> <span class="pre">arg</span> <span class="pre">)</span></code>).</li>
<li>Always one space after a comma (bad: <code class="docutils literal notranslate"><span class="pre">func(a,b)</span></code>).</li>
</ul>
</li>
<li><p class="first">Use <code class="docutils literal notranslate"><span class="pre">@@</span></code> to mark something that is suboptimal, or where you have a
concern that it’s not right. Try to also date it and put your
username there.</p>
</li>
<li><p class="first">Docstrings are good. They should look like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">AClass</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> doc string...</span>
<span class="sd"> """</span>
</pre></div>
</div>
<p>Don’t use single quotes (‘’‘) – they tend to cause problems in
Emacs. Don’t bother trying make the string less vertically compact.</p>
</li>
<li><p class="first">Comments go right before the thing they are commenting on.</p>
</li>
<li><p class="first">Methods never, ever, ever start with capital letters. Generally
only classes are capitalized. But definitely never methods.</p>
</li>
<li><p class="first">Use <code class="docutils literal notranslate"><span class="pre">cls</span></code> to refer to a class. Use <code class="docutils literal notranslate"><span class="pre">meta</span></code> to refer to a
metaclass (which also happens to be a class, but calling a metaclass
<code class="docutils literal notranslate"><span class="pre">cls</span></code> will be confusing).</p>
</li>
<li><p class="first">Use <code class="docutils literal notranslate"><span class="pre">isinstance</span></code> instead of comparing types. E.g.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">var</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span> <span class="o">...</span>
<span class="c1"># Bad:</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">var</span><span class="p">)</span> <span class="ow">is</span> <span class="n">StringType</span><span class="p">:</span> <span class="o">...</span>
</pre></div>
</div>
</li>
<li><p class="first">Never, ever use two leading underscores. This is annoyingly
private. If name clashes are a concern, use explicit name mangling
instead (e.g., <code class="docutils literal notranslate"><span class="pre">_MyThing_blahblah</span></code>). This is essentially the same
thing as double-underscore, only it’s transparent where double
underscore obscures.</p>
</li>
<li><p class="first">Module names should be unique in the package. Subpackages shouldn’t
share module names with sibling or parent packages. Sadly this
isn’t possible for <code class="docutils literal notranslate"><span class="pre">__init__.py</span></code>, but it’s otherwise easy enough.</p>
</li>
<li><p class="first">Module names should be all lower case, and probably have no
underscores (smushedwords).</p>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">Paste</a></h1>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="news.html">News</a></li>
<li class="toctree-l1"><a class="reference internal" href="future.html">The Future Of Paste</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing-applications.html">Testing Applications with Paste</a></li>
<li class="toctree-l1"><a class="reference internal" href="url-parsing-with-wsgi.html">URL Parsing With WSGI And Paste</a></li>
<li class="toctree-l1"><a class="reference internal" href="do-it-yourself-framework.html">A Do-It-Yourself Framework</a></li>
<li class="toctree-l1"><a class="reference internal" href="paste-httpserver-threadpool.html">The Paste HTTP Server Thread Pool</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer-features.html">Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="DeveloperGuidelines.html">Python Paste Developer Guide</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Paste Style Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="paste-httpserver-threadpool.html">The Paste HTTP Server Thread Pool</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing-applications.html">Testing Applications with Paste</a></li>
<li class="toctree-l1"><a class="reference internal" href="url-parsing-with-wsgi.html">URL Parsing With WSGI And Paste</a></li>
<li class="toctree-l1"><a class="reference internal" href="community/index.html">Community</a></li>
<li class="toctree-l1"><a class="reference internal" href="community/mailing-list.html">Mailing Lists</a></li>
<li class="toctree-l1"><a class="reference internal" href="community/repository.html">Repository</a></li>
<li class="toctree-l1"><a class="reference internal" href="download/index.html">Downloads</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="DeveloperGuidelines.html" title="previous chapter">Python Paste Developer Guide</a></li>
<li>Next: <a href="community/index.html" title="next chapter">Community</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2008, Ian Bicking.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
<a href="_sources/StyleGuide.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
2e7d6afabca505179b7720e5a054dd0f
>
files
>
342
