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>flake8_integration.configuration — 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="up" title="Module code" 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"
40 <li><a href="../../index.html">gedit Flake8 integration 0.1 documentation</a> »</li>
41 <li><a href="../index.html" accesskey="U">Module code</a> »</li>
45 <div class="document">
46 <div class="documentwrapper">
47 <div class="bodywrapper">
50 <h1>Source code for flake8_integration.configuration</h1><div class="highlight"><pre>
51 <span class="c">#-*- coding: utf8 -*-</span>
53 <span class="sd">"""Module used to configure plugin from an easy-to-use widget</span>
55 <span class="sd">:author: Sébastien CHAZALLET <s.chazallet@gmail.com></span>
56 <span class="sd">:organization: InsPyration EURL</span>
57 <span class="sd">:copyright: Copyright © InsPyration EURL <www.inspyration.org></span>
58 <span class="sd">:license: GPL 3 <http://www.gnu.org/licenses/gpl.html></span>
60 <span class="sd">:version: 0.1</span>
61 <span class="sd">"""</span>
63 <span class="kn">from</span> <span class="nn">gettext</span> <span class="kn">import</span> <span class="n">gettext</span> <span class="k">as</span> <span class="n">_</span>
65 <span class="kn">from</span> <span class="nn">gi.repository</span> <span class="kn">import</span> <span class="n">Gtk</span>
68 <span class="n">STUFF</span> <span class="o">=</span> <span class="mi">1</span>
71 <div class="viewcode-block" id="GeditFlake8ConfigWidget"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.configuration.GeditFlake8ConfigWidget">[docs]</a><span class="k">class</span> <span class="nc">GeditFlake8ConfigWidget</span><span class="p">(</span><span class="n">Gtk</span><span class="o">.</span><span class="n">Box</span><span class="p">):</span>
73 <div class="viewcode-block" id="GeditFlake8ConfigWidget.__init__"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.configuration.GeditFlake8ConfigWidget.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">settings</span><span class="p">):</span>
74 <span class="sd">"""Initialize the configuration widget from SettingsManager properties</span>
76 <span class="sd"> :type self: GeditFlake8ConfigWidget</span>
77 <span class="sd"> :param self: Current widget</span>
79 <span class="sd"> :type settings: SettingsManager</span>
80 <span class="sd"> :param settings: Object used to define all configurable properties</span>
82 <span class="sd"> :rtype: None</span>
83 <span class="sd"> """</span>
85 <span class="c"># the current widget is a box</span>
86 <span class="n">Gtk</span><span class="o">.</span><span class="n">Box</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">orientation</span><span class="o">=</span><span class="n">Gtk</span><span class="o">.</span><span class="n">Orientation</span><span class="o">.</span><span class="n">VERTICAL</span><span class="p">,</span> <span class="n">spacing</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span>
88 <span class="c"># reference to settings</span>
89 <span class="bp">self</span><span class="o">.</span><span class="n">settings</span> <span class="o">=</span> <span class="n">settings</span>
91 <span class="c"># store useful entries into a dictionary</span>
92 <span class="c"># in order to get their values later</span>
93 <span class="bp">self</span><span class="o">.</span><span class="n">entries</span> <span class="o">=</span> <span class="p">{}</span>
95 <span class="c"># Add a label on the top ot widget</span>
96 <span class="bp">self</span><span class="o">.</span><span class="n">pack_start</span><span class="p">(</span><span class="n">Gtk</span><span class="o">.</span><span class="n">Label</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Add to ignore list"</span><span class="p">)),</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
98 <span class="c"># create one checkbox for each warning that can be ignored</span>
99 <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">option</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">get_ignore_items</span><span class="p">():</span>
100 <span class="n">button</span> <span class="o">=</span> <span class="n">Gtk</span><span class="o">.</span><span class="n">CheckButton</span><span class="p">(</span><span class="n">option</span><span class="p">)</span>
101 <span class="n">button</span><span class="o">.</span><span class="n">set_active</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">is_in_ignore_list</span><span class="p">(</span><span class="n">key</span><span class="p">))</span>
102 <span class="bp">self</span><span class="o">.</span><span class="n">pack_start</span><span class="p">(</span><span class="n">button</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
103 <span class="c"># add the check button to entries</span>
104 <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">button</span>
106 <span class="c"># create an Hbox to get the label and the entry on the same line</span>
107 <span class="n">hbox</span> <span class="o">=</span> <span class="n">Gtk</span><span class="o">.</span><span class="n">Box</span><span class="p">(</span><span class="n">spacing</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
108 <span class="bp">self</span><span class="o">.</span><span class="n">pack_start</span><span class="p">(</span><span class="n">hbox</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
110 <span class="c"># label for complexity entry</span>
111 <span class="n">hbox</span><span class="o">.</span><span class="n">pack_start</span><span class="p">(</span><span class="n">Gtk</span><span class="o">.</span><span class="n">Label</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Complexity"</span><span class="p">)),</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
113 <span class="c"># complexity entry is an widget allowing us to be sure to have an int</span>
114 <span class="n">complexity_entry</span> <span class="o">=</span> <span class="n">Gtk</span><span class="o">.</span><span class="n">SpinButton</span><span class="p">()</span>
115 <span class="n">complexity_entry</span><span class="o">.</span><span class="n">set_adjustment</span><span class="p">(</span><span class="n">Gtk</span><span class="o">.</span><span class="n">Adjustment</span><span class="p">(</span>
116 <span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">get_complexity</span><span class="p">(),</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">21</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span>
117 <span class="n">hbox</span><span class="o">.</span><span class="n">pack_start</span><span class="p">(</span><span class="n">complexity_entry</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
118 <span class="c"># add the widget to entries</span>
119 <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">get_complexity_key</span><span class="p">()]</span> <span class="o">=</span> <span class="n">complexity_entry</span>
121 <span class="c"># add an event to get back values and use them</span>
122 <span class="bp">self</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">"destroy"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_configure_destroy</span><span class="p">)</span>
124 <div class="viewcode-block" id="GeditFlake8ConfigWidget.on_configure_destroy"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.configuration.GeditFlake8ConfigWidget.on_configure_destroy">[docs]</a> <span class="k">def</span> <span class="nf">on_configure_destroy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">widget</span><span class="p">):</span>
125 <span class="sd">"""Called when the widget is destroyed</span>
127 <span class="sd"> :type self: GeditFlake8ConfigWidget</span>
128 <span class="sd"> :param self: Current widget</span>
130 <span class="sd"> :type widget: GeditFlake8ConfigWidget</span>
131 <span class="sd"> :param widget: Current widget</span>
133 <span class="sd"> :rtype: None</span>
134 <span class="sd"> """</span>
136 <span class="c"># extract complexity form element and get complexity value</span>
137 <span class="n">complexity</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span>
138 <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">get_complexity_key</span><span class="p">())</span><span class="o">.</span><span class="n">get_text</span><span class="p">())</span>
140 <span class="c"># extract all other values</span>
141 <span class="n">values</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span><span class="o">.</span><span class="n">get_active</span><span class="p">()</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
143 <span class="c"># add back complexity value</span>
144 <span class="n">values</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">get_complexity_key</span><span class="p">()]</span> <span class="o">=</span> <span class="n">complexity</span>
146 <span class="c"># update settings</span>
147 <span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">update_setting</span><span class="p">(</span><span class="n">values</span><span class="p">)</span></div></div>
153 <div class="sphinxsidebar">
154 <div class="sphinxsidebarwrapper">
155 <div id="searchbox" style="display: none">
156 <h3>Quick search</h3>
157 <form class="search" action="../../search.html" method="get">
158 <input type="text" name="q" />
159 <input type="submit" value="Go" />
160 <input type="hidden" name="check_keywords" value="yes" />
161 <input type="hidden" name="area" value="default" />
163 <p class="searchtip" style="font-size: 90%">
164 Enter search terms or a module, class or function name.
167 <script type="text/javascript">$('#searchbox').show(0);</script>
170 <div class="clearer"></div>
172 <div class="related">
175 <li class="right" style="margin-right: 10px">
176 <a href="../../genindex.html" title="General Index"
179 <a href="../../py-modindex.html" title="Python Module Index"
181 <li><a href="../../index.html">gedit Flake8 integration 0.1 documentation</a> »</li>
182 <li><a href="../index.html" >Module code</a> »</li>
186 © Copyright 2013, Sébastien CHAZALLET.
187 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.