<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Advanced usage — pep8 1.7.1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pep8 API" href="api.html" />
<link rel="prev" title="Introduction" href="intro.html" />
<script src="_static/js/modernizr.min.js"></script>
</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">
<a href="index.html" class="icon icon-home"> pep8
</a>
<div class="version">
1.7
</div>
<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="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Advanced usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#automated-tests">Automated tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="#skip-file-header">Skip file header</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer.html">Developer’s notes</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pep8</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Advanced usage</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/advanced.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="advanced-usage">
<h1>Advanced usage<a class="headerlink" href="#advanced-usage" title="Permalink to this headline">¶</a></h1>
<div class="section" id="automated-tests">
<h2>Automated tests<a class="headerlink" href="#automated-tests" title="Permalink to this headline">¶</a></h2>
<p>You can also execute <cite>pep8</cite> tests from Python code. For example, this
can be highly useful for automated testing of coding style conformance
in your project:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">unittest</span>
<span class="kn">import</span> <span class="nn">pep8</span>
<span class="k">class</span> <span class="nc">TestCodeFormat</span><span class="p">(</span><span class="n">unittest</span><span class="o">.</span><span class="n">TestCase</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">test_pep8_conformance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Test that we conform to PEP8."""</span>
<span class="n">pep8style</span> <span class="o">=</span> <span class="n">pep8</span><span class="o">.</span><span class="n">StyleGuide</span><span class="p">(</span><span class="n">quiet</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">pep8style</span><span class="o">.</span><span class="n">check_files</span><span class="p">([</span><span class="s1">'file1.py'</span><span class="p">,</span> <span class="s1">'file2.py'</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">total_errors</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"Found code style errors (and warnings)."</span><span class="p">)</span>
</pre></div>
</div>
<p>If you are using <cite>nosetests</cite> for running tests, remove <cite>quiet=True</cite>
since Nose suppresses stdout.</p>
<p>There’s also a shortcut for checking a single file:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pep8</span>
<span class="n">fchecker</span> <span class="o">=</span> <span class="n">pep8</span><span class="o">.</span><span class="n">Checker</span><span class="p">(</span><span class="s1">'testsuite/E27.py'</span><span class="p">,</span> <span class="n">show_source</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">file_errors</span> <span class="o">=</span> <span class="n">fchecker</span><span class="o">.</span><span class="n">check_all</span><span class="p">()</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Found </span><span class="si">%s</span><span class="s2"> errors (and warnings)"</span> <span class="o">%</span> <span class="n">file_errors</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="skip-file-header">
<h2>Skip file header<a class="headerlink" href="#skip-file-header" title="Permalink to this headline">¶</a></h2>
<p>Another example is related to the <a class="reference external" href="https://github.com/pycqa/pep8/issues/143">feature request #143</a>: skip a number of lines
at the beginning and the end of a file. This use case is easy to implement
through a custom wrapper for the PEP 8 library:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!python</span>
<span class="kn">import</span> <span class="nn">pep8</span>
<span class="n">LINES_SLICE</span> <span class="o">=</span> <span class="nb">slice</span><span class="p">(</span><span class="mi">14</span><span class="p">,</span> <span class="o">-</span><span class="mi">20</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">PEP8</span><span class="p">(</span><span class="n">pep8</span><span class="o">.</span><span class="n">StyleGuide</span><span class="p">):</span>
<span class="sd">"""This subclass of pep8.StyleGuide will skip the first and last lines</span>
<span class="sd"> of each file."""</span>
<span class="k">def</span> <span class="nf">input_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">lines</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">expected</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">line_offset</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="k">if</span> <span class="n">lines</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">assert</span> <span class="n">line_offset</span> <span class="o">==</span> <span class="mi">0</span>
<span class="n">line_offset</span> <span class="o">=</span> <span class="n">LINES_SLICE</span><span class="o">.</span><span class="n">start</span> <span class="ow">or</span> <span class="mi">0</span>
<span class="n">lines</span> <span class="o">=</span> <span class="n">pep8</span><span class="o">.</span><span class="n">readlines</span><span class="p">(</span><span class="n">filename</span><span class="p">)[</span><span class="n">LINES_SLICE</span><span class="p">]</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">PEP8</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">input_file</span><span class="p">(</span>
<span class="n">filename</span><span class="p">,</span> <span class="n">lines</span><span class="o">=</span><span class="n">lines</span><span class="p">,</span> <span class="n">expected</span><span class="o">=</span><span class="n">expected</span><span class="p">,</span> <span class="n">line_offset</span><span class="o">=</span><span class="n">line_offset</span><span class="p">)</span>
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span>
<span class="n">pep8style</span> <span class="o">=</span> <span class="n">PEP8</span><span class="p">(</span><span class="n">parse_argv</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">config_file</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">report</span> <span class="o">=</span> <span class="n">pep8style</span><span class="o">.</span><span class="n">check_files</span><span class="p">()</span>
<span class="k">if</span> <span class="n">report</span><span class="o">.</span><span class="n">total_errors</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">SystemExit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
<p>This module declares a lines’ window which skips 14 lines at the beginning
and 20 lines at the end. If there’s no line to skip at the end, it could be
changed with <code class="docutils literal notranslate"><span class="pre">LINES_SLICE</span> <span class="pre">=</span> <span class="pre">slice(14,</span> <span class="pre">None)</span></code> for example.</p>
<p>You can save it in a file and use it with the same options as the
original <code class="docutils literal notranslate"><span class="pre">pep8</span></code>.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="api.html" class="btn btn-neutral float-right" title="pep8 API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="intro.html" class="btn btn-neutral" title="Introduction" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2006-2016, Johann C. Rocholl, Florent Xicluna, Ian Lee
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<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>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
a6254888eefb55523214963a0e59d4d0
>
files
>
86
