git.inspyration.org Git - gedit/flake8/blob - doc/build/html/_modules/flake8_integration/windowactivatable.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.windowactivatable &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.windowactivatable</h1><div class="highlight"><pre>
  51 <span class="c">#-*- coding: utf-8 -*-</span>
  52
  53 <span class="sd">&quot;&quot;&quot;Main module of the Plugin for gedit that allow flake8 integration</span>
  54
  55 <span class="sd">:author: Sébastien CHAZALLET &lt;s.chazallet@gmail.com&gt;</span>
  56 <span class="sd">:organization: InsPyration EURL</span>
  57 <span class="sd">:copyright: Copyright © InsPyration EURL &lt;www.inspyration.org&gt;</span>
  58 <span class="sd">:license: GPL 3 &lt;http://www.gnu.org/licenses/gpl.html&gt;</span>
  59
  60 <span class="sd">:version: 0.1</span>
  61 <span class="sd">&quot;&quot;&quot;</span>
  62
  63
  64 <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
  66 <span class="kn">from</span> <span class="nn">gi.repository</span> <span class="kn">import</span> <span class="n">GObject</span><span class="p">,</span> <span class="n">Gtk</span><span class="p">,</span> <span class="n">Gedit</span><span class="p">,</span> <span class="n">PeasGtk</span>
  67
  68 <span class="kn">from</span> <span class="nn">integrated</span> <span class="kn">import</span> <span class="n">check_code_and_get_formated_result</span> <span class="k">as</span> <span class="n">check_code</span>
  69 <span class="kn">from</span> <span class="nn">settings</span> <span class="kn">import</span> <span class="n">SettingsManager</span>
  70 <span class="kn">from</span> <span class="nn">tree</span> <span class="kn">import</span> <span class="n">GeditFlake8Tree</span>
  71 <span class="kn">from</span> <span class="nn">configuration</span> <span class="kn">import</span> <span class="n">GeditFlake8ConfigWidget</span>
  72
  73 <span class="c"># Menu to insert in gedit&#39;s &#39;Tools&#39; menu</span>
  74 <span class="n">ui_str</span> <span class="o">=</span> <span class="s">&quot;&quot;&quot;&lt;ui&gt;</span>
  75 <span class="s">  &lt;menubar name=&quot;MenuBar&quot;&gt;</span>
  76 <span class="s">    &lt;menu name=&quot;ToolsMenu&quot; action=&quot;Tools&quot;&gt;</span>
  77 <span class="s">      &lt;placeholder name=&quot;ToolsOps_2&quot;&gt;</span>
  78 <span class="s">        &lt;menuitem name=&quot;GeditFlake8&quot; action=&quot;GeditFlake8&quot;/&gt;</span>
  79 <span class="s">      &lt;/placeholder&gt;</span>
  80 <span class="s">    &lt;/menu&gt;</span>
  81 <span class="s">  &lt;/menubar&gt;</span>
  82 <span class="s">&lt;/ui&gt;</span>
  83 <span class="s">&quot;&quot;&quot;</span>
  84
  85
  86 <div class="viewcode-block" id="GeditFlake8WindowActivatable"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.windowactivatable.GeditFlake8WindowActivatable">[docs]</a><span class="k">class</span> <span class="nc">GeditFlake8WindowActivatable</span><span class="p">(</span><span class="n">GObject</span><span class="o">.</span><span class="n">Object</span><span class="p">,</span>
  87                                    <span class="n">Gedit</span><span class="o">.</span><span class="n">WindowActivatable</span><span class="p">,</span>
  88                                    <span class="n">PeasGtk</span><span class="o">.</span><span class="n">Configurable</span><span class="p">):</span>
  89     <span class="sd">&quot;&quot;&quot;Main module of the gedit flake8 plugin&quot;&quot;&quot;</span>
  90
  91     <span class="n">__gtype_name__</span> <span class="o">=</span> <span class="s">&quot;GeditFlake8WindowActivatable&quot;</span>
  92
  93     <span class="n">window</span> <span class="o">=</span> <span class="n">GObject</span><span class="o">.</span><span class="n">property</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">Gedit</span><span class="o">.</span><span class="n">Window</span><span class="p">)</span>
  94
  95 <div class="viewcode-block" id="GeditFlake8WindowActivatable.__init__"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.__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>
  96         <span class="sd">&quot;&quot;&quot;Initialize plugin</span>
  97
  98 <span class="sd">        :type  action: function</span>
  99 <span class="sd">        :param action: Called function that we intercept prints</span>
 100
 101 <span class="sd">        :rtype:  None</span>
 102 <span class="sd">        &quot;&quot;&quot;</span>
 103         <span class="n">GObject</span><span class="o">.</span><span class="n">Object</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
 104         <span class="c"># Initialize settings</span>
 105         <span class="bp">self</span><span class="o">.</span><span class="n">_settings</span> <span class="o">=</span> <span class="n">SettingsManager</span><span class="p">()</span>
 106         <span class="bp">self</span><span class="o">.</span><span class="n">flake8_tree</span> <span class="o">=</span> <span class="bp">None</span>
 107 </div>
 108 <div class="viewcode-block" id="GeditFlake8WindowActivatable.do_activate"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_activate">[docs]</a>    <span class="k">def</span> <span class="nf">do_activate</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 109         <span class="sd">&quot;&quot;&quot;Activate the plugin</span>
 110
 111 <span class="sd">        :type  self: GeditFlake8WindowActivatable</span>
 112 <span class="sd">        :param self: Current plugin</span>
 113
 114 <span class="sd">        :rtype:  None</span>
 115 <span class="sd">        &quot;&quot;&quot;</span>
 116         <span class="c"># Get the Gtk.UIManager</span>
 117         <span class="n">manager</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">get_ui_manager</span><span class="p">()</span>
 118
 119         <span class="c"># Create a new action group</span>
 120         <span class="bp">self</span><span class="o">.</span><span class="n">_action_group</span> <span class="o">=</span> <span class="n">Gtk</span><span class="o">.</span><span class="n">ActionGroup</span><span class="p">(</span><span class="s">&quot;GeditFlake8PluginActions&quot;</span><span class="p">)</span>
 121         <span class="bp">self</span><span class="o">.</span><span class="n">_action_group</span><span class="o">.</span><span class="n">add_actions</span><span class="p">([(</span><span class="s">&quot;GeditFlake8&quot;</span><span class="p">,</span>
 122                                          <span class="bp">None</span><span class="p">,</span>
 123                                          <span class="n">_</span><span class="p">(</span><span class="s">&quot;Check Python source code&quot;</span><span class="p">),</span>
 124                                          <span class="bp">None</span><span class="p">,</span>
 125                                          <span class="n">_</span><span class="p">(</span><span class="s">&quot;Check Python source code&quot;</span><span class="p">),</span>
 126                                          <span class="bp">self</span><span class="o">.</span><span class="n">on_check_source_code</span><span class="p">)])</span>
 127
 128         <span class="c"># Insert the action group</span>
 129         <span class="n">manager</span><span class="o">.</span><span class="n">insert_action_group</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_action_group</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span>
 130
 131         <span class="c"># Merge the UI</span>
 132         <span class="bp">self</span><span class="o">.</span><span class="n">_ui_id</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">add_ui_from_string</span><span class="p">(</span><span class="n">ui_str</span><span class="p">)</span>
 133
 134         <span class="c"># Create a tree</span>
 135         <span class="bp">self</span><span class="o">.</span><span class="n">flake8_tree</span> <span class="o">=</span> <span class="n">GeditFlake8Tree</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="p">)</span>
 136 </div>
 137 <div class="viewcode-block" id="GeditFlake8WindowActivatable.do_deactivate"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_deactivate">[docs]</a>    <span class="k">def</span> <span class="nf">do_deactivate</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 138         <span class="sd">&quot;&quot;&quot;Deactivate the plugin</span>
 139
 140 <span class="sd">        :type  self: GeditFlake8WindowActivatable</span>
 141 <span class="sd">        :param self: Current plugin</span>
 142
 143 <span class="sd">        :rtype:  None</span>
 144 <span class="sd">        &quot;&quot;&quot;</span>
 145         <span class="c"># Remove the tree from the side panel</span>
 146         <span class="bp">self</span><span class="o">.</span><span class="n">flake8_tree</span><span class="o">.</span><span class="n">remove</span><span class="p">()</span>
 147
 148         <span class="c"># Delete tree object</span>
 149         <span class="bp">self</span><span class="o">.</span><span class="n">flake8_tree</span> <span class="o">=</span> <span class="bp">None</span>
 150
 151         <span class="c"># Get the Gtk.UIManager</span>
 152         <span class="n">manager</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">get_ui_manager</span><span class="p">()</span>
 153
 154         <span class="c"># Remove the ui</span>
 155         <span class="n">manager</span><span class="o">.</span><span class="n">remove_ui</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_ui_id</span><span class="p">)</span>
 156
 157         <span class="c"># Remove the action group</span>
 158         <span class="n">manager</span><span class="o">.</span><span class="n">remove_action_group</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_action_group</span><span class="p">)</span>
 159
 160         <span class="c"># Delete the action group object</span>
 161         <span class="bp">self</span><span class="o">.</span><span class="n">_action_group</span> <span class="o">=</span> <span class="bp">None</span>
 162
 163         <span class="c"># Make sure the manager updates</span>
 164         <span class="n">manager</span><span class="o">.</span><span class="n">ensure_update</span><span class="p">()</span>
 165 </div>
 166 <div class="viewcode-block" id="GeditFlake8WindowActivatable.do_update_state"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_update_state">[docs]</a>    <span class="k">def</span> <span class="nf">do_update_state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 167         <span class="sd">&quot;&quot;&quot;Allow to activate the plugin only if the document is python code</span>
 168 <span class="sd">        If the document is a new document, it hasto be saved or the language of</span>
 169 <span class="sd">        the document has to be set.</span>
 170
 171 <span class="sd">        :type  self: GeditFlake8WindowActivatable</span>
 172 <span class="sd">        :param self: Current plugin</span>
 173
 174 <span class="sd">        :rtype:  None</span>
 175 <span class="sd">        &quot;&quot;&quot;</span>
 176         <span class="n">state</span> <span class="o">=</span> <span class="bp">False</span>
 177         <span class="n">doc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">get_active_document</span><span class="p">()</span>
 178         <span class="k">if</span> <span class="n">doc</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
 179             <span class="n">language</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">get_language</span><span class="p">()</span>
 180             <span class="k">if</span> <span class="n">language</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
 181                 <span class="n">state</span> <span class="o">=</span> <span class="n">language</span><span class="o">.</span><span class="n">get_id</span><span class="p">()</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&quot;python&quot;</span><span class="p">,</span> <span class="s">&quot;python3&quot;</span><span class="p">]</span>
 182         <span class="bp">self</span><span class="o">.</span><span class="n">_action_group</span><span class="o">.</span><span class="n">set_sensitive</span><span class="p">(</span><span class="n">state</span><span class="p">)</span>
 183 </div>
 184 <div class="viewcode-block" id="GeditFlake8WindowActivatable.do_create_configure_widget"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.do_create_configure_widget">[docs]</a>    <span class="k">def</span> <span class="nf">do_create_configure_widget</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 185         <span class="sd">&quot;&quot;&quot;Action when a user want to configure the plugin</span>
 186
 187 <span class="sd">        :type  self: GeditFlake8WindowActivatable</span>
 188 <span class="sd">        :param self: Current plugin</span>
 189
 190 <span class="sd">        :rtype:  GeditFlake8ConfigWidget</span>
 191 <span class="sd">        :return: a configuration widget</span>
 192 <span class="sd">        &quot;&quot;&quot;</span>
 193         <span class="k">return</span> <span class="n">GeditFlake8ConfigWidget</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_settings</span><span class="p">)</span>
 194 </div>
 195 <div class="viewcode-block" id="GeditFlake8WindowActivatable.on_check_source_code"><a class="viewcode-back" href="../../flake8_integration.html#flake8_integration.windowactivatable.GeditFlake8WindowActivatable.on_check_source_code">[docs]</a>    <span class="k">def</span> <span class="nf">on_check_source_code</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">):</span>
 196         <span class="sd">&quot;&quot;&quot;The user ask to check code source :</span>
 197 <span class="sd">        1\ check there is a doc and the doc is python code</span>
 198 <span class="sd">        2\ use flake8</span>
 199 <span class="sd">        3\ put flake8 results into the tree and activate it</span>
 200
 201 <span class="sd">        :type  self: GeditFlake8WindowActivatable</span>
 202 <span class="sd">        :param self: Current plugin</span>
 203
 204 <span class="sd">        :type  action: Gtk.Action</span>
 205 <span class="sd">        :param action: Called function that we intercept prints</span>
 206
 207 <span class="sd">        :rtype:  None</span>
 208 <span class="sd">        &quot;&quot;&quot;</span>
 209
 210         <span class="c"># Get the document content</span>
 211         <span class="n">doc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="o">.</span><span class="n">get_active_document</span><span class="p">()</span>
 212         <span class="k">if</span> <span class="ow">not</span> <span class="n">doc</span><span class="p">:</span>
 213             <span class="k">return</span>
 214
 215         <span class="c"># check the language of current document is set</span>
 216         <span class="n">language</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">get_language</span><span class="p">()</span>
 217         <span class="k">if</span> <span class="n">language</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
 218             <span class="k">return</span>
 219
 220         <span class="c"># check the language of current document is python</span>
 221         <span class="k">if</span> <span class="n">language</span><span class="o">.</span><span class="n">get_id</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&quot;python&quot;</span><span class="p">,</span> <span class="s">&quot;python3&quot;</span><span class="p">]:</span>
 222             <span class="k">return</span>
 223
 224         <span class="c"># Use flake8 to get warnings</span>
 225         <span class="n">warnings</span> <span class="o">=</span> <span class="n">check_code</span><span class="p">(</span>
 226             <span class="n">doc</span><span class="o">.</span><span class="n">get_text</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">get_start_iter</span><span class="p">(),</span> <span class="n">doc</span><span class="o">.</span><span class="n">get_end_iter</span><span class="p">(),</span> <span class="bp">False</span><span class="p">),</span>
 227             <span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="o">.</span><span class="n">upper</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_ignore_list</span><span class="p">()),</span>
 228             <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>
 229
 230         <span class="c"># Empty store</span>
 231         <span class="bp">self</span><span class="o">.</span><span class="n">flake8_tree</span><span class="o">.</span><span class="n">update_model</span><span class="p">(</span><span class="n">warnings</span><span class="p">)</span>
 232
 233         <span class="c"># Activate tree</span>
 234         <span class="bp">self</span><span class="o">.</span><span class="n">flake8_tree</span><span class="o">.</span><span class="n">activate</span><span class="p">()</span></div></div>
 235 </pre></div>
 236
 237           </div>
 238         </div>
 239       </div>
 240       <div class="sphinxsidebar">
 241         <div class="sphinxsidebarwrapper">
 242 <div id="searchbox" style="display: none">
 243   <h3>Quick search</h3>
 244     <form class="search" action="../../search.html" method="get">
 245       <input type="text" name="q" />
 246       <input type="submit" value="Go" />
 247       <input type="hidden" name="check_keywords" value="yes" />
 248       <input type="hidden" name="area" value="default" />
 249     </form>
 250     <p class="searchtip" style="font-size: 90%">
 251     Enter search terms or a module, class or function name.
 252     </p>
 253 </div>
 254 <script type="text/javascript">$('#searchbox').show(0);</script>
 255         </div>
 256       </div>
 257       <div class="clearer"></div>
 258     </div>
 259     <div class="related">
 260       <h3>Navigation</h3>
 261       <ul>
 262         <li class="right" style="margin-right: 10px">
 263           <a href="../../genindex.html" title="General Index"
 264              >index</a></li>
 265         <li class="right" >
 266           <a href="../../py-modindex.html" title="Python Module Index"
 267              >modules</a> |</li>
 268         <li><a href="../../index.html">gedit Flake8 integration 0.1 documentation</a> &raquo;</li>
 269           <li><a href="../index.html" >Module code</a> &raquo;</li>
 270       </ul>
 271     </div>
 272     <div class="footer">
 273         &copy; Copyright 2013, Sébastien CHAZALLET.
 274       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
 275     </div>
 276   </body>
 277 </html>