PyLint/Documentation/source/Plugin_Checker_PyLint.PluginPyLint.html

changeset 85
6124794c3ffe
parent 60
971dd1b69f5b
child 95
50eba81e4a9f
equal deleted inserted replaced
84:022f0bc87198 85:6124794c3ffe
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Checker_PyLint.PluginPyLint</h1> 23 <h1>Plugin_Checker_PyLint.PluginPyLint</h1>
24
23 <p> 25 <p>
24 Module implementing the PyLint plug-in. 26 Module implementing the PyLint plug-in.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
27 <table> 29
28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>exePy2</td></tr><tr><td>exePy3</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> 30 <table>
31 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>exePy3</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#PyLintPlugin">PyLintPlugin</a></td> 38 <td><a href="#PyLintPlugin">PyLintPlugin</a></td>
34 <td>Class implementing the PyLint plug-in.</td> 39 <td>Class implementing the PyLint plug-in.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
44 <table>
45
39 <tr> 46 <tr>
40 <td><a href="#__getProgramVersion">__getProgramVersion</a></td> 47 <td><a href="#__getProgramVersion">__getProgramVersion</a></td>
41 <td>Private method to generate a program entry.</td> 48 <td>Private method to generate a program entry.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#_checkProgram">_checkProgram</a></td> 51 <td><a href="#_checkProgram">_checkProgram</a></td>
44 <td>Restricted function to check the availability of pylint.</td> 52 <td>Restricted function to check the availability of pylint.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#_findExecutable">_findExecutable</a></td> 55 <td><a href="#_findExecutable">_findExecutable</a></td>
47 <td>Restricted function to determine the name and path of the executable.</td> 56 <td>Restricted function to determine the name and path of the executable.</td>
48 </tr><tr> 57 </tr>
58 <tr>
49 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td> 59 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td>
50 <td>Public method to support the display of some executable info.</td> 60 <td>Public method to support the display of some executable info.</td>
51 </tr><tr> 61 </tr>
62 <tr>
52 <td><a href="#getExePath">getExePath</a></td> 63 <td><a href="#getExePath">getExePath</a></td>
53 <td></td> 64 <td></td>
54 </tr> 65 </tr>
55 </table> 66 </table>
56 <hr /><hr /> 67 <hr />
68 <hr />
57 <a NAME="PyLintPlugin" ID="PyLintPlugin"></a> 69 <a NAME="PyLintPlugin" ID="PyLintPlugin"></a>
58 <h2>PyLintPlugin</h2> 70 <h2>PyLintPlugin</h2>
71
59 <p> 72 <p>
60 Class implementing the PyLint plug-in. 73 Class implementing the PyLint plug-in.
61 </p> 74 </p>
62 <h3>Derived from</h3> 75 <h3>Derived from</h3>
63 QObject 76 QObject
64 <h3>Class Attributes</h3> 77 <h3>Class Attributes</h3>
78
65 <table> 79 <table>
66 <tr><td>None</td></tr> 80 <tr><td>None</td></tr>
67 </table> 81 </table>
68 <h3>Class Methods</h3> 82 <h3>Class Methods</h3>
83
69 <table> 84 <table>
70 <tr><td>None</td></tr> 85 <tr><td>None</td></tr>
71 </table> 86 </table>
72 <h3>Methods</h3> 87 <h3>Methods</h3>
73 <table> 88
89 <table>
90
74 <tr> 91 <tr>
75 <td><a href="#PyLintPlugin.__init__">PyLintPlugin</a></td> 92 <td><a href="#PyLintPlugin.__init__">PyLintPlugin</a></td>
76 <td>Constructor</td> 93 <td>Constructor</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#PyLintPlugin.__editorClosed">__editorClosed</a></td> 96 <td><a href="#PyLintPlugin.__editorClosed">__editorClosed</a></td>
79 <td>Private slot called, when an editor was closed.</td> 97 <td>Private slot called, when an editor was closed.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#PyLintPlugin.__editorOpened">__editorOpened</a></td> 100 <td><a href="#PyLintPlugin.__editorOpened">__editorOpened</a></td>
82 <td>Private slot called, when a new editor was opened.</td> 101 <td>Private slot called, when a new editor was opened.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#PyLintPlugin.__editorPylint">__editorPylint</a></td> 104 <td><a href="#PyLintPlugin.__editorPylint">__editorPylint</a></td>
85 <td>Private slot to handle the Pylint context menu action of the editors.</td> 105 <td>Private slot to handle the Pylint context menu action of the editors.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#PyLintPlugin.__editorShowMenu">__editorShowMenu</a></td> 108 <td><a href="#PyLintPlugin.__editorShowMenu">__editorShowMenu</a></td>
88 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> 109 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#PyLintPlugin.__initialize">__initialize</a></td> 112 <td><a href="#PyLintPlugin.__initialize">__initialize</a></td>
91 <td>Private slot to (re)initialize the plugin.</td> 113 <td>Private slot to (re)initialize the plugin.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#PyLintPlugin.__loadTranslator">__loadTranslator</a></td> 116 <td><a href="#PyLintPlugin.__loadTranslator">__loadTranslator</a></td>
94 <td>Private method to load the translation file.</td> 117 <td>Private method to load the translation file.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#PyLintPlugin.__projectBrowserPylint">__projectBrowserPylint</a></td> 120 <td><a href="#PyLintPlugin.__projectBrowserPylint">__projectBrowserPylint</a></td>
97 <td>Private method to handle the Pylint context menu action of the project sources browser.</td> 121 <td>Private method to handle the Pylint context menu action of the project sources browser.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#PyLintPlugin.__projectBrowserPylintShow">__projectBrowserPylintShow</a></td> 124 <td><a href="#PyLintPlugin.__projectBrowserPylintShow">__projectBrowserPylintShow</a></td>
100 <td>Private slot to show the PyLint dialog with the results of the last run.</td> 125 <td>Private slot to show the PyLint dialog with the results of the last run.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#PyLintPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td> 128 <td><a href="#PyLintPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td>
103 <td>Private slot called, when the the project browser menu or a submenu is about to be shown.</td> 129 <td>Private slot called, when the the project browser menu or a submenu is about to be shown.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#PyLintPlugin.__projectPylint">__projectPylint</a></td> 132 <td><a href="#PyLintPlugin.__projectPylint">__projectPylint</a></td>
106 <td>Private slot used to check the project files with Pylint.</td> 133 <td>Private slot used to check the project files with Pylint.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#PyLintPlugin.__projectPylintShow">__projectPylintShow</a></td> 136 <td><a href="#PyLintPlugin.__projectPylintShow">__projectPylintShow</a></td>
109 <td>Private slot to show the PyLint dialog with the results of the last run.</td> 137 <td>Private slot to show the PyLint dialog with the results of the last run.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#PyLintPlugin.__projectShowMenu">__projectShowMenu</a></td> 140 <td><a href="#PyLintPlugin.__projectShowMenu">__projectShowMenu</a></td>
112 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> 141 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#PyLintPlugin.__pyLint">__pyLint</a></td> 144 <td><a href="#PyLintPlugin.__pyLint">__pyLint</a></td>
115 <td>Private method used to perform a PyLint run.</td> 145 <td>Private method used to perform a PyLint run.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#PyLintPlugin.activate">activate</a></td> 148 <td><a href="#PyLintPlugin.activate">activate</a></td>
118 <td>Public method to activate this plugin.</td> 149 <td>Public method to activate this plugin.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#PyLintPlugin.deactivate">deactivate</a></td> 152 <td><a href="#PyLintPlugin.deactivate">deactivate</a></td>
121 <td>Public method to deactivate this plugin.</td> 153 <td>Public method to deactivate this plugin.</td>
122 </tr> 154 </tr>
123 </table> 155 </table>
124 <h3>Static Methods</h3> 156 <h3>Static Methods</h3>
157
125 <table> 158 <table>
126 <tr><td>None</td></tr> 159 <tr><td>None</td></tr>
127 </table> 160 </table>
161
128 <a NAME="PyLintPlugin.__init__" ID="PyLintPlugin.__init__"></a> 162 <a NAME="PyLintPlugin.__init__" ID="PyLintPlugin.__init__"></a>
129 <h4>PyLintPlugin (Constructor)</h4> 163 <h4>PyLintPlugin (Constructor)</h4>
130 <b>PyLintPlugin</b>(<i>ui</i>) 164 <b>PyLintPlugin</b>(<i>ui</i>)
165
131 <p> 166 <p>
132 Constructor 167 Constructor
133 </p><dl> 168 </p>
169 <dl>
170
134 <dt><i>ui</i></dt> 171 <dt><i>ui</i></dt>
135 <dd> 172 <dd>
136 reference to the user interface object (UI.UserInterface) 173 reference to the user interface object (UI.UserInterface)
137 </dd> 174 </dd>
138 </dl><a NAME="PyLintPlugin.__editorClosed" ID="PyLintPlugin.__editorClosed"></a> 175 </dl>
176 <a NAME="PyLintPlugin.__editorClosed" ID="PyLintPlugin.__editorClosed"></a>
139 <h4>PyLintPlugin.__editorClosed</h4> 177 <h4>PyLintPlugin.__editorClosed</h4>
140 <b>__editorClosed</b>(<i>editor</i>) 178 <b>__editorClosed</b>(<i>editor</i>)
179
141 <p> 180 <p>
142 Private slot called, when an editor was closed. 181 Private slot called, when an editor was closed.
143 </p><dl> 182 </p>
183 <dl>
184
144 <dt><i>editor</i></dt> 185 <dt><i>editor</i></dt>
145 <dd> 186 <dd>
146 reference to the editor (QScintilla.Editor) 187 reference to the editor (QScintilla.Editor)
147 </dd> 188 </dd>
148 </dl><a NAME="PyLintPlugin.__editorOpened" ID="PyLintPlugin.__editorOpened"></a> 189 </dl>
190 <a NAME="PyLintPlugin.__editorOpened" ID="PyLintPlugin.__editorOpened"></a>
149 <h4>PyLintPlugin.__editorOpened</h4> 191 <h4>PyLintPlugin.__editorOpened</h4>
150 <b>__editorOpened</b>(<i>editor</i>) 192 <b>__editorOpened</b>(<i>editor</i>)
193
151 <p> 194 <p>
152 Private slot called, when a new editor was opened. 195 Private slot called, when a new editor was opened.
153 </p><dl> 196 </p>
197 <dl>
198
154 <dt><i>editor</i></dt> 199 <dt><i>editor</i></dt>
155 <dd> 200 <dd>
156 reference to the new editor (QScintilla.Editor) 201 reference to the new editor (QScintilla.Editor)
157 </dd> 202 </dd>
158 </dl><a NAME="PyLintPlugin.__editorPylint" ID="PyLintPlugin.__editorPylint"></a> 203 </dl>
204 <a NAME="PyLintPlugin.__editorPylint" ID="PyLintPlugin.__editorPylint"></a>
159 <h4>PyLintPlugin.__editorPylint</h4> 205 <h4>PyLintPlugin.__editorPylint</h4>
160 <b>__editorPylint</b>(<i></i>) 206 <b>__editorPylint</b>(<i></i>)
207
161 <p> 208 <p>
162 Private slot to handle the Pylint context menu action of the editors. 209 Private slot to handle the Pylint context menu action of the editors.
163 </p><a NAME="PyLintPlugin.__editorShowMenu" ID="PyLintPlugin.__editorShowMenu"></a> 210 </p>
211 <a NAME="PyLintPlugin.__editorShowMenu" ID="PyLintPlugin.__editorShowMenu"></a>
164 <h4>PyLintPlugin.__editorShowMenu</h4> 212 <h4>PyLintPlugin.__editorShowMenu</h4>
165 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) 213 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
214
166 <p> 215 <p>
167 Private slot called, when the the editor context menu or a submenu is 216 Private slot called, when the the editor context menu or a submenu is
168 about to be shown. 217 about to be shown.
169 </p><dl> 218 </p>
219 <dl>
220
170 <dt><i>menuName</i></dt> 221 <dt><i>menuName</i></dt>
171 <dd> 222 <dd>
172 name of the menu to be shown (string) 223 name of the menu to be shown (string)
173 </dd><dt><i>menu</i></dt> 224 </dd>
225 <dt><i>menu</i></dt>
174 <dd> 226 <dd>
175 reference to the menu (QMenu) 227 reference to the menu (QMenu)
176 </dd><dt><i>editor</i></dt> 228 </dd>
229 <dt><i>editor</i></dt>
177 <dd> 230 <dd>
178 reference to the editor (QScintilla.Editor) 231 reference to the editor (QScintilla.Editor)
179 </dd> 232 </dd>
180 </dl><a NAME="PyLintPlugin.__initialize" ID="PyLintPlugin.__initialize"></a> 233 </dl>
234 <a NAME="PyLintPlugin.__initialize" ID="PyLintPlugin.__initialize"></a>
181 <h4>PyLintPlugin.__initialize</h4> 235 <h4>PyLintPlugin.__initialize</h4>
182 <b>__initialize</b>(<i></i>) 236 <b>__initialize</b>(<i></i>)
237
183 <p> 238 <p>
184 Private slot to (re)initialize the plugin. 239 Private slot to (re)initialize the plugin.
185 </p><a NAME="PyLintPlugin.__loadTranslator" ID="PyLintPlugin.__loadTranslator"></a> 240 </p>
241 <a NAME="PyLintPlugin.__loadTranslator" ID="PyLintPlugin.__loadTranslator"></a>
186 <h4>PyLintPlugin.__loadTranslator</h4> 242 <h4>PyLintPlugin.__loadTranslator</h4>
187 <b>__loadTranslator</b>(<i></i>) 243 <b>__loadTranslator</b>(<i></i>)
244
188 <p> 245 <p>
189 Private method to load the translation file. 246 Private method to load the translation file.
190 </p><a NAME="PyLintPlugin.__projectBrowserPylint" ID="PyLintPlugin.__projectBrowserPylint"></a> 247 </p>
248 <a NAME="PyLintPlugin.__projectBrowserPylint" ID="PyLintPlugin.__projectBrowserPylint"></a>
191 <h4>PyLintPlugin.__projectBrowserPylint</h4> 249 <h4>PyLintPlugin.__projectBrowserPylint</h4>
192 <b>__projectBrowserPylint</b>(<i></i>) 250 <b>__projectBrowserPylint</b>(<i></i>)
251
193 <p> 252 <p>
194 Private method to handle the Pylint context menu action of the project 253 Private method to handle the Pylint context menu action of the project
195 sources browser. 254 sources browser.
196 </p><a NAME="PyLintPlugin.__projectBrowserPylintShow" ID="PyLintPlugin.__projectBrowserPylintShow"></a> 255 </p>
256 <a NAME="PyLintPlugin.__projectBrowserPylintShow" ID="PyLintPlugin.__projectBrowserPylintShow"></a>
197 <h4>PyLintPlugin.__projectBrowserPylintShow</h4> 257 <h4>PyLintPlugin.__projectBrowserPylintShow</h4>
198 <b>__projectBrowserPylintShow</b>(<i></i>) 258 <b>__projectBrowserPylintShow</b>(<i></i>)
259
199 <p> 260 <p>
200 Private slot to show the PyLint dialog with the results of the last 261 Private slot to show the PyLint dialog with the results of the last
201 run. 262 run.
202 </p><a NAME="PyLintPlugin.__projectBrowserShowMenu" ID="PyLintPlugin.__projectBrowserShowMenu"></a> 263 </p>
264 <a NAME="PyLintPlugin.__projectBrowserShowMenu" ID="PyLintPlugin.__projectBrowserShowMenu"></a>
203 <h4>PyLintPlugin.__projectBrowserShowMenu</h4> 265 <h4>PyLintPlugin.__projectBrowserShowMenu</h4>
204 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>) 266 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
267
205 <p> 268 <p>
206 Private slot called, when the the project browser menu or a submenu is 269 Private slot called, when the the project browser menu or a submenu is
207 about to be shown. 270 about to be shown.
208 </p><dl> 271 </p>
272 <dl>
273
209 <dt><i>menuName</i></dt> 274 <dt><i>menuName</i></dt>
210 <dd> 275 <dd>
211 name of the menu to be shown (string) 276 name of the menu to be shown (string)
212 </dd><dt><i>menu</i></dt> 277 </dd>
278 <dt><i>menu</i></dt>
213 <dd> 279 <dd>
214 reference to the menu (QMenu) 280 reference to the menu (QMenu)
215 </dd> 281 </dd>
216 </dl><a NAME="PyLintPlugin.__projectPylint" ID="PyLintPlugin.__projectPylint"></a> 282 </dl>
283 <a NAME="PyLintPlugin.__projectPylint" ID="PyLintPlugin.__projectPylint"></a>
217 <h4>PyLintPlugin.__projectPylint</h4> 284 <h4>PyLintPlugin.__projectPylint</h4>
218 <b>__projectPylint</b>(<i></i>) 285 <b>__projectPylint</b>(<i></i>)
286
219 <p> 287 <p>
220 Private slot used to check the project files with Pylint. 288 Private slot used to check the project files with Pylint.
221 </p><a NAME="PyLintPlugin.__projectPylintShow" ID="PyLintPlugin.__projectPylintShow"></a> 289 </p>
290 <a NAME="PyLintPlugin.__projectPylintShow" ID="PyLintPlugin.__projectPylintShow"></a>
222 <h4>PyLintPlugin.__projectPylintShow</h4> 291 <h4>PyLintPlugin.__projectPylintShow</h4>
223 <b>__projectPylintShow</b>(<i></i>) 292 <b>__projectPylintShow</b>(<i></i>)
293
224 <p> 294 <p>
225 Private slot to show the PyLint dialog with the results of the last 295 Private slot to show the PyLint dialog with the results of the last
226 run. 296 run.
227 </p><a NAME="PyLintPlugin.__projectShowMenu" ID="PyLintPlugin.__projectShowMenu"></a> 297 </p>
298 <a NAME="PyLintPlugin.__projectShowMenu" ID="PyLintPlugin.__projectShowMenu"></a>
228 <h4>PyLintPlugin.__projectShowMenu</h4> 299 <h4>PyLintPlugin.__projectShowMenu</h4>
229 <b>__projectShowMenu</b>(<i>menuName, menu</i>) 300 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
301
230 <p> 302 <p>
231 Private slot called, when the the project menu or a submenu is 303 Private slot called, when the the project menu or a submenu is
232 about to be shown. 304 about to be shown.
233 </p><dl> 305 </p>
306 <dl>
307
234 <dt><i>menuName</i></dt> 308 <dt><i>menuName</i></dt>
235 <dd> 309 <dd>
236 name of the menu to be shown (string) 310 name of the menu to be shown (string)
237 </dd><dt><i>menu</i></dt> 311 </dd>
312 <dt><i>menu</i></dt>
238 <dd> 313 <dd>
239 reference to the menu (QMenu) 314 reference to the menu (QMenu)
240 </dd> 315 </dd>
241 </dl><a NAME="PyLintPlugin.__pyLint" ID="PyLintPlugin.__pyLint"></a> 316 </dl>
317 <a NAME="PyLintPlugin.__pyLint" ID="PyLintPlugin.__pyLint"></a>
242 <h4>PyLintPlugin.__pyLint</h4> 318 <h4>PyLintPlugin.__pyLint</h4>
243 <b>__pyLint</b>(<i>project, mpName, forProject, forEditor=False</i>) 319 <b>__pyLint</b>(<i>project, mpName, forProject, forEditor=False</i>)
320
244 <p> 321 <p>
245 Private method used to perform a PyLint run. 322 Private method used to perform a PyLint run.
246 </p><dl> 323 </p>
324 <dl>
325
247 <dt><i>project</i></dt> 326 <dt><i>project</i></dt>
248 <dd> 327 <dd>
249 reference to the Project object 328 reference to the Project object
250 </dd><dt><i>mpName</i></dt> 329 </dd>
330 <dt><i>mpName</i></dt>
251 <dd> 331 <dd>
252 name of module or package to be checked (string) 332 name of module or package to be checked (string)
253 </dd><dt><i>forProject</i></dt> 333 </dd>
334 <dt><i>forProject</i></dt>
254 <dd> 335 <dd>
255 flag indicating a run for the project (boolean) 336 flag indicating a run for the project (boolean)
256 </dd><dt><i>forEditor</i></dt> 337 </dd>
338 <dt><i>forEditor</i></dt>
257 <dd> 339 <dd>
258 flag indicating a run for an editor (boolean) 340 flag indicating a run for an editor (boolean)
259 </dd> 341 </dd>
260 </dl><a NAME="PyLintPlugin.activate" ID="PyLintPlugin.activate"></a> 342 </dl>
343 <a NAME="PyLintPlugin.activate" ID="PyLintPlugin.activate"></a>
261 <h4>PyLintPlugin.activate</h4> 344 <h4>PyLintPlugin.activate</h4>
262 <b>activate</b>(<i></i>) 345 <b>activate</b>(<i></i>)
346
263 <p> 347 <p>
264 Public method to activate this plugin. 348 Public method to activate this plugin.
265 </p><dl> 349 </p>
350 <dl>
266 <dt>Returns:</dt> 351 <dt>Returns:</dt>
267 <dd> 352 <dd>
268 tuple of None and activation status (boolean) 353 tuple of None and activation status (boolean)
269 </dd> 354 </dd>
270 </dl><a NAME="PyLintPlugin.deactivate" ID="PyLintPlugin.deactivate"></a> 355 </dl>
356 <a NAME="PyLintPlugin.deactivate" ID="PyLintPlugin.deactivate"></a>
271 <h4>PyLintPlugin.deactivate</h4> 357 <h4>PyLintPlugin.deactivate</h4>
272 <b>deactivate</b>(<i></i>) 358 <b>deactivate</b>(<i></i>)
359
273 <p> 360 <p>
274 Public method to deactivate this plugin. 361 Public method to deactivate this plugin.
275 </p> 362 </p>
276 <div align="right"><a href="#top">Up</a></div> 363 <div align="right"><a href="#top">Up</a></div>
277 <hr /><hr /> 364 <hr />
365 <hr />
278 <a NAME="__getProgramVersion" ID="__getProgramVersion"></a> 366 <a NAME="__getProgramVersion" ID="__getProgramVersion"></a>
279 <h2>__getProgramVersion</h2> 367 <h2>__getProgramVersion</h2>
280 <b>__getProgramVersion</b>(<i>exe</i>) 368 <b>__getProgramVersion</b>(<i>exe</i>)
369
281 <p> 370 <p>
282 Private method to generate a program entry. 371 Private method to generate a program entry.
283 </p><dl> 372 </p>
373 <dl>
374
284 <dt><i>exe</i></dt> 375 <dt><i>exe</i></dt>
285 <dd> 376 <dd>
286 name of the executable program (string) 377 name of the executable program (string)
287 </dd> 378 </dd>
288 </dl><dl> 379 </dl>
380 <dl>
289 <dt>Returns:</dt> 381 <dt>Returns:</dt>
290 <dd> 382 <dd>
291 version string of detected version (string) 383 version string of detected version (string)
292 </dd> 384 </dd>
293 </dl> 385 </dl>
294 <div align="right"><a href="#top">Up</a></div> 386 <div align="right"><a href="#top">Up</a></div>
295 <hr /><hr /> 387 <hr />
388 <hr />
296 <a NAME="_checkProgram" ID="_checkProgram"></a> 389 <a NAME="_checkProgram" ID="_checkProgram"></a>
297 <h2>_checkProgram</h2> 390 <h2>_checkProgram</h2>
298 <b>_checkProgram</b>(<i></i>) 391 <b>_checkProgram</b>(<i></i>)
392
299 <p> 393 <p>
300 Restricted function to check the availability of pylint. 394 Restricted function to check the availability of pylint.
301 </p><dl> 395 </p>
396 <dl>
302 <dt>Returns:</dt> 397 <dt>Returns:</dt>
303 <dd> 398 <dd>
304 flag indicating availability (boolean) 399 flag indicating availability (boolean)
305 </dd> 400 </dd>
306 </dl> 401 </dl>
307 <div align="right"><a href="#top">Up</a></div> 402 <div align="right"><a href="#top">Up</a></div>
308 <hr /><hr /> 403 <hr />
404 <hr />
309 <a NAME="_findExecutable" ID="_findExecutable"></a> 405 <a NAME="_findExecutable" ID="_findExecutable"></a>
310 <h2>_findExecutable</h2> 406 <h2>_findExecutable</h2>
311 <b>_findExecutable</b>(<i>majorVersion</i>) 407 <b>_findExecutable</b>(<i>majorVersion</i>)
408
312 <p> 409 <p>
313 Restricted function to determine the name and path of the executable. 410 Restricted function to determine the name and path of the executable.
314 </p><dl> 411 </p>
412 <dl>
413
315 <dt><i>majorVersion</i></dt> 414 <dt><i>majorVersion</i></dt>
316 <dd> 415 <dd>
317 major python version of the executables (int) 416 major python version of the executables (int)
318 </dd> 417 </dd>
319 </dl><dl> 418 </dl>
419 <dl>
320 <dt>Returns:</dt> 420 <dt>Returns:</dt>
321 <dd> 421 <dd>
322 path name of the executable (string) 422 path name of the executable (string)
323 </dd> 423 </dd>
324 </dl> 424 </dl>
325 <div align="right"><a href="#top">Up</a></div> 425 <div align="right"><a href="#top">Up</a></div>
326 <hr /><hr /> 426 <hr />
427 <hr />
327 <a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a> 428 <a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a>
328 <h2>exeDisplayDataList</h2> 429 <h2>exeDisplayDataList</h2>
329 <b>exeDisplayDataList</b>(<i></i>) 430 <b>exeDisplayDataList</b>(<i></i>)
431
330 <p> 432 <p>
331 Public method to support the display of some executable info. 433 Public method to support the display of some executable info.
332 </p><dl> 434 </p>
435 <dl>
333 <dt>Returns:</dt> 436 <dt>Returns:</dt>
334 <dd> 437 <dd>
335 dictionary containing the data to query the presence of 438 dictionary containing the data to query the presence of
336 the executable 439 the executable
337 </dd> 440 </dd>
338 </dl> 441 </dl>
339 <div align="right"><a href="#top">Up</a></div> 442 <div align="right"><a href="#top">Up</a></div>
340 <hr /><hr /> 443 <hr />
444 <hr />
341 <a NAME="getExePath" ID="getExePath"></a> 445 <a NAME="getExePath" ID="getExePath"></a>
342 <h2>getExePath</h2> 446 <h2>getExePath</h2>
343 <b>getExePath</b>(<i>branch, access, versionStr</i>) 447 <b>getExePath</b>(<i>branch, access, versionStr</i>)
344 448
345 <div align="right"><a href="#top">Up</a></div> 449 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial