Mercurial Repositories > PyLint Checker / file comparison

comparison: PyLint/Documentation/source/Plugin_Checker_PyLint.PluginPyLint.html

PyLint/Documentation/source/Plugin_Checker_PyLint.PluginPyLint.html

changeset 18
ae62d56e345d
child 22
68beeb22dade
equal deleted inserted replaced
17:be64e1afc5c2 18:ae62d56e345d
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Checker_PyLint.PluginPyLint</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background:white;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #4FA4FF; }
13 h2 { color: white; background: #4FA4FF; }
14 h3 { color: white; background: #00557F; }
15 h4 { color: white; background: #00557F; }
16
17 a { color: #AA5500; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>Plugin_Checker_PyLint.PluginPyLint</h1>
23 <p>
24 Module implementing the PyLint plug-in.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
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>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>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#PyLintPlugin">PyLintPlugin</a></td>
34 <td>Class implementing the PyLint plug-in.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr>
40 <td><a href="#_checkProgram">_checkProgram</a></td>
41 <td>Restricted function to check the availability of pylint.</td>
42 </tr><tr>
43 <td><a href="#_findExecutable">_findExecutable</a></td>
44 <td>Restricted function to determine the name and path of the executable.</td>
45 </tr><tr>
46 <td><a href="#exeDisplayData">exeDisplayData</a></td>
47 <td>Public method to support the display of some executable info.</td>
48 </tr><tr>
49 <td><a href="#getExePath">getExePath</a></td>
50 <td></td>
51 </tr>
52 </table>
53 <hr /><hr />
54 <a NAME="PyLintPlugin" ID="PyLintPlugin"></a>
55 <h2>PyLintPlugin</h2>
56 <p>
57 Class implementing the PyLint plug-in.
58 </p>
59 <h3>Derived from</h3>
60 QObject
61 <h3>Class Attributes</h3>
62 <table>
63 <tr><td>None</td></tr>
64 </table>
65 <h3>Class Methods</h3>
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70 <table>
71 <tr>
72 <td><a href="#PyLintPlugin.__init__">PyLintPlugin</a></td>
73 <td>Constructor</td>
74 </tr><tr>
75 <td><a href="#PyLintPlugin.__editorClosed">__editorClosed</a></td>
76 <td>Private slot called, when an editor was closed.</td>
77 </tr><tr>
78 <td><a href="#PyLintPlugin.__editorOpened">__editorOpened</a></td>
79 <td>Private slot called, when a new editor was opened.</td>
80 </tr><tr>
81 <td><a href="#PyLintPlugin.__editorPylint">__editorPylint</a></td>
82 <td>Private slot to handle the Pylint context menu action of the editors.</td>
83 </tr><tr>
84 <td><a href="#PyLintPlugin.__editorShowMenu">__editorShowMenu</a></td>
85 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
86 </tr><tr>
87 <td><a href="#PyLintPlugin.__initialize">__initialize</a></td>
88 <td>Private slot to (re)initialize the plugin.</td>
89 </tr><tr>
90 <td><a href="#PyLintPlugin.__loadTranslator">__loadTranslator</a></td>
91 <td>Private method to load the translation file.</td>
92 </tr><tr>
93 <td><a href="#PyLintPlugin.__projectBrowserPylint">__projectBrowserPylint</a></td>
94 <td>Private method to handle the Pylint context menu action of the project sources browser.</td>
95 </tr><tr>
96 <td><a href="#PyLintPlugin.__projectBrowserPylintShow">__projectBrowserPylintShow</a></td>
97 <td>Public slot to show the PyLint dialog with the results of the last run.</td>
98 </tr><tr>
99 <td><a href="#PyLintPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td>
100 <td>Private slot called, when the the project browser menu or a submenu is about to be shown.</td>
101 </tr><tr>
102 <td><a href="#PyLintPlugin.__projectPylint">__projectPylint</a></td>
103 <td>Public slot used to check the project files with Pylint.</td>
104 </tr><tr>
105 <td><a href="#PyLintPlugin.__projectPylintShow">__projectPylintShow</a></td>
106 <td>Public slot to show the PyLint dialog with the results of the last run.</td>
107 </tr><tr>
108 <td><a href="#PyLintPlugin.__projectShowMenu">__projectShowMenu</a></td>
109 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
110 </tr><tr>
111 <td><a href="#PyLintPlugin.__pyLint">__pyLint</a></td>
112 <td>Private method used to perform a PyLint run.</td>
113 </tr><tr>
114 <td><a href="#PyLintPlugin.activate">activate</a></td>
115 <td>Public method to activate this plugin.</td>
116 </tr><tr>
117 <td><a href="#PyLintPlugin.deactivate">deactivate</a></td>
118 <td>Public method to deactivate this plugin.</td>
119 </tr>
120 </table>
121 <h3>Static Methods</h3>
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125 <a NAME="PyLintPlugin.__init__" ID="PyLintPlugin.__init__"></a>
126 <h4>PyLintPlugin (Constructor)</h4>
127 <b>PyLintPlugin</b>(<i>ui</i>)
128 <p>
129 Constructor
130 </p><dl>
131 <dt><i>ui</i></dt>
132 <dd>
133 reference to the user interface object (UI.UserInterface)
134 </dd>
135 </dl><a NAME="PyLintPlugin.__editorClosed" ID="PyLintPlugin.__editorClosed"></a>
136 <h4>PyLintPlugin.__editorClosed</h4>
137 <b>__editorClosed</b>(<i>editor</i>)
138 <p>
139 Private slot called, when an editor was closed.
140 </p><dl>
141 <dt><i>editor</i></dt>
142 <dd>
143 reference to the editor (QScintilla.Editor)
144 </dd>
145 </dl><a NAME="PyLintPlugin.__editorOpened" ID="PyLintPlugin.__editorOpened"></a>
146 <h4>PyLintPlugin.__editorOpened</h4>
147 <b>__editorOpened</b>(<i>editor</i>)
148 <p>
149 Private slot called, when a new editor was opened.
150 </p><dl>
151 <dt><i>editor</i></dt>
152 <dd>
153 reference to the new editor (QScintilla.Editor)
154 </dd>
155 </dl><a NAME="PyLintPlugin.__editorPylint" ID="PyLintPlugin.__editorPylint"></a>
156 <h4>PyLintPlugin.__editorPylint</h4>
157 <b>__editorPylint</b>(<i></i>)
158 <p>
159 Private slot to handle the Pylint context menu action of the editors.
160 </p><a NAME="PyLintPlugin.__editorShowMenu" ID="PyLintPlugin.__editorShowMenu"></a>
161 <h4>PyLintPlugin.__editorShowMenu</h4>
162 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
163 <p>
164 Private slot called, when the the editor context menu or a submenu is
165 about to be shown.
166 </p><dl>
167 <dt><i>menuName</i></dt>
168 <dd>
169 name of the menu to be shown (string)
170 </dd><dt><i>menu</i></dt>
171 <dd>
172 reference to the menu (QMenu)
173 </dd><dt><i>editor</i></dt>
174 <dd>
175 reference to the editor (QScintilla.Editor)
176 </dd>
177 </dl><a NAME="PyLintPlugin.__initialize" ID="PyLintPlugin.__initialize"></a>
178 <h4>PyLintPlugin.__initialize</h4>
179 <b>__initialize</b>(<i></i>)
180 <p>
181 Private slot to (re)initialize the plugin.
182 </p><a NAME="PyLintPlugin.__loadTranslator" ID="PyLintPlugin.__loadTranslator"></a>
183 <h4>PyLintPlugin.__loadTranslator</h4>
184 <b>__loadTranslator</b>(<i></i>)
185 <p>
186 Private method to load the translation file.
187 </p><a NAME="PyLintPlugin.__projectBrowserPylint" ID="PyLintPlugin.__projectBrowserPylint"></a>
188 <h4>PyLintPlugin.__projectBrowserPylint</h4>
189 <b>__projectBrowserPylint</b>(<i></i>)
190 <p>
191 Private method to handle the Pylint context menu action of the project
192 sources browser.
193 </p><a NAME="PyLintPlugin.__projectBrowserPylintShow" ID="PyLintPlugin.__projectBrowserPylintShow"></a>
194 <h4>PyLintPlugin.__projectBrowserPylintShow</h4>
195 <b>__projectBrowserPylintShow</b>(<i></i>)
196 <p>
197 Public slot to show the PyLint dialog with the results of the last run.
198 </p><a NAME="PyLintPlugin.__projectBrowserShowMenu" ID="PyLintPlugin.__projectBrowserShowMenu"></a>
199 <h4>PyLintPlugin.__projectBrowserShowMenu</h4>
200 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
201 <p>
202 Private slot called, when the the project browser menu or a submenu is
203 about to be shown.
204 </p><dl>
205 <dt><i>menuName</i></dt>
206 <dd>
207 name of the menu to be shown (string)
208 </dd><dt><i>menu</i></dt>
209 <dd>
210 reference to the menu (QMenu)
211 </dd>
212 </dl><a NAME="PyLintPlugin.__projectPylint" ID="PyLintPlugin.__projectPylint"></a>
213 <h4>PyLintPlugin.__projectPylint</h4>
214 <b>__projectPylint</b>(<i></i>)
215 <p>
216 Public slot used to check the project files with Pylint.
217 </p><a NAME="PyLintPlugin.__projectPylintShow" ID="PyLintPlugin.__projectPylintShow"></a>
218 <h4>PyLintPlugin.__projectPylintShow</h4>
219 <b>__projectPylintShow</b>(<i></i>)
220 <p>
221 Public slot to show the PyLint dialog with the results of the last run.
222 </p><a NAME="PyLintPlugin.__projectShowMenu" ID="PyLintPlugin.__projectShowMenu"></a>
223 <h4>PyLintPlugin.__projectShowMenu</h4>
224 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
225 <p>
226 Private slot called, when the the project menu or a submenu is
227 about to be shown.
228 </p><dl>
229 <dt><i>menuName</i></dt>
230 <dd>
231 name of the menu to be shown (string)
232 </dd><dt><i>menu</i></dt>
233 <dd>
234 reference to the menu (QMenu)
235 </dd>
236 </dl><a NAME="PyLintPlugin.__pyLint" ID="PyLintPlugin.__pyLint"></a>
237 <h4>PyLintPlugin.__pyLint</h4>
238 <b>__pyLint</b>(<i>project, mpName, forProject, forEditor=False</i>)
239 <p>
240 Private method used to perform a PyLint run.
241 </p><dl>
242 <dt><i>project</i></dt>
243 <dd>
244 reference to the Project object
245 </dd><dt><i>mpName</i></dt>
246 <dd>
247 name of module or package to be checked (string)
248 </dd><dt><i>forProject</i></dt>
249 <dd>
250 flag indicating a run for the project (boolean)
251 </dd>
252 </dl><a NAME="PyLintPlugin.activate" ID="PyLintPlugin.activate"></a>
253 <h4>PyLintPlugin.activate</h4>
254 <b>activate</b>(<i></i>)
255 <p>
256 Public method to activate this plugin.
257 </p><dl>
258 <dt>Returns:</dt>
259 <dd>
260 tuple of None and activation status (boolean)
261 </dd>
262 </dl><a NAME="PyLintPlugin.deactivate" ID="PyLintPlugin.deactivate"></a>
263 <h4>PyLintPlugin.deactivate</h4>
264 <b>deactivate</b>(<i></i>)
265 <p>
266 Public method to deactivate this plugin.
267 </p>
268 <div align="right"><a href="#top">Up</a></div>
269 <hr /><hr />
270 <a NAME="_checkProgram" ID="_checkProgram"></a>
271 <h2>_checkProgram</h2>
272 <b>_checkProgram</b>(<i></i>)
273 <p>
274 Restricted function to check the availability of pylint.
275 </p><dl>
276 <dt>Returns:</dt>
277 <dd>
278 flag indicating availability (boolean)
279 </dd>
280 </dl>
281 <div align="right"><a href="#top">Up</a></div>
282 <hr /><hr />
283 <a NAME="_findExecutable" ID="_findExecutable"></a>
284 <h2>_findExecutable</h2>
285 <b>_findExecutable</b>(<i></i>)
286 <p>
287 Restricted function to determine the name and path of the executable.
288 </p><dl>
289 <dt>Returns:</dt>
290 <dd>
291 path name of the executable (string)
292 </dd>
293 </dl>
294 <div align="right"><a href="#top">Up</a></div>
295 <hr /><hr />
296 <a NAME="exeDisplayData" ID="exeDisplayData"></a>
297 <h2>exeDisplayData</h2>
298 <b>exeDisplayData</b>(<i></i>)
299 <p>
300 Public method to support the display of some executable info.
301 </p><dl>
302 <dt>Returns:</dt>
303 <dd>
304 dictionary containing the data to query the presence of
305 the executable
306 </dd>
307 </dl>
308 <div align="right"><a href="#top">Up</a></div>
309 <hr /><hr />
310 <a NAME="getExePath" ID="getExePath"></a>
311 <h2>getExePath</h2>
312 <b>getExePath</b>(<i>branch</i>)
313
314 <div align="right"><a href="#top">Up</a></div>
315 <hr />
316 </body></html>

Mercurial Repository: PyLint Checker

eric ide

mercurial