PyLint Checker: comparison PyLintInterface/Documentation/source/Plugin_Checker

-:71d3a2e48265
+:f8955e5dba87
 <link rel="stylesheet" href="styles.css">
 </head>
 <body>
 <a NAME="top" ID="top"></a>
 <h1>Plugin_Checker_PyLint.PluginPyLint</h1>
 <p>
 Module implementing the PyLint plug-in.
 </p>
 <h3>Global Attributes</h3>
+<table>
-<table>
+<tr><td>__header__</td></tr>
-<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>
+<tr><td>error</td></tr>
-</table>
+<tr><td>exePy3</td></tr>
+</table>
 <h3>Classes</h3>
+<table>
-<table>
 <tr>
 <td><a href="#PyLintPlugin">PyLintPlugin</a></td>
 <td>Class implementing the PyLint plug-in.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+<table>
-<table>
 <tr>
 <td><a href="#__getProgramVersion">__getProgramVersion</a></td>
 <td>Private method to generate a program entry.</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#installDependencies">installDependencies</a></td>
 <td>Function to install dependencies of this plug-in.</td>
 </tr>
 </table>
 <hr />
 <hr />
 <a NAME="PyLintPlugin" ID="PyLintPlugin"></a>
 <h2>PyLintPlugin</h2>
 <p>
 Class implementing the PyLint plug-in.
 </p>
 <h3>Derived from</h3>
 QObject
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+<table>
-<table>
 <tr>
 <td><a href="#PyLintPlugin.__init__">PyLintPlugin</a></td>
 <td>Constructor</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#PyLintPlugin.deactivate">deactivate</a></td>
 <td>Public method to deactivate this plugin.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="PyLintPlugin.__init__" ID="PyLintPlugin.__init__"></a>
 <h4>PyLintPlugin (Constructor)</h4>
 <b>PyLintPlugin</b>(<i>ui</i>)
 <p>
 Constructor
 </p>
 <dl>
 <dt><i>ui</i> (UserInterface)</dt>
 <dd>
 reference to the user interface object
 </dd>
 </dl>
 <a NAME="PyLintPlugin.__editorClosed" ID="PyLintPlugin.__editorClosed"></a>
 <h4>PyLintPlugin.__editorClosed</h4>
 <b>__editorClosed</b>(<i>editor</i>)
 <p>
 Private slot called, when an editor was closed.
 </p>
 <dl>
 <dt><i>editor</i> (Editor)</dt>
 <dd>
 reference to the editor
 </dd>
 </dl>
 <a NAME="PyLintPlugin.__editorOpened" ID="PyLintPlugin.__editorOpened"></a>
 <h4>PyLintPlugin.__editorOpened</h4>
 <b>__editorOpened</b>(<i>editor</i>)
 <p>
 Private slot called, when a new editor was opened.
 </p>
 <dl>
 <dt><i>editor</i> (Editor)</dt>
 <dd>
 reference to the new editor
 </dd>
 </dl>
 <a NAME="PyLintPlugin.__editorPylint" ID="PyLintPlugin.__editorPylint"></a>
 <h4>PyLintPlugin.__editorPylint</h4>
 <b>__editorPylint</b>(<i></i>)
 <p>
 Private slot to handle the Pylint context menu action of the editors.
 </p>
 <a NAME="PyLintPlugin.__editorShowMenu" ID="PyLintPlugin.__editorShowMenu"></a>
 <h4>PyLintPlugin.__editorShowMenu</h4>
 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
 <p>
 Private slot called, when the the editor context menu or a submenu is
 about to be shown.
 </p>
 <dl>
 <dt><i>menuName</i> (str)</dt>
 <dd>
 name of the menu to be shown
 </dd>
 </dl>
 <a NAME="PyLintPlugin.__initialize" ID="PyLintPlugin.__initialize"></a>
 <h4>PyLintPlugin.__initialize</h4>
 <b>__initialize</b>(<i></i>)
 <p>
 Private slot to (re)initialize the plugin.
 </p>
 <a NAME="PyLintPlugin.__loadTranslator" ID="PyLintPlugin.__loadTranslator"></a>
 <h4>PyLintPlugin.__loadTranslator</h4>
 <b>__loadTranslator</b>(<i></i>)
 <p>
 Private method to load the translation file.
 </p>
 <a NAME="PyLintPlugin.__projectBrowserPylint" ID="PyLintPlugin.__projectBrowserPylint"></a>
 <h4>PyLintPlugin.__projectBrowserPylint</h4>
 <b>__projectBrowserPylint</b>(<i></i>)
 <p>
 Private method to handle the Pylint context menu action of the project
 sources browser.
 </p>
 <a NAME="PyLintPlugin.__projectBrowserPylintShow" ID="PyLintPlugin.__projectBrowserPylintShow"></a>
 <h4>PyLintPlugin.__projectBrowserPylintShow</h4>
 <b>__projectBrowserPylintShow</b>(<i></i>)
 <p>
 Private slot to show the PyLint dialog with the results of the last
 run.
 </p>
 <a NAME="PyLintPlugin.__projectBrowserShowMenu" ID="PyLintPlugin.__projectBrowserShowMenu"></a>
 <h4>PyLintPlugin.__projectBrowserShowMenu</h4>
 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
 <p>
 Private slot called, when the the project browser menu or a submenu is
 about to be shown.
 </p>
 <dl>
 <dt><i>menuName</i> (str)</dt>
 <dd>
 name of the menu to be shown
 </dd>
 </dl>
 <a NAME="PyLintPlugin.__projectPylint" ID="PyLintPlugin.__projectPylint"></a>
 <h4>PyLintPlugin.__projectPylint</h4>
 <b>__projectPylint</b>(<i></i>)
 <p>
 Private slot used to check the project files with Pylint.
 </p>
 <a NAME="PyLintPlugin.__projectPylintShow" ID="PyLintPlugin.__projectPylintShow"></a>
 <h4>PyLintPlugin.__projectPylintShow</h4>
 <b>__projectPylintShow</b>(<i></i>)
 <p>
 Private slot to show the PyLint dialog with the results of the last
 run.
 </p>
 <a NAME="PyLintPlugin.__projectShowMenu" ID="PyLintPlugin.__projectShowMenu"></a>
 <h4>PyLintPlugin.__projectShowMenu</h4>
 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
 <p>
 Private slot called, when the the project menu or a submenu is
 about to be shown.
 </p>
 <dl>
 <dt><i>menuName</i> (str)</dt>
 <dd>
 name of the menu to be shown
 </dd>
 </dl>
 <a NAME="PyLintPlugin.__pyLint" ID="PyLintPlugin.__pyLint"></a>
 <h4>PyLintPlugin.__pyLint</h4>
 <b>__pyLint</b>(<i>project, mpName, forProject, forEditor=False</i>)
 <p>
 Private method used to perform a PyLint run.
 </p>
 <dl>
 <dt><i>project</i> (Project)</dt>
 <dd>
 reference to the Project object
 </dd>
 </dl>
 <a NAME="PyLintPlugin.activate" ID="PyLintPlugin.activate"></a>
 <h4>PyLintPlugin.activate</h4>
 <b>activate</b>(<i></i>)
 <p>
 Public method to activate this plugin.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 tuple of None and activation status
 </dd>
 </dd>
 </dl>
 <a NAME="PyLintPlugin.deactivate" ID="PyLintPlugin.deactivate"></a>
 <h4>PyLintPlugin.deactivate</h4>
 <b>deactivate</b>(<i></i>)
 <p>
 Public method to deactivate this plugin.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="__getProgramVersion" ID="__getProgramVersion"></a>
 <h2>__getProgramVersion</h2>
 <b>__getProgramVersion</b>(<i>exe</i>)
 <p>
 Private method to generate a program entry.
 </p>
 <dl>
 <dt><i>exe</i> (str)</dt>
 <dd>
 name of the executable program
 <hr />
 <hr />
 <a NAME="_checkProgram" ID="_checkProgram"></a>
 <h2>_checkProgram</h2>
 <b>_checkProgram</b>(<i></i>)
 <p>
 Restricted function to check the availability of pylint.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 flag indicating availability
 </dd>
 <hr />
 <hr />
 <a NAME="_findExecutable" ID="_findExecutable"></a>
 <h2>_findExecutable</h2>
 <b>_findExecutable</b>(<i>majorVersion</i>)
 <p>
 Restricted function to determine the name and path of the executable.
 </p>
 <dl>
 <dt><i>majorVersion</i> (int)</dt>
 <dd>
 major python version of the executables
 <hr />
 <hr />
 <a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a>
 <h2>exeDisplayDataList</h2>
 <b>exeDisplayDataList</b>(<i></i>)
 <p>
 Public method to support the display of some executable info.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 list of dictionaries containing the data to query the presence of
 the executable
 <hr />
 <hr />
 <a NAME="installDependencies" ID="installDependencies"></a>
 <h2>installDependencies</h2>
 <b>installDependencies</b>(<i>pipInstall</i>)
 <p>
 Function to install dependencies of this plug-in.
 </p>
 <dl>
 <dt><i>pipInstall</i> (function)</dt>
 <dd>
 function to be called with a list of package names.

Mercurial Repositories > PyLint Checker / file comparison

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

PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PluginPyLint.html