/usr/share/doc/mopidy-doc/html/codestyle.html is in mopidy-doc 2.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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>Code style — Mopidy 2.1.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: '2.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="Mopidy 2.1.0 documentation" href="index.html" />
<link rel="next" title="Extension development" href="extensiondev.html" />
<link rel="prev" title="Release procedures" href="releasing.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 role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="code-style">
<span id="codestyle"></span><h1>Code style<a class="headerlink" href="#code-style" title="Permalink to this headline">ΒΆ</a></h1>
<ul>
<li><p class="first">Always import <code class="docutils literal"><span class="pre">unicode_literals</span></code> and use unicode literals for everything
except where you’re explicitly working with bytes, which are marked with the
<code class="docutils literal"><span class="pre">b</span></code> prefix.</p>
<p>Do this:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">unicode_literals</span>
<span class="n">foo</span> <span class="o">=</span> <span class="s1">'I am a unicode string, which is a sane default'</span>
<span class="n">bar</span> <span class="o">=</span> <span class="n">b</span><span class="s1">'I am a bytestring'</span>
</pre></div>
</div>
<p>Not this:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">foo</span> <span class="o">=</span> <span class="s1">u'I am a unicode string'</span>
<span class="n">bar</span> <span class="o">=</span> <span class="s1">'I am a bytestring, but was it intentional?'</span>
</pre></div>
</div>
</li>
<li><p class="first">Follow <span class="target" id="index-0"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0008"><strong>PEP 8</strong></a> unless otherwise noted. <a class="reference external" href="https://pypi.python.org/pypi/flake8">flake8</a> should be used to check your code
against the guidelines.</p>
</li>
<li><p class="first">Use four spaces for indentation, <em>never</em> tabs.</p>
</li>
<li><p class="first">Use CamelCase with initial caps for class names:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ClassNameWithCamelCase</span>
</pre></div>
</div>
</li>
<li><p class="first">Use underscore to split variable, function and method names for
readability. Don’t use CamelCase.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">lower_case_with_underscores</span>
</pre></div>
</div>
</li>
<li><p class="first">Use the fact that empty strings, lists and tuples are <code class="xref py py-class docutils literal"><span class="pre">False</span></code> and
don’t compare boolean values using <code class="docutils literal"><span class="pre">==</span></code> and <code class="docutils literal"><span class="pre">!=</span></code>.</p>
</li>
<li><p class="first">Follow whitespace rules as described in <span class="target" id="index-1"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0008"><strong>PEP 8</strong></a>. Good examples:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">spam</span><span class="p">(</span><span class="n">ham</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="p">{</span><span class="n">eggs</span><span class="p">:</span> <span class="mi">2</span><span class="p">})</span>
<span class="n">spam</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="nb">dict</span><span class="p">[</span><span class="s1">'key'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">list</span><span class="p">[</span><span class="n">index</span><span class="p">]</span>
</pre></div>
</div>
</li>
<li><p class="first">Limit lines to 80 characters and avoid trailing whitespace. However note that
wrapped lines should be <em>one</em> indentation level in from level above, except
for <code class="docutils literal"><span class="pre">if</span></code>, <code class="docutils literal"><span class="pre">for</span></code>, <code class="docutils literal"><span class="pre">with</span></code>, and <code class="docutils literal"><span class="pre">while</span></code> lines which should have two
levels of indentation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="p">(</span><span class="n">foo</span> <span class="ow">and</span> <span class="n">bar</span> <span class="o">...</span>
<span class="n">baz</span> <span class="ow">and</span> <span class="n">foobar</span><span class="p">):</span>
<span class="n">a</span> <span class="o">=</span> <span class="mi">1</span>
<span class="kn">from</span> <span class="nn">foobar</span> <span class="k">import</span> <span class="p">(</span><span class="n">foo</span><span class="p">,</span> <span class="n">bar</span><span class="p">,</span> <span class="o">...</span>
<span class="n">baz</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">For consistency, prefer <code class="docutils literal"><span class="pre">'</span></code> over <code class="docutils literal"><span class="pre">"</span></code> for strings, unless the string
contains <code class="docutils literal"><span class="pre">'</span></code>.</p>
</li>
<li><p class="first">Take a look at <span class="target" id="index-2"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0020"><strong>PEP 20</strong></a> for a nice peek into a general mindset useful for
Python coding.</p>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="releasing.html" title="previous chapter">Release procedures</a></li>
<li>Next: <a href="extensiondev.html" title="next chapter">Extension development</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/codestyle.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">
©2009-2017, Stein Magnus Jodal and contributors.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
<a href="_sources/codestyle.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|