<!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>pep8 API — 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="Developer’s notes" href="developer.html" />
<link rel="prev" title="Advanced usage" href="advanced.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"><a class="reference internal" href="advanced.html">Advanced usage</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#checker-classes">Checker Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#report-classes">Report Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#utilities">Utilities</a></li>
</ul>
</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>pep8 API</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/api.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="module-pep8">
<span id="pep8-api"></span><h1>pep8 API<a class="headerlink" href="#module-pep8" title="Permalink to this headline">¶</a></h1>
<p>The library provides classes which are usable by third party tools.</p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#checker-classes" id="id2">Checker Classes</a></li>
<li><a class="reference internal" href="#report-classes" id="id3">Report Classes</a></li>
<li><a class="reference internal" href="#utilities" id="id4">Utilities</a></li>
</ul>
</div>
<div class="section" id="checker-classes">
<span id="main-classes"></span><h2><a class="toc-backref" href="#id2">Checker Classes</a><a class="headerlink" href="#checker-classes" title="Permalink to this headline">¶</a></h2>
<p>The <a class="reference internal" href="#pep8.StyleGuide" title="pep8.StyleGuide"><code class="xref py py-class docutils literal notranslate"><span class="pre">StyleGuide</span></code></a> class is used to configure a style guide checker
instance to check multiple files.</p>
<p>The <a class="reference internal" href="#pep8.Checker" title="pep8.Checker"><code class="xref py py-class docutils literal notranslate"><span class="pre">Checker</span></code></a> class can be used to check a single file.</p>
<dl class="class">
<dt id="pep8.StyleGuide">
<em class="property">class </em><code class="descclassname">pep8.</code><code class="descname">StyleGuide</code><span class="sig-paren">(</span><em>parse_argv=False</em>, <em>config_file=None</em>, <em>parser=None</em>, <em>paths=None</em>, <em>report=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#StyleGuide"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.StyleGuide" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize a PEP-8 instance with few options.</p>
<dl class="method">
<dt id="pep8.StyleGuide.init_report">
<code class="descname">init_report</code><span class="sig-paren">(</span><em>reporter=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#StyleGuide.init_report"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.StyleGuide.init_report" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize the report instance.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.StyleGuide.check_files">
<code class="descname">check_files</code><span class="sig-paren">(</span><em>paths=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#StyleGuide.check_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.StyleGuide.check_files" title="Permalink to this definition">¶</a></dt>
<dd><p>Run all checks on the paths.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.StyleGuide.input_file">
<code class="descname">input_file</code><span class="sig-paren">(</span><em>filename</em>, <em>lines=None</em>, <em>expected=None</em>, <em>line_offset=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#StyleGuide.input_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.StyleGuide.input_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Run all checks on a Python source file.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.StyleGuide.input_dir">
<code class="descname">input_dir</code><span class="sig-paren">(</span><em>dirname</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#StyleGuide.input_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.StyleGuide.input_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>Check all files in this directory and all subdirectories.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.StyleGuide.excluded">
<code class="descname">excluded</code><span class="sig-paren">(</span><em>filename</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#StyleGuide.excluded"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.StyleGuide.excluded" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if the file should be excluded.</p>
<p>Check if ‘options.exclude’ contains a pattern that matches filename.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.StyleGuide.ignore_code">
<code class="descname">ignore_code</code><span class="sig-paren">(</span><em>code</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#StyleGuide.ignore_code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.StyleGuide.ignore_code" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if the error code should be ignored.</p>
<p>If ‘options.select’ contains a prefix of the error code,
return False. Else, if ‘options.ignore’ contains a prefix of
the error code, return True.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.StyleGuide.get_checks">
<code class="descname">get_checks</code><span class="sig-paren">(</span><em>argument_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#StyleGuide.get_checks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.StyleGuide.get_checks" title="Permalink to this definition">¶</a></dt>
<dd><p>Get all the checks for this category.</p>
<p>Find all globally visible functions where the first argument name
starts with argument_name and which contain selected tests.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pep8.Checker">
<em class="property">class </em><code class="descclassname">pep8.</code><code class="descname">Checker</code><span class="sig-paren">(</span><em>filename=None</em>, <em>lines=None</em>, <em>report=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#Checker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.Checker" title="Permalink to this definition">¶</a></dt>
<dd><p>Load a Python source file, tokenize it, check coding style.</p>
<dl class="method">
<dt id="pep8.Checker.readline">
<code class="descname">readline</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#Checker.readline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.Checker.readline" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the next line from the input buffer.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.Checker.run_check">
<code class="descname">run_check</code><span class="sig-paren">(</span><em>check</em>, <em>argument_names</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#Checker.run_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.Checker.run_check" title="Permalink to this definition">¶</a></dt>
<dd><p>Run a check plugin.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.Checker.check_physical">
<code class="descname">check_physical</code><span class="sig-paren">(</span><em>line</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#Checker.check_physical"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.Checker.check_physical" title="Permalink to this definition">¶</a></dt>
<dd><p>Run all physical checks on a raw input line.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.Checker.build_tokens_line">
<code class="descname">build_tokens_line</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#Checker.build_tokens_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.Checker.build_tokens_line" title="Permalink to this definition">¶</a></dt>
<dd><p>Build a logical line from tokens.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.Checker.check_logical">
<code class="descname">check_logical</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#Checker.check_logical"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.Checker.check_logical" title="Permalink to this definition">¶</a></dt>
<dd><p>Build a line from tokens and run all logical checks on it.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.Checker.check_ast">
<code class="descname">check_ast</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#Checker.check_ast"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.Checker.check_ast" title="Permalink to this definition">¶</a></dt>
<dd><p>Build the file’s AST and run all AST checks.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.Checker.generate_tokens">
<code class="descname">generate_tokens</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#Checker.generate_tokens"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.Checker.generate_tokens" title="Permalink to this definition">¶</a></dt>
<dd><p>Tokenize the file, run physical line checks and yield tokens.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.Checker.check_all">
<code class="descname">check_all</code><span class="sig-paren">(</span><em>expected=None</em>, <em>line_offset=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#Checker.check_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.Checker.check_all" title="Permalink to this definition">¶</a></dt>
<dd><p>Run all checks on the input file.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="report-classes">
<span id="id1"></span><h2><a class="toc-backref" href="#id3">Report Classes</a><a class="headerlink" href="#report-classes" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="pep8.BaseReport">
<em class="property">class </em><code class="descclassname">pep8.</code><code class="descname">BaseReport</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#BaseReport"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.BaseReport" title="Permalink to this definition">¶</a></dt>
<dd><p>Collect the results of the checks.</p>
<dl class="method">
<dt id="pep8.BaseReport.start">
<code class="descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#BaseReport.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.BaseReport.start" title="Permalink to this definition">¶</a></dt>
<dd><p>Start the timer.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.BaseReport.stop">
<code class="descname">stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#BaseReport.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.BaseReport.stop" title="Permalink to this definition">¶</a></dt>
<dd><p>Stop the timer.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.BaseReport.init_file">
<code class="descname">init_file</code><span class="sig-paren">(</span><em>filename</em>, <em>lines</em>, <em>expected</em>, <em>line_offset</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#BaseReport.init_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.BaseReport.init_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Signal a new file.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.BaseReport.increment_logical_line">
<code class="descname">increment_logical_line</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#BaseReport.increment_logical_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.BaseReport.increment_logical_line" title="Permalink to this definition">¶</a></dt>
<dd><p>Signal a new logical line.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.BaseReport.error">
<code class="descname">error</code><span class="sig-paren">(</span><em>line_number</em>, <em>offset</em>, <em>text</em>, <em>check</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#BaseReport.error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.BaseReport.error" title="Permalink to this definition">¶</a></dt>
<dd><p>Report an error, according to options.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.BaseReport.get_file_results">
<code class="descname">get_file_results</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#BaseReport.get_file_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.BaseReport.get_file_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the count of errors and warnings for this file.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.BaseReport.get_count">
<code class="descname">get_count</code><span class="sig-paren">(</span><em>prefix=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#BaseReport.get_count"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.BaseReport.get_count" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the total count of errors and warnings.</p>
</dd></dl>
<dl class="method">
<dt id="pep8.BaseReport.get_statistics">
<code class="descname">get_statistics</code><span class="sig-paren">(</span><em>prefix=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#BaseReport.get_statistics"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.BaseReport.get_statistics" title="Permalink to this definition">¶</a></dt>
<dd><p>Get statistics for message codes that start with the prefix.</p>
<p>prefix=’’ matches all errors and warnings
prefix=’E’ matches all errors
prefix=’W’ matches all warnings
prefix=’E4’ matches all errors that have to do with imports</p>
</dd></dl>
<dl class="method">
<dt id="pep8.BaseReport.print_statistics">
<code class="descname">print_statistics</code><span class="sig-paren">(</span><em>prefix=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#BaseReport.print_statistics"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.BaseReport.print_statistics" title="Permalink to this definition">¶</a></dt>
<dd><p>Print overall statistics (number of errors and warnings).</p>
</dd></dl>
<dl class="method">
<dt id="pep8.BaseReport.print_benchmark">
<code class="descname">print_benchmark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#BaseReport.print_benchmark"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.BaseReport.print_benchmark" title="Permalink to this definition">¶</a></dt>
<dd><p>Print benchmark numbers.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pep8.FileReport">
<em class="property">class </em><code class="descclassname">pep8.</code><code class="descname">FileReport</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#FileReport"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.FileReport" title="Permalink to this definition">¶</a></dt>
<dd><p>Collect the results of the checks and print only the filenames.</p>
</dd></dl>
<dl class="class">
<dt id="pep8.StandardReport">
<em class="property">class </em><code class="descclassname">pep8.</code><code class="descname">StandardReport</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#StandardReport"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.StandardReport" title="Permalink to this definition">¶</a></dt>
<dd><p>Collect and print the results of the checks.</p>
</dd></dl>
<dl class="class">
<dt id="pep8.DiffReport">
<em class="property">class </em><code class="descclassname">pep8.</code><code class="descname">DiffReport</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#DiffReport"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.DiffReport" title="Permalink to this definition">¶</a></dt>
<dd><p>Collect and print the results for the changed lines only.</p>
</dd></dl>
</div>
<div class="section" id="utilities">
<h2><a class="toc-backref" href="#id4">Utilities</a><a class="headerlink" href="#utilities" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="pep8.expand_indent">
<code class="descclassname">pep8.</code><code class="descname">expand_indent</code><span class="sig-paren">(</span><em>line</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#expand_indent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.expand_indent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the amount of indentation.</p>
<p>Tabs are expanded to the next multiple of 8.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">expand_indent</span><span class="p">(</span><span class="s1">' '</span><span class="p">)</span>
<span class="go">4</span>
<span class="gp">>>> </span><span class="n">expand_indent</span><span class="p">(</span><span class="s1">'</span><span class="se">\t</span><span class="s1">'</span><span class="p">)</span>
<span class="go">8</span>
<span class="gp">>>> </span><span class="n">expand_indent</span><span class="p">(</span><span class="s1">' </span><span class="se">\t</span><span class="s1">'</span><span class="p">)</span>
<span class="go">8</span>
<span class="gp">>>> </span><span class="n">expand_indent</span><span class="p">(</span><span class="s1">' </span><span class="se">\t</span><span class="s1">'</span><span class="p">)</span>
<span class="go">16</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="pep8.mute_string">
<code class="descclassname">pep8.</code><code class="descname">mute_string</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#mute_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.mute_string" title="Permalink to this definition">¶</a></dt>
<dd><p>Replace contents with ‘xxx’ to prevent syntax matching.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mute_string</span><span class="p">(</span><span class="s1">'"abc"'</span><span class="p">)</span>
<span class="go">'"xxx"'</span>
<span class="gp">>>> </span><span class="n">mute_string</span><span class="p">(</span><span class="s2">"'''abc'''"</span><span class="p">)</span>
<span class="go">"'''xxx'''"</span>
<span class="gp">>>> </span><span class="n">mute_string</span><span class="p">(</span><span class="s2">"r'abc'"</span><span class="p">)</span>
<span class="go">"r'xxx'"</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="pep8.read_config">
<code class="descclassname">pep8.</code><code class="descname">read_config</code><span class="sig-paren">(</span><em>options</em>, <em>args</em>, <em>arglist</em>, <em>parser</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#read_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.read_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Read and parse configurations</p>
<p>If a config file is specified on the command line with the “–config”
option, then only it is used for configuration.</p>
<p>Otherwise, the user configuration (~/.config/pep8) and any local
configurations in the current directory or above will be merged together
(in that order) using the read method of ConfigParser.</p>
</dd></dl>
<dl class="function">
<dt id="pep8.process_options">
<code class="descclassname">pep8.</code><code class="descname">process_options</code><span class="sig-paren">(</span><em>arglist=None</em>, <em>parse_argv=False</em>, <em>config_file=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#process_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.process_options" title="Permalink to this definition">¶</a></dt>
<dd><p>Process options passed either via arglist or via command line args.</p>
<p>Passing in the <code class="docutils literal notranslate"><span class="pre">config_file</span></code> parameter allows other tools, such as flake8
to specify their own options to be processed in pep8.</p>
</dd></dl>
<dl class="function">
<dt id="pep8.register_check">
<code class="descclassname">pep8.</code><code class="descname">register_check</code><span class="sig-paren">(</span><em>func_or_cls</em>, <em>codes=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pep8.html#register_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pep8.register_check" title="Permalink to this definition">¶</a></dt>
<dd><p>Register a new check object.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="developer.html" class="btn btn-neutral float-right" title="Developer’s notes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="advanced.html" class="btn btn-neutral" title="Advanced usage" 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
>
87
