1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>Auto generated documentation — gedit Flake8 integration 0.1 documentation</title>
11 <link rel="stylesheet" href="_static/default.css" type="text/css" />
12 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
18 COLLAPSE_INDEX: false,
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="prev" title="Welcome to gedit Flake8 integration’s documentation!" href="index.html" />
34 <li class="right" style="margin-right: 10px">
35 <a href="genindex.html" title="General Index"
36 accesskey="I">index</a></li>
38 <a href="py-modindex.html" title="Python Module Index"
41 <a href="index.html" title="Welcome to gedit Flake8 integration’s documentation!"
42 accesskey="P">previous</a> |</li>
43 <li><a href="index.html">gedit Flake8 integration 0.1 documentation</a> »</li>
47 <div class="document">
48 <div class="documentwrapper">
49 <div class="bodywrapper">
52 <div class="section" id="auto-generated-documentation">
53 <h1>Auto generated documentation<a class="headerlink" href="#auto-generated-documentation" title="Permalink to this headline">¶</a></h1>
54 <div class="section" id="module-flake8_integration">
55 <span id="plugin"></span><h2>Plugin<a class="headerlink" href="#module-flake8_integration" title="Permalink to this headline">¶</a></h2>
56 <p>Plugin for gedit that allow flake8 integration</p>
57 <table class="docutils field-list" frame="void" rules="none">
58 <col class="field-name" />
59 <col class="field-body" />
61 <tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Sébastien CHAZALLET <<a class="reference external" href="mailto:s.chazallet%40gmail.com">s<span>.</span>chazallet<span>@</span>gmail<span>.</span>com</a>></td>
63 <tr class="field-even field"><th class="field-name">organization:</th><td class="field-body">InsPyration EURL</td>
65 <tr class="field-odd field"><th class="field-name">copyright:</th><td class="field-body">Copyright © InsPyration EURL <www.inspyration.org></td>
67 <tr class="field-even field"><th class="field-name">license:</th><td class="field-body">GPL 3 <<a class="reference external" href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a>></td>
69 <tr class="field-odd field"><th class="field-name">version:</th><td class="field-body">0.1</td>
74 <div class="section" id="module-flake8_integration.integrated">
75 <span id="integrated"></span><h2>Integrated<a class="headerlink" href="#module-flake8_integration.integrated" title="Permalink to this headline">¶</a></h2>
76 <p>Module used to manage the results of flake8 :</p>
77 <p>> 1. get them instead of print them ;
78 > 2. format them ;</p>
79 <p>This module works with Python2 and Python3</p>
80 <table class="docutils field-list" frame="void" rules="none">
81 <col class="field-name" />
82 <col class="field-body" />
84 <tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Sébastien CHAZALLET <<a class="reference external" href="mailto:s.chazallet%40gmail.com">s<span>.</span>chazallet<span>@</span>gmail<span>.</span>com</a>></td>
86 <tr class="field-even field"><th class="field-name">organization:</th><td class="field-body">InsPyration EURL</td>
88 <tr class="field-odd field"><th class="field-name">copyright:</th><td class="field-body">Copyright © InsPyration EURL <www.inspyration.org></td>
90 <tr class="field-even field"><th class="field-name">license:</th><td class="field-body">GPL 3 <<a class="reference external" href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a>></td>
92 <tr class="field-odd field"><th class="field-name">version:</th><td class="field-body">0.1</td>
97 <dt id="flake8_integration.integrated._format_flake8_results">
98 <tt class="descclassname">flake8_integration.integrated.</tt><tt class="descname">_format_flake8_results</tt><big>(</big><em>warnings</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/integrated.html#_format_flake8_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.integrated._format_flake8_results" title="Permalink to this definition">¶</a></dt>
99 <dd><p>Function used to extract useful informations from flake8 results</p>
100 <table class="docutils field-list" frame="void" rules="none">
101 <col class="field-name" />
102 <col class="field-body" />
104 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>warnings</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Warnings generated by flake8</td>
106 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list</td>
108 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of (code:str, line:int, col:int, description:str)</td>
112 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">_format_flake8_results</span><span class="p">(</span>
113 <span class="gp">... </span> <span class="sd">'''stdin:1:10: E901 SyntaxError: unexpected EOF while parsing</span>
114 <span class="gp">... </span><span class="sd"> stdin:2:1: E901 TokenError: EOF in multi-line statement'''</span><span class="p">)</span>
115 <span class="gp">>>> </span><span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">result</span><span class="p">:</span>
116 <span class="gp">... </span> <span class="k">print</span> <span class="n">r</span>
117 <span class="gp">...</span>
118 <span class="go">(' e901', 1, 10, 'SyntaxError: unexpected EOF while parsing')</span>
119 <span class="go">(' e901', 2, 1, 'TokenError: EOF in multi-line statement')</span>
124 <dl class="function">
125 <dt id="flake8_integration.integrated._intercept_printed">
126 <tt class="descclassname">flake8_integration.integrated.</tt><tt class="descname">_intercept_printed</tt><big>(</big><em>action</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/integrated.html#_intercept_printed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.integrated._intercept_printed" title="Permalink to this definition">¶</a></dt>
127 <dd><p>Function used to redirect printed to returned value</p>
128 <table class="docutils field-list" frame="void" rules="none">
129 <col class="field-name" />
130 <col class="field-body" />
132 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>action</strong> (<em>function</em>) – Called function that we intercept prints</td>
134 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
136 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">all that was printed by the call of action</td>
140 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">def</span> <span class="nf">do</span><span class="p">():</span>
141 <span class="gp">... </span> <span class="k">print</span><span class="p">(</span><span class="s">'Hello World'</span><span class="p">)</span>
142 <span class="gp">...</span>
143 <span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">_intercept_printed</span><span class="p">(</span><span class="n">do</span><span class="p">)</span>
144 <span class="gp">>>> </span><span class="k">print</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
145 <span class="go">Hello World</span>
150 <dl class="function">
151 <dt id="flake8_integration.integrated.check_code_and_get_formated_result">
152 <tt class="descclassname">flake8_integration.integrated.</tt><tt class="descname">check_code_and_get_formated_result</tt><big>(</big><em>code</em>, <em>ignore=()</em>, <em>complexity=-1</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/integrated.html#check_code_and_get_formated_result"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.integrated.check_code_and_get_formated_result" title="Permalink to this definition">¶</a></dt>
153 <dd><p>Function used to return the printed result of flake8 check_code function</p>
154 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">check_code_with_flake8</span><span class="p">(</span><span class="s">"a = 42"</span><span class="p">)</span>
155 <span class="gp">>>> </span><span class="k">print</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
157 <span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">check_code_with_flake8</span><span class="p">(</span><span class="s">"a = f(42"</span><span class="p">)</span>
158 <span class="gp">>>> </span><span class="k">print</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
159 <span class="go">stdin:1:10: E901 SyntaxError: unexpected EOF while parsing</span>
160 <span class="go">stdin:2:1: E901 TokenError: EOF in multi-line statement</span>
166 <div class="section" id="module-flake8_integration.windowactivatable">
167 <span id="window-activatable"></span><h2>Window activatable<a class="headerlink" href="#module-flake8_integration.windowactivatable" title="Permalink to this headline">¶</a></h2>
168 <p>Main module of the Plugin for gedit that allow flake8 integration</p>
169 <table class="docutils field-list" frame="void" rules="none">
170 <col class="field-name" />
171 <col class="field-body" />
173 <tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Sébastien CHAZALLET <<a class="reference external" href="mailto:s.chazallet%40gmail.com">s<span>.</span>chazallet<span>@</span>gmail<span>.</span>com</a>></td>
175 <tr class="field-even field"><th class="field-name">organization:</th><td class="field-body">InsPyration EURL</td>
177 <tr class="field-odd field"><th class="field-name">copyright:</th><td class="field-body">Copyright © InsPyration EURL <www.inspyration.org></td>
179 <tr class="field-even field"><th class="field-name">license:</th><td class="field-body">GPL 3 <<a class="reference external" href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a>></td>
181 <tr class="field-odd field"><th class="field-name">version:</th><td class="field-body">0.1</td>
186 <dt id="flake8_integration.windowactivatable.GeditFlake8WindowActivatable">
187 <em class="property">class </em><tt class="descclassname">flake8_integration.windowactivatable.</tt><tt class="descname">GeditFlake8WindowActivatable</tt><a class="reference internal" href="_modules/flake8_integration/windowactivatable.html#GeditFlake8WindowActivatable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.windowactivatable.GeditFlake8WindowActivatable" title="Permalink to this definition">¶</a></dt>
188 <dd><p>Main module of the gedit flake8 plugin</p>
190 <dt id="flake8_integration.windowactivatable.GeditFlake8WindowActivatable.__init__">
191 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/windowactivatable.html#GeditFlake8WindowActivatable.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.__init__" title="Permalink to this definition">¶</a></dt>
192 <dd><p>Initialize plugin</p>
193 <table class="docutils field-list" frame="void" rules="none">
194 <col class="field-name" />
195 <col class="field-body" />
197 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>action</strong> (<em>function</em>) – Called function that we intercept prints</td>
199 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
206 <dt id="flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_activate">
207 <tt class="descname">do_activate</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/windowactivatable.html#GeditFlake8WindowActivatable.do_activate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_activate" title="Permalink to this definition">¶</a></dt>
208 <dd><p>Activate the plugin</p>
209 <table class="docutils field-list" frame="void" rules="none">
210 <col class="field-name" />
211 <col class="field-body" />
213 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>GeditFlake8WindowActivatable</em>) – Current plugin</td>
215 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
222 <dt id="flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_create_configure_widget">
223 <tt class="descname">do_create_configure_widget</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/windowactivatable.html#GeditFlake8WindowActivatable.do_create_configure_widget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_create_configure_widget" title="Permalink to this definition">¶</a></dt>
224 <dd><p>Action when a user want to configure the plugin</p>
225 <table class="docutils field-list" frame="void" rules="none">
226 <col class="field-name" />
227 <col class="field-body" />
229 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>GeditFlake8WindowActivatable</em>) – Current plugin</td>
231 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">GeditFlake8ConfigWidget</td>
233 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a configuration widget</td>
240 <dt id="flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_deactivate">
241 <tt class="descname">do_deactivate</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/windowactivatable.html#GeditFlake8WindowActivatable.do_deactivate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_deactivate" title="Permalink to this definition">¶</a></dt>
242 <dd><p>Deactivate the plugin</p>
243 <table class="docutils field-list" frame="void" rules="none">
244 <col class="field-name" />
245 <col class="field-body" />
247 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>GeditFlake8WindowActivatable</em>) – Current plugin</td>
249 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
256 <dt id="flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_update_state">
257 <tt class="descname">do_update_state</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/windowactivatable.html#GeditFlake8WindowActivatable.do_update_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_update_state" title="Permalink to this definition">¶</a></dt>
258 <dd><p>Allow to activate the plugin only if the document is python code
259 If the document is a new document, it hasto be saved or the language of
260 the document has to be set.</p>
261 <table class="docutils field-list" frame="void" rules="none">
262 <col class="field-name" />
263 <col class="field-body" />
265 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>GeditFlake8WindowActivatable</em>) – Current plugin</td>
267 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
274 <dt id="flake8_integration.windowactivatable.GeditFlake8WindowActivatable.on_check_source_code">
275 <tt class="descname">on_check_source_code</tt><big>(</big><em>action</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/windowactivatable.html#GeditFlake8WindowActivatable.on_check_source_code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.on_check_source_code" title="Permalink to this definition">¶</a></dt>
276 <dd><p>The user ask to check code source :
277 1check there is a doc and the doc is python code
279 3put flake8 results into the tree and activate it</p>
280 <table class="docutils field-list" frame="void" rules="none">
281 <col class="field-name" />
282 <col class="field-body" />
284 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
285 <li><strong>self</strong> (<em>GeditFlake8WindowActivatable</em>) – Current plugin</li>
286 <li><strong>action</strong> (<em>Gtk.Action</em>) – Called function that we intercept prints</li>
290 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
300 <div class="section" id="module-flake8_integration.tree">
301 <span id="tree"></span><h2>Tree<a class="headerlink" href="#module-flake8_integration.tree" title="Permalink to this headline">¶</a></h2>
302 <p>Module managing the tree and all stuff around it</p>
303 <table class="docutils field-list" frame="void" rules="none">
304 <col class="field-name" />
305 <col class="field-body" />
307 <tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Sébastien CHAZALLET <<a class="reference external" href="mailto:s.chazallet%40gmail.com">s<span>.</span>chazallet<span>@</span>gmail<span>.</span>com</a>></td>
309 <tr class="field-even field"><th class="field-name">organization:</th><td class="field-body">InsPyration EURL</td>
311 <tr class="field-odd field"><th class="field-name">copyright:</th><td class="field-body">Copyright © InsPyration EURL <www.inspyration.org></td>
313 <tr class="field-even field"><th class="field-name">license:</th><td class="field-body">GPL 3 <<a class="reference external" href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a>></td>
315 <tr class="field-odd field"><th class="field-name">version:</th><td class="field-body">0.1</td>
320 <dt id="flake8_integration.tree.GeditFlake8Tree">
321 <em class="property">class </em><tt class="descclassname">flake8_integration.tree.</tt><tt class="descname">GeditFlake8Tree</tt><big>(</big><em>window</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/tree.html#GeditFlake8Tree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.tree.GeditFlake8Tree" title="Permalink to this definition">¶</a></dt>
322 <dd><p>Tree inside gedit side panel containing all flake8 warnings</p>
324 <dt id="flake8_integration.tree.GeditFlake8Tree.__init__">
325 <tt class="descname">__init__</tt><big>(</big><em>window</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/tree.html#GeditFlake8Tree.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.tree.GeditFlake8Tree.__init__" title="Permalink to this definition">¶</a></dt>
326 <dd><p>Configure tree columns, tree selection and add it to side panel</p>
327 <table class="docutils field-list" frame="void" rules="none">
328 <col class="field-name" />
329 <col class="field-body" />
331 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
332 <li><strong>self</strong> (<em>GeditFlake8Tree</em>) – Current tree</li>
333 <li><strong>window</strong> (<em>Gedit.Window</em>) – GEdit window object</li>
337 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
345 <dt id="flake8_integration.tree.GeditFlake8Tree.activate">
346 <tt class="descname">activate</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/tree.html#GeditFlake8Tree.activate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.tree.GeditFlake8Tree.activate" title="Permalink to this definition">¶</a></dt>
347 <dd><p>show the tree in the side panel</p>
348 <table class="docutils field-list" frame="void" rules="none">
349 <col class="field-name" />
350 <col class="field-body" />
352 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>GeditFlake8Tree</em>) – Current tree</td>
354 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
361 <dt id="flake8_integration.tree.GeditFlake8Tree.on_tree_selection">
362 <tt class="descname">on_tree_selection</tt><big>(</big><em>selection</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/tree.html#GeditFlake8Tree.on_tree_selection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.tree.GeditFlake8Tree.on_tree_selection" title="Permalink to this definition">¶</a></dt>
363 <dd><p>When a tree line is selected, go to the file linked line</p>
364 <table class="docutils field-list" frame="void" rules="none">
365 <col class="field-name" />
366 <col class="field-body" />
368 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
369 <li><strong>self</strong> (<em>GeditFlake8Tree</em>) – Current tree</li>
370 <li><strong>selection</strong> (<em>Gtk.TreeSelection</em>) – Current selection</li>
374 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
382 <dt id="flake8_integration.tree.GeditFlake8Tree.remove">
383 <tt class="descname">remove</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/tree.html#GeditFlake8Tree.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.tree.GeditFlake8Tree.remove" title="Permalink to this definition">¶</a></dt>
384 <dd><p>remove the tree from the side panel</p>
385 <table class="docutils field-list" frame="void" rules="none">
386 <col class="field-name" />
387 <col class="field-body" />
389 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>GeditFlake8Tree</em>) – Current tree</td>
391 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
398 <dt id="flake8_integration.tree.GeditFlake8Tree.update_model">
399 <tt class="descname">update_model</tt><big>(</big><em>datas</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/tree.html#GeditFlake8Tree.update_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.tree.GeditFlake8Tree.update_model" title="Permalink to this definition">¶</a></dt>
400 <dd><p>Update the tree with new datas</p>
401 <table class="docutils field-list" frame="void" rules="none">
402 <col class="field-name" />
403 <col class="field-body" />
405 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
406 <li><strong>self</strong> (<em>GeditFlake8Tree</em>) – Current tree</li>
407 <li><strong>datas</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) – list of ready to use (str, int, int, str) tuples</li>
411 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
421 <div class="section" id="module-flake8_integration.settings">
422 <span id="settings"></span><h2>Settings<a class="headerlink" href="#module-flake8_integration.settings" title="Permalink to this headline">¶</a></h2>
423 <p>Module used to define how to manage settings and their persistence</p>
424 <table class="docutils field-list" frame="void" rules="none">
425 <col class="field-name" />
426 <col class="field-body" />
428 <tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Sébastien CHAZALLET <<a class="reference external" href="mailto:s.chazallet%40gmail.com">s<span>.</span>chazallet<span>@</span>gmail<span>.</span>com</a>></td>
430 <tr class="field-even field"><th class="field-name">organization:</th><td class="field-body">InsPyration EURL</td>
432 <tr class="field-odd field"><th class="field-name">copyright:</th><td class="field-body">Copyright © InsPyration EURL <www.inspyration.org></td>
434 <tr class="field-even field"><th class="field-name">license:</th><td class="field-body">GPL 3 <<a class="reference external" href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a>></td>
436 <tr class="field-odd field"><th class="field-name">version:</th><td class="field-body">0.1</td>
441 <dt id="flake8_integration.settings.SettingsManager">
442 <em class="property">class </em><tt class="descclassname">flake8_integration.settings.</tt><tt class="descname">SettingsManager</tt><a class="reference internal" href="_modules/flake8_integration/settings.html#SettingsManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.settings.SettingsManager" title="Permalink to this definition">¶</a></dt>
443 <dd><p>Allow to manage local settings and it persistent storage</p>
445 <dt id="flake8_integration.settings.SettingsManager.__init__">
446 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/settings.html#SettingsManager.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.settings.SettingsManager.__init__" title="Permalink to this definition">¶</a></dt>
447 <dd><p>Initialize Settings Manager</p>
448 <table class="docutils field-list" frame="void" rules="none">
449 <col class="field-name" />
450 <col class="field-body" />
452 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>SettingsManager</em>) – Current manager</td>
454 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
460 <dl class="attribute">
461 <dt id="flake8_integration.settings.SettingsManager.__weakref__">
462 <tt class="descname">__weakref__</tt><a class="headerlink" href="#flake8_integration.settings.SettingsManager.__weakref__" title="Permalink to this definition">¶</a></dt>
463 <dd><p>list of weak references to the object (if defined)</p>
467 <dt id="flake8_integration.settings.SettingsManager.get_complexity">
468 <tt class="descname">get_complexity</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/settings.html#SettingsManager.get_complexity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.settings.SettingsManager.get_complexity" title="Permalink to this definition">¶</a></dt>
469 <dd><p>Get the user defined complexity parameter</p>
470 <table class="docutils field-list" frame="void" rules="none">
471 <col class="field-name" />
472 <col class="field-body" />
474 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>SettingsManager</em>) – Current manager</td>
476 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>
478 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">complexity</td>
485 <dt id="flake8_integration.settings.SettingsManager.get_complexity_key">
486 <tt class="descname">get_complexity_key</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/settings.html#SettingsManager.get_complexity_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.settings.SettingsManager.get_complexity_key" title="Permalink to this definition">¶</a></dt>
487 <dd><p>Allow to share information about key used to store complexity</p>
488 <table class="docutils field-list" frame="void" rules="none">
489 <col class="field-name" />
490 <col class="field-body" />
492 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>SettingsManager</em>) – Current manager</td>
494 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
496 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">name of the complexity key</td>
503 <dt id="flake8_integration.settings.SettingsManager.get_ignore_items">
504 <tt class="descname">get_ignore_items</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/settings.html#SettingsManager.get_ignore_items"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.settings.SettingsManager.get_ignore_items" title="Permalink to this definition">¶</a></dt>
505 <dd><p>Allow to share information about keys used to store ignore list</p>
506 <table class="docutils field-list" frame="void" rules="none">
507 <col class="field-name" />
508 <col class="field-body" />
510 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>SettingsManager</em>) – Current manager</td>
512 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of tuple of str</td>
514 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of (ignore key, ignore label)</td>
521 <dt id="flake8_integration.settings.SettingsManager.get_ignore_keys">
522 <tt class="descname">get_ignore_keys</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/settings.html#SettingsManager.get_ignore_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.settings.SettingsManager.get_ignore_keys" title="Permalink to this definition">¶</a></dt>
523 <dd><p>Allow to share information about keys used to store ignore list</p>
524 <table class="docutils field-list" frame="void" rules="none">
525 <col class="field-name" />
526 <col class="field-body" />
528 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>SettingsManager</em>) – Current manager</td>
530 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of str</td>
532 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of ignore keys</td>
539 <dt id="flake8_integration.settings.SettingsManager.get_ignore_list">
540 <tt class="descname">get_ignore_list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/settings.html#SettingsManager.get_ignore_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.settings.SettingsManager.get_ignore_list" title="Permalink to this definition">¶</a></dt>
541 <dd><p>Get the user defined warning keys to ignore</p>
542 <table class="docutils field-list" frame="void" rules="none">
543 <col class="field-name" />
544 <col class="field-body" />
546 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>SettingsManager</em>) – Current manager</td>
548 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of str</td>
550 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of warning keys</td>
557 <dt id="flake8_integration.settings.SettingsManager.is_in_ignore_list">
558 <tt class="descname">is_in_ignore_list</tt><big>(</big><em>key</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/settings.html#SettingsManager.is_in_ignore_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.settings.SettingsManager.is_in_ignore_list" title="Permalink to this definition">¶</a></dt>
559 <dd><p>Answer to “Is tag in ignore list ?” question</p>
560 <table class="docutils field-list" frame="void" rules="none">
561 <col class="field-name" />
562 <col class="field-body" />
564 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
565 <li><strong>self</strong> (<em>SettingsManager</em>) – Current manager</li>
566 <li><strong>key</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – flake8 key as defined in FLAKE8_IGNORED_KEYS</li>
570 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">bool</p>
573 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">True if the key is in ignore list, False otherwise</p>
581 <dt id="flake8_integration.settings.SettingsManager.pull_settings">
582 <tt class="descname">pull_settings</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/settings.html#SettingsManager.pull_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.settings.SettingsManager.pull_settings" title="Permalink to this definition">¶</a></dt>
583 <dd><p>Pull operation update local settings from persistent storage</p>
584 <table class="docutils field-list" frame="void" rules="none">
585 <col class="field-name" />
586 <col class="field-body" />
588 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>SettingsManager</em>) – Current manager</td>
590 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
597 <dt id="flake8_integration.settings.SettingsManager.push_settings">
598 <tt class="descname">push_settings</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/flake8_integration/settings.html#SettingsManager.push_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.settings.SettingsManager.push_settings" title="Permalink to this definition">¶</a></dt>
599 <dd><p>Push operation allow persistent storage update from local settings</p>
600 <table class="docutils field-list" frame="void" rules="none">
601 <col class="field-name" />
602 <col class="field-body" />
604 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>self</strong> (<em>SettingsManager</em>) – Current manager</td>
606 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
613 <dt id="flake8_integration.settings.SettingsManager.update_setting">
614 <tt class="descname">update_setting</tt><big>(</big><em>values={}</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/settings.html#SettingsManager.update_setting"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.settings.SettingsManager.update_setting" title="Permalink to this definition">¶</a></dt>
615 <dd><p>Updating settings allow to update local and persistent settings</p>
616 <table class="docutils field-list" frame="void" rules="none">
617 <col class="field-name" />
618 <col class="field-body" />
620 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
621 <li><strong>self</strong> (<em>SettingsManager</em>) – Current manager</li>
622 <li><strong>values</strong> (<a class="reference external" href="http://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – values to store persistently</li>
626 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
636 <div class="section" id="module-flake8_integration.configuration">
637 <span id="configuration"></span><h2>Configuration<a class="headerlink" href="#module-flake8_integration.configuration" title="Permalink to this headline">¶</a></h2>
638 <p>Module used to configure plugin from an easy-to-use widget</p>
639 <table class="docutils field-list" frame="void" rules="none">
640 <col class="field-name" />
641 <col class="field-body" />
643 <tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Sébastien CHAZALLET <<a class="reference external" href="mailto:s.chazallet%40gmail.com">s<span>.</span>chazallet<span>@</span>gmail<span>.</span>com</a>></td>
645 <tr class="field-even field"><th class="field-name">organization:</th><td class="field-body">InsPyration EURL</td>
647 <tr class="field-odd field"><th class="field-name">copyright:</th><td class="field-body">Copyright © InsPyration EURL <www.inspyration.org></td>
649 <tr class="field-even field"><th class="field-name">license:</th><td class="field-body">GPL 3 <<a class="reference external" href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a>></td>
651 <tr class="field-odd field"><th class="field-name">version:</th><td class="field-body">0.1</td>
656 <dt id="flake8_integration.configuration.GeditFlake8ConfigWidget">
657 <em class="property">class </em><tt class="descclassname">flake8_integration.configuration.</tt><tt class="descname">GeditFlake8ConfigWidget</tt><big>(</big><em>settings</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/configuration.html#GeditFlake8ConfigWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.configuration.GeditFlake8ConfigWidget" title="Permalink to this definition">¶</a></dt>
658 <dd><dl class="method">
659 <dt id="flake8_integration.configuration.GeditFlake8ConfigWidget.__init__">
660 <tt class="descname">__init__</tt><big>(</big><em>settings</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/configuration.html#GeditFlake8ConfigWidget.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.configuration.GeditFlake8ConfigWidget.__init__" title="Permalink to this definition">¶</a></dt>
661 <dd><p>Initialize the configuration widget from SettingsManager properties</p>
662 <table class="docutils field-list" frame="void" rules="none">
663 <col class="field-name" />
664 <col class="field-body" />
666 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
667 <li><strong>self</strong> (<em>GeditFlake8ConfigWidget</em>) – Current widget</li>
668 <li><strong>settings</strong> (<em>SettingsManager</em>) – Object used to define all configurable properties</li>
672 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
680 <dt id="flake8_integration.configuration.GeditFlake8ConfigWidget.on_configure_destroy">
681 <tt class="descname">on_configure_destroy</tt><big>(</big><em>widget</em><big>)</big><a class="reference internal" href="_modules/flake8_integration/configuration.html#GeditFlake8ConfigWidget.on_configure_destroy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flake8_integration.configuration.GeditFlake8ConfigWidget.on_configure_destroy" title="Permalink to this definition">¶</a></dt>
682 <dd><p>Called when the widget is destroyed</p>
683 <table class="docutils field-list" frame="void" rules="none">
684 <col class="field-name" />
685 <col class="field-body" />
687 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
688 <li><strong>self</strong> (<em>GeditFlake8ConfigWidget</em>) – Current widget</li>
689 <li><strong>widget</strong> (<em>GeditFlake8ConfigWidget</em>) – Current widget</li>
693 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
703 <div class="section" id="status">
704 <h2>Status<a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h2>
705 <p>This plugin is under active development.</p>
713 <div class="sphinxsidebar">
714 <div class="sphinxsidebarwrapper">
715 <h3><a href="index.html">Table Of Contents</a></h3>
717 <li><a class="reference internal" href="#">Auto generated documentation</a><ul>
718 <li><a class="reference internal" href="#module-flake8_integration">Plugin</a></li>
719 <li><a class="reference internal" href="#module-flake8_integration.integrated">Integrated</a></li>
720 <li><a class="reference internal" href="#module-flake8_integration.windowactivatable">Window activatable</a></li>
721 <li><a class="reference internal" href="#module-flake8_integration.tree">Tree</a></li>
722 <li><a class="reference internal" href="#module-flake8_integration.settings">Settings</a></li>
723 <li><a class="reference internal" href="#module-flake8_integration.configuration">Configuration</a></li>
724 <li><a class="reference internal" href="#status">Status</a></li>
729 <h4>Previous topic</h4>
730 <p class="topless"><a href="index.html"
731 title="previous chapter">Welcome to gedit Flake8 integration’s documentation!</a></p>
733 <ul class="this-page-menu">
734 <li><a href="_sources/flake8_integration.txt"
735 rel="nofollow">Show Source</a></li>
737 <div id="searchbox" style="display: none">
738 <h3>Quick search</h3>
739 <form class="search" action="search.html" method="get">
740 <input type="text" name="q" />
741 <input type="submit" value="Go" />
742 <input type="hidden" name="check_keywords" value="yes" />
743 <input type="hidden" name="area" value="default" />
745 <p class="searchtip" style="font-size: 90%">
746 Enter search terms or a module, class or function name.
749 <script type="text/javascript">$('#searchbox').show(0);</script>
752 <div class="clearer"></div>
754 <div class="related">
757 <li class="right" style="margin-right: 10px">
758 <a href="genindex.html" title="General Index"
761 <a href="py-modindex.html" title="Python Module Index"
764 <a href="index.html" title="Welcome to gedit Flake8 integration’s documentation!"
766 <li><a href="index.html">gedit Flake8 integration 0.1 documentation</a> »</li>
770 © Copyright 2013, Sébastien CHAZALLET.
771 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.