git.inspyration.org Git - gedit/flake8/blob - doc/build/html/_modules/flake8_integration/integrated.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>flake8_integration.integrated &mdash; gedit Flake8 integration 0.1 documentation</title>
  10
  11     <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
  12     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  13
  14     <script type="text/javascript">
  15       var DOCUMENTATION_OPTIONS = {
  16         URL_ROOT:    '../../',
  17         VERSION:     '0.1',
  18         COLLAPSE_INDEX: false,
  19         FILE_SUFFIX: '.html',
  20         HAS_SOURCE:  true
  21       };
  22     </script>
  23     <script type="text/javascript" src="../../_static/jquery.js"></script>
  24     <script type="text/javascript" src="../../_static/underscore.js"></script>
  25     <script type="text/javascript" src="../../_static/doctools.js"></script>
  26     <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  27     <link rel="top" title="gedit Flake8 integration 0.1 documentation" href="../../index.html" />
  28     <link rel="up" title="Module code" href="../index.html" />
  29   </head>
  30   <body>
  31     <div class="related">
  32       <h3>Navigation</h3>
  33       <ul>
  34         <li class="right" style="margin-right: 10px">
  35           <a href="../../genindex.html" title="General Index"
  36              accesskey="I">index</a></li>
  37         <li class="right" >
  38           <a href="../../py-modindex.html" title="Python Module Index"
  39              >modules</a> |</li>
  40         <li><a href="../../index.html">gedit Flake8 integration 0.1 documentation</a> &raquo;</li>
  41           <li><a href="../index.html" accesskey="U">Module code</a> &raquo;</li>
  42       </ul>
  43     </div>
  44
  45     <div class="document">
  46       <div class="documentwrapper">
  47         <div class="bodywrapper">
  48           <div class="body">
  49
  50   <h1>Source code for flake8_integration.integrated</h1><div class="highlight"><pre>
  51 <span class="c">#-*- coding: utf8 -*-</span>
  52
  53 <span class="sd">&quot;&quot;&quot;Module used to manage the results of flake8 :</span>
  54
  55 <span class="sd">&gt; 1. get them instead of print them ;</span>
  56 <span class="sd">&gt; 2. format them ;</span>
  57
  58 <span class="sd">This module works with Python2 and Python3</span>
  59
  60 <span class="sd">:author: Sébastien CHAZALLET &lt;s.chazallet@gmail.com&gt;</span>
  61 <span class="sd">:organization: InsPyration EURL</span>
  62 <span class="sd">:copyright: Copyright © InsPyration EURL &lt;www.inspyration.org&gt;</span>
  63 <span class="sd">:license: GPL 3 &lt;http://www.gnu.org/licenses/gpl.html&gt;</span>
  64
  65 <span class="sd">:version: 0.1</span>
  66 <span class="sd">&quot;&quot;&quot;</span>
  67
  68
  69 <span class="kn">import</span> <span class="nn">sys</span>
  70 <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">major</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
  71     <span class="kn">from</span> <span class="nn">io</span> <span class="kn">import</span> <span class="n">BytesIO</span> <span class="k">as</span> <span class="n">IO</span>
  72 <span class="k">else</span><span class="p">:</span>
  73     <span class="kn">from</span> <span class="nn">io</span> <span class="kn">import</span> <span class="n">StringIO</span> <span class="k">as</span> <span class="n">IO</span>
  74
  75 <span class="kn">from</span> <span class="nn">flake8.main</span> <span class="kn">import</span> <span class="n">check_code</span>
  76
  77
  78 <div class="viewcode-block" id="_intercept_printed"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.integrated._intercept_printed">[docs]</a><span class="k">def</span> <span class="nf">_intercept_printed</span><span class="p">(</span><span class="n">action</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
  79     <span class="sd">&quot;&quot;&quot;Function used to redirect printed to returned value</span>
  80
  81 <span class="sd">    :type  action: function</span>
  82 <span class="sd">    :param action: Called function that we intercept prints</span>
  83
  84 <span class="sd">    :rtype:  str</span>
  85 <span class="sd">    :return: all that was printed by the call of action</span>
  86
  87 <span class="sd">    &gt;&gt;&gt; def do():</span>
  88 <span class="sd">    ...     print(&#39;Hello World&#39;)</span>
  89 <span class="sd">    ...</span>
  90 <span class="sd">    &gt;&gt;&gt; result = _intercept_printed(do)</span>
  91 <span class="sd">    &gt;&gt;&gt; print(result)</span>
  92 <span class="sd">    Hello World</span>
  93 <span class="sd">    &lt;BLANKLINE&gt;</span>
  94 <span class="sd">    &quot;&quot;&quot;</span>
  95     <span class="k">with</span> <span class="n">IO</span><span class="p">()</span> <span class="k">as</span> <span class="n">buff</span><span class="p">:</span>
  96         <span class="n">out</span><span class="p">,</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">buff</span>
  97         <span class="n">action</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
  98         <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">out</span>
  99         <span class="n">buff</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 100         <span class="k">return</span> <span class="n">buff</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
 101
 102 </div>
 103 <div class="viewcode-block" id="_format_flake8_results"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.integrated._format_flake8_results">[docs]</a><span class="k">def</span> <span class="nf">_format_flake8_results</span><span class="p">(</span><span class="n">warnings</span><span class="p">):</span>
 104     <span class="sd">&quot;&quot;&quot;Function used to extract useful informations from flake8 results</span>
 105
 106 <span class="sd">    :type  warnings: str</span>
 107 <span class="sd">    :param warnings: Warnings generated by flake8</span>
 108
 109 <span class="sd">    :rtype:  list</span>
 110 <span class="sd">    :return: list of (code:str, line:int, col:int, description:str)</span>
 111
 112 <span class="sd">    &gt;&gt;&gt; result = _format_flake8_results(</span>
 113 <span class="sd">    ...     &#39;&#39;&#39;stdin:1:10: E901 SyntaxError: unexpected EOF while parsing</span>
 114 <span class="sd">    ...     stdin:2:1: E901 TokenError: EOF in multi-line statement&#39;&#39;&#39;)</span>
 115 <span class="sd">    &gt;&gt;&gt; for r in result:</span>
 116 <span class="sd">    ...     print r</span>
 117 <span class="sd">    ...</span>
 118 <span class="sd">    (&#39; e901&#39;, 1, 10, &#39;SyntaxError: unexpected EOF while parsing&#39;)</span>
 119 <span class="sd">    (&#39; e901&#39;, 2, 1, &#39;TokenError: EOF in multi-line statement&#39;)</span>
 120 <span class="sd">    &quot;&quot;&quot;</span>
 121     <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
 122     <span class="k">for</span> <span class="n">warning</span> <span class="ow">in</span> <span class="n">warnings</span><span class="o">.</span><span class="n">splitlines</span><span class="p">():</span>
 123         <span class="n">cols</span> <span class="o">=</span> <span class="n">warning</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;:&#39;</span><span class="p">)</span>
 124         <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">cols</span><span class="p">[</span><span class="mi">3</span><span class="p">][:</span><span class="mi">5</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span>
 125                        <span class="nb">int</span><span class="p">(</span><span class="n">cols</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span>
 126                        <span class="nb">int</span><span class="p">(</span><span class="n">cols</span><span class="p">[</span><span class="mi">2</span><span class="p">]),</span>
 127                        <span class="n">cols</span><span class="p">[</span><span class="mi">3</span><span class="p">][</span><span class="mi">6</span><span class="p">:]</span> <span class="o">+</span> <span class="s">&#39;:&#39;</span> <span class="o">+</span> <span class="s">&#39;:&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cols</span><span class="p">[</span><span class="mi">4</span><span class="p">:])))</span>
 128     <span class="k">return</span> <span class="n">result</span>
 129
 130 </div>
 131 <div class="viewcode-block" id="check_code_and_get_formated_result"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.integrated.check_code_and_get_formated_result">[docs]</a><span class="k">def</span> <span class="nf">check_code_and_get_formated_result</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">ignore</span><span class="o">=</span><span class="p">(),</span> <span class="n">complexity</span><span class="o">=-</span><span class="mi">1</span><span class="p">):</span>
 132     <span class="sd">&quot;&quot;&quot;Function used to return the printed result of flake8 check_code function</span>
 133
 134 <span class="sd">    &gt;&gt;&gt; result = check_code_with_flake8(&quot;a = 42&quot;)</span>
 135 <span class="sd">    &gt;&gt;&gt; print(result)</span>
 136 <span class="sd">    &lt;BLANKLINE&gt;</span>
 137 <span class="sd">    &gt;&gt;&gt; result = check_code_with_flake8(&quot;a = f(42&quot;)</span>
 138 <span class="sd">    &gt;&gt;&gt; print(result)</span>
 139 <span class="sd">    stdin:1:10: E901 SyntaxError: unexpected EOF while parsing</span>
 140 <span class="sd">    stdin:2:1: E901 TokenError: EOF in multi-line statement</span>
 141 <span class="sd">    &lt;BLANKLINE&gt;</span>
 142 <span class="sd">    &quot;&quot;&quot;</span>
 143     <span class="k">return</span> <span class="n">_format_flake8_results</span><span class="p">(</span>
 144         <span class="n">_intercept_printed</span><span class="p">(</span>
 145             <span class="n">check_code</span><span class="p">,</span>
 146             <span class="o">**</span><span class="p">{</span><span class="s">&quot;code&quot;</span><span class="p">:</span> <span class="n">code</span><span class="p">,</span> <span class="s">&quot;ignore&quot;</span><span class="p">:</span> <span class="n">ignore</span><span class="p">,</span> <span class="s">&quot;complexity&quot;</span><span class="p">:</span> <span class="n">complexity</span><span class="p">}))</span>
 147
 148 </div>
 149 <span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;__main__&#39;</span><span class="p">:</span>
 150     <span class="kn">import</span> <span class="nn">doctest</span>
 151     <span class="n">doctest</span><span class="o">.</span><span class="n">testmod</span><span class="p">()</span>
 152 </pre></div>
 153
 154           </div>
 155         </div>
 156       </div>
 157       <div class="sphinxsidebar">
 158         <div class="sphinxsidebarwrapper">
 159 <div id="searchbox" style="display: none">
 160   <h3>Quick search</h3>
 161     <form class="search" action="../../search.html" method="get">
 162       <input type="text" name="q" />
 163       <input type="submit" value="Go" />
 164       <input type="hidden" name="check_keywords" value="yes" />
 165       <input type="hidden" name="area" value="default" />
 166     </form>
 167     <p class="searchtip" style="font-size: 90%">
 168     Enter search terms or a module, class or function name.
 169     </p>
 170 </div>
 171 <script type="text/javascript">$('#searchbox').show(0);</script>
 172         </div>
 173       </div>
 174       <div class="clearer"></div>
 175     </div>
 176     <div class="related">
 177       <h3>Navigation</h3>
 178       <ul>
 179         <li class="right" style="margin-right: 10px">
 180           <a href="../../genindex.html" title="General Index"
 181              >index</a></li>
 182         <li class="right" >
 183           <a href="../../py-modindex.html" title="Python Module Index"
 184              >modules</a> |</li>
 185         <li><a href="../../index.html">gedit Flake8 integration 0.1 documentation</a> &raquo;</li>
 186           <li><a href="../index.html" >Module code</a> &raquo;</li>
 187       </ul>
 188     </div>
 189     <div class="footer">
 190         &copy; Copyright 2013, Sébastien CHAZALLET.
 191       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
 192     </div>
 193   </body>
 194 </html>