Mercurial Repositories > PyLint Checker / changeset
changeset
Updated version info to indicate relation to eric7.
Thu, 30 Dec 2021 11:37:27 +0100
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Thu, 30 Dec 2021 11:37:27 +0100
- branch
- eric7
- changeset 102
- e40ecfd9ec37
- parent 101
- 98784d037491
- child 103
- 9745b386ff7b
Updated version info to indicate relation to eric7.
--- a/ChangeLog Thu Dec 30 11:19:55 2021 +0100 +++ b/ChangeLog Thu Dec 30 11:37:27 2021 +0100 @@ -1,6 +1,6 @@ ChangeLog --------- -Version 1.0.0: +Version 10.0.0: - first release of the eric7 variant ************************************************************
--- a/PluginPyLint.py Thu Dec 30 11:19:55 2021 +0100 +++ b/PluginPyLint.py Thu Dec 30 11:37:27 2021 +0100 @@ -30,7 +30,7 @@ author = "Detlev Offenbach <detlev@die-offenbachs.de>" autoactivate = True deactivateable = True -version = "1.0.0" +version = "10.0.0" className = "PyLintPlugin" packageName = "PyLintInterface" shortDescription = "Show the PyLint dialogs."
--- a/PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PluginPyLint.html Thu Dec 30 11:19:55 2021 +0100 +++ b/PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PluginPyLint.html Thu Dec 30 11:37:27 2021 +0100 @@ -2,21 +2,7 @@ <html><head> <title>Plugin_Checker_PyLint.PluginPyLint</title> <meta charset="UTF-8"> -<style> -body { - background: #EDECE6; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #85774A; } -h2 { color: white; background: #85774A; } -h3 { color: white; background: #9D936E; } -h4 { color: white; background: #9D936E; } - -a { color: #BA6D36; } - -</style> +<link rel="stylesheet" href="styles.css"> </head> <body> <a NAME="top" ID="top"></a>
--- a/PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLint.PyLintConfigDialog.html Thu Dec 30 11:19:55 2021 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,254 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>Plugin_Checker_PyLint.PyLint.PyLintConfigDialog</title> -<meta charset="UTF-8"> -<style> -body { - background: #EDECE6; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #85774A; } -h2 { color: white; background: #85774A; } -h3 { color: white; background: #9D936E; } -h4 { color: white; background: #9D936E; } - -a { color: #BA6D36; } - -</style> -</head> -<body> -<a NAME="top" ID="top"></a> -<h1>Plugin_Checker_PyLint.PyLint.PyLintConfigDialog</h1> - -<p> -Module implementing a dialog to configure the PyLint process. -</p> -<h3>Global Attributes</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> - -<table> - -<tr> -<td><a href="#PyLintConfigDialog">PyLintConfigDialog</a></td> -<td>Class implementing a dialog to configure the PyLint process.</td> -</tr> -</table> -<h3>Functions</h3> - -<table> -<tr><td>None</td></tr> -</table> -<hr /> -<hr /> -<a NAME="PyLintConfigDialog" ID="PyLintConfigDialog"></a> -<h2>PyLintConfigDialog</h2> - -<p> - Class implementing a dialog to configure the PyLint process. -</p> -<h3>Derived from</h3> -QDialog, Ui_PyLintConfigDialog -<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> - -<tr> -<td><a href="#PyLintConfigDialog.__init__">PyLintConfigDialog</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#PyLintConfigDialog.__createConfigDone">__createConfigDone</a></td> -<td>Private slot to handle the the finished signal of the pylint process.</td> -</tr> -<tr> -<td><a href="#PyLintConfigDialog.__initializeDefaults">__initializeDefaults</a></td> -<td>Private method to set the default values.</td> -</tr> -<tr> -<td><a href="#PyLintConfigDialog.__readStderr">__readStderr</a></td> -<td>Private slot to handle the readyReadStandardError signal of the pylint process.</td> -</tr> -<tr> -<td><a href="#PyLintConfigDialog.__readStdout">__readStdout</a></td> -<td>Private slot to handle the readyReadStandardOutput signal of the pylint process.</td> -</tr> -<tr> -<td><a href="#PyLintConfigDialog.accept">accept</a></td> -<td>Public slot called by the Ok button.</td> -</tr> -<tr> -<td><a href="#PyLintConfigDialog.generateParameters">generateParameters</a></td> -<td>Public method that generates the commandline parameters.</td> -</tr> -<tr> -<td><a href="#PyLintConfigDialog.on_configButton_clicked">on_configButton_clicked</a></td> -<td>Private slot to handle the generation of a sample configuration.</td> -</tr> -<tr> -<td><a href="#PyLintConfigDialog.on_configfileButton_clicked">on_configfileButton_clicked</a></td> -<td>Private slot to select the configuration file.</td> -</tr> -<tr> -<td><a href="#PyLintConfigDialog.on_reportfileButton_clicked">on_reportfileButton_clicked</a></td> -<td>Private slot to select the report file.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> - -<a NAME="PyLintConfigDialog.__init__" ID="PyLintConfigDialog.__init__"></a> -<h4>PyLintConfigDialog (Constructor)</h4> -<b>PyLintConfigDialog</b>(<i>ppath, exe, parms, version</i>) - -<p> - Constructor -</p> -<dl> - -<dt><i>ppath</i></dt> -<dd> -project path (string or QString) - Used to set the default path for the rcfile selection dialog -</dd> -<dt><i>exe</i></dt> -<dd> -name of the pylint executable (string) -</dd> -<dt><i>parms</i></dt> -<dd> -parameters to set in the dialog -</dd> -<dt><i>version</i></dt> -<dd> -pylint version (string) -</dd> -</dl> -<a NAME="PyLintConfigDialog.__createConfigDone" ID="PyLintConfigDialog.__createConfigDone"></a> -<h4>PyLintConfigDialog.__createConfigDone</h4> -<b>__createConfigDone</b>(<i>exitCode, exitStatus</i>) - -<p> - Private slot to handle the the finished signal of the pylint process. -</p> -<dl> - -<dt><i>exitCode</i></dt> -<dd> -exit code of the process (integer) -</dd> -<dt><i>exitStatus</i></dt> -<dd> -exit status of the process (QProcess.ExitStatus) -</dd> -</dl> -<a NAME="PyLintConfigDialog.__initializeDefaults" ID="PyLintConfigDialog.__initializeDefaults"></a> -<h4>PyLintConfigDialog.__initializeDefaults</h4> -<b>__initializeDefaults</b>(<i></i>) - -<p> - Private method to set the default values. -</p> -<p> - These are needed later on to generate the commandline - parameters. -</p> -<a NAME="PyLintConfigDialog.__readStderr" ID="PyLintConfigDialog.__readStderr"></a> -<h4>PyLintConfigDialog.__readStderr</h4> -<b>__readStderr</b>(<i></i>) - -<p> - Private slot to handle the readyReadStandardError signal of the - pylint process. -</p> -<a NAME="PyLintConfigDialog.__readStdout" ID="PyLintConfigDialog.__readStdout"></a> -<h4>PyLintConfigDialog.__readStdout</h4> -<b>__readStdout</b>(<i></i>) - -<p> - Private slot to handle the readyReadStandardOutput signal of the - pylint process. -</p> -<a NAME="PyLintConfigDialog.accept" ID="PyLintConfigDialog.accept"></a> -<h4>PyLintConfigDialog.accept</h4> -<b>accept</b>(<i></i>) - -<p> - Public slot called by the Ok button. -</p> -<p> - It saves the values in the parameters dictionary. -</p> -<a NAME="PyLintConfigDialog.generateParameters" ID="PyLintConfigDialog.generateParameters"></a> -<h4>PyLintConfigDialog.generateParameters</h4> -<b>generateParameters</b>(<i></i>) - -<p> - Public method that generates the commandline parameters. -</p> -<p> - It generates a QStringList to be used - to set the QProcess arguments for the pylint call and - a list containing the non default parameters. The second - list can be passed back upon object generation to overwrite - the default settings. -</p> -<p> - <b>Note</b>: The arguments list contains the name of the pylint - executable as the first parameter. -</p> -<dl> -<dt>Return:</dt> -<dd> -a tuple of the commandline parameters and non default - parameters (list of strings, dictionary) -</dd> -</dl> -<a NAME="PyLintConfigDialog.on_configButton_clicked" ID="PyLintConfigDialog.on_configButton_clicked"></a> -<h4>PyLintConfigDialog.on_configButton_clicked</h4> -<b>on_configButton_clicked</b>(<i></i>) - -<p> - Private slot to handle the generation of a sample configuration. -</p> -<a NAME="PyLintConfigDialog.on_configfileButton_clicked" ID="PyLintConfigDialog.on_configfileButton_clicked"></a> -<h4>PyLintConfigDialog.on_configfileButton_clicked</h4> -<b>on_configfileButton_clicked</b>(<i></i>) - -<p> - Private slot to select the configuration file. -</p> -<p> - It displays a file selection dialog to select the configuration file. -</p> -<a NAME="PyLintConfigDialog.on_reportfileButton_clicked" ID="PyLintConfigDialog.on_reportfileButton_clicked"></a> -<h4>PyLintConfigDialog.on_reportfileButton_clicked</h4> -<b>on_reportfileButton_clicked</b>(<i></i>) - -<p> - Private slot to select the report file. -</p> -<p> - It displays a file selection dialog to select the report file. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file
--- a/PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLint.PyLintExecDialog.html Thu Dec 30 11:19:55 2021 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,303 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>Plugin_Checker_PyLint.PyLint.PyLintExecDialog</title> -<meta charset="UTF-8"> -<style> -body { - background: #EDECE6; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #85774A; } -h2 { color: white; background: #85774A; } -h3 { color: white; background: #9D936E; } -h4 { color: white; background: #9D936E; } - -a { color: #BA6D36; } - -</style> -</head> -<body> -<a NAME="top" ID="top"></a> -<h1>Plugin_Checker_PyLint.PyLint.PyLintExecDialog</h1> - -<p> -Module implementing a dialog to show the results of the PyLint run. -</p> -<h3>Global Attributes</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> - -<table> - -<tr> -<td><a href="#PyLintExecDialog">PyLintExecDialog</a></td> -<td>Class implementing a dialog to show the results of the PyLint run.</td> -</tr> -</table> -<h3>Functions</h3> - -<table> -<tr><td>None</td></tr> -</table> -<hr /> -<hr /> -<a NAME="PyLintExecDialog" ID="PyLintExecDialog"></a> -<h2>PyLintExecDialog</h2> - -<p> - Class implementing a dialog to show the results of the PyLint run. -</p> -<p> - This class starts a QProcess and displays a dialog that - shows the results of the PyLint command process. -</p> -<h3>Derived from</h3> -QWidget, Ui_PyLintExecDialog -<h3>Class Attributes</h3> - -<table> -<tr><td>filenameRole</td></tr> -</table> -<h3>Class Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Methods</h3> - -<table> - -<tr> -<td><a href="#PyLintExecDialog.__init__">PyLintExecDialog</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#PyLintExecDialog.__createItem">__createItem</a></td> -<td>Private method to create an entry in the message list.</td> -</tr> -<tr> -<td><a href="#PyLintExecDialog.__finish">__finish</a></td> -<td>Private slot called when the process finished.</td> -</tr> -<tr> -<td><a href="#PyLintExecDialog.__readParseStdout">__readParseStdout</a></td> -<td>Private slot to handle the readyReadStandardOutput signal for parseable output.</td> -</tr> -<tr> -<td><a href="#PyLintExecDialog.__readStderr">__readStderr</a></td> -<td>Private slot to handle the readyReadStandardError signal.</td> -</tr> -<tr> -<td><a href="#PyLintExecDialog.__readStdout">__readStdout</a></td> -<td>Private slot to handle the readyReadStandardOutput signal.</td> -</tr> -<tr> -<td><a href="#PyLintExecDialog.__writeReport">__writeReport</a></td> -<td>Private slot to write the report to a report file.</td> -</tr> -<tr> -<td><a href="#PyLintExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> -<td>Private slot called by a button of the button box clicked.</td> -</tr> -<tr> -<td><a href="#PyLintExecDialog.on_messageList_itemActivated">on_messageList_itemActivated</a></td> -<td>Private slot to handle the itemActivated signal of the message list.</td> -</tr> -<tr> -<td><a href="#PyLintExecDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> -<td>Private slot to refresh the status display.</td> -</tr> -<tr> -<td><a href="#PyLintExecDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> -<td>Private slot to save the report to a file.</td> -</tr> -<tr> -<td><a href="#PyLintExecDialog.start">start</a></td> -<td>Public slot to start PyLint.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> - -<a NAME="PyLintExecDialog.__init__" ID="PyLintExecDialog.__init__"></a> -<h4>PyLintExecDialog (Constructor)</h4> -<b>PyLintExecDialog</b>(<i>parent=None</i>) - -<p> - Constructor -</p> -<dl> - -<dt><i>parent</i></dt> -<dd> -parent widget of this dialog (QWidget) -</dd> -</dl> -<a NAME="PyLintExecDialog.__createItem" ID="PyLintExecDialog.__createItem"></a> -<h4>PyLintExecDialog.__createItem</h4> -<b>__createItem</b>(<i>file, line, type_, message</i>) - -<p> - Private method to create an entry in the message list. -</p> -<dl> - -<dt><i>file</i></dt> -<dd> -filename of file (string) -</dd> -<dt><i>line</i></dt> -<dd> -linenumber of message (integer or string) -</dd> -<dt><i>type_</i></dt> -<dd> -type of message (string) -</dd> -<dt><i>message</i></dt> -<dd> -message text (string) -</dd> -</dl> -<a NAME="PyLintExecDialog.__finish" ID="PyLintExecDialog.__finish"></a> -<h4>PyLintExecDialog.__finish</h4> -<b>__finish</b>(<i></i>) - -<p> - Private slot called when the process finished. -</p> -<p> - It is called when the process finished or - the user pressed the button. -</p> -<a NAME="PyLintExecDialog.__readParseStdout" ID="PyLintExecDialog.__readParseStdout"></a> -<h4>PyLintExecDialog.__readParseStdout</h4> -<b>__readParseStdout</b>(<i></i>) - -<p> - Private slot to handle the readyReadStandardOutput signal for - parseable output. -</p> -<p> - It reads the output of the process, formats it and inserts it into - the message list pane. -</p> -<a NAME="PyLintExecDialog.__readStderr" ID="PyLintExecDialog.__readStderr"></a> -<h4>PyLintExecDialog.__readStderr</h4> -<b>__readStderr</b>(<i></i>) - -<p> - Private slot to handle the readyReadStandardError signal. -</p> -<p> - It reads the error output of the process and inserts it into the - error pane. -</p> -<a NAME="PyLintExecDialog.__readStdout" ID="PyLintExecDialog.__readStdout"></a> -<h4>PyLintExecDialog.__readStdout</h4> -<b>__readStdout</b>(<i></i>) - -<p> - Private slot to handle the readyReadStandardOutput signal. -</p> -<p> - It reads the output of the process, formats it and inserts it into - the contents pane. -</p> -<a NAME="PyLintExecDialog.__writeReport" ID="PyLintExecDialog.__writeReport"></a> -<h4>PyLintExecDialog.__writeReport</h4> -<b>__writeReport</b>(<i></i>) - -<p> - Private slot to write the report to a report file. -</p> -<a NAME="PyLintExecDialog.on_buttonBox_clicked" ID="PyLintExecDialog.on_buttonBox_clicked"></a> -<h4>PyLintExecDialog.on_buttonBox_clicked</h4> -<b>on_buttonBox_clicked</b>(<i>button</i>) - -<p> - Private slot called by a button of the button box clicked. -</p> -<dl> - -<dt><i>button</i></dt> -<dd> -button that was clicked (QAbstractButton) -</dd> -</dl> -<a NAME="PyLintExecDialog.on_messageList_itemActivated" ID="PyLintExecDialog.on_messageList_itemActivated"></a> -<h4>PyLintExecDialog.on_messageList_itemActivated</h4> -<b>on_messageList_itemActivated</b>(<i>itm, column</i>) - -<p> - Private slot to handle the itemActivated signal of the message list. -</p> -<dl> - -<dt><i>itm</i></dt> -<dd> -The message item that was activated (QTreeWidgetItem) -</dd> -<dt><i>column</i></dt> -<dd> -column the item was activated in (integer) -</dd> -</dl> -<a NAME="PyLintExecDialog.on_refreshButton_clicked" ID="PyLintExecDialog.on_refreshButton_clicked"></a> -<h4>PyLintExecDialog.on_refreshButton_clicked</h4> -<b>on_refreshButton_clicked</b>(<i></i>) - -<p> - Private slot to refresh the status display. -</p> -<a NAME="PyLintExecDialog.on_saveButton_clicked" ID="PyLintExecDialog.on_saveButton_clicked"></a> -<h4>PyLintExecDialog.on_saveButton_clicked</h4> -<b>on_saveButton_clicked</b>(<i></i>) - -<p> - Private slot to save the report to a file. -</p> -<a NAME="PyLintExecDialog.start" ID="PyLintExecDialog.start"></a> -<h4>PyLintExecDialog.start</h4> -<b>start</b>(<i>args, fn, reportFile, ppath</i>) - -<p> - Public slot to start PyLint. -</p> -<dl> - -<dt><i>args</i></dt> -<dd> -commandline arguments for documentation programPyLint - (list of strings) -</dd> -<dt><i>fn</i></dt> -<dd> -filename or dirname to be processed by PyLint (string) -</dd> -<dt><i>reportFile</i></dt> -<dd> -filename of file to write the report to (string) -</dd> -<dt><i>ppath</i></dt> -<dd> -project path (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating the successful start of the process (boolean) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog.html Thu Dec 30 11:37:27 2021 +0100 @@ -0,0 +1,218 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog</h1> + +<p> +Module implementing a dialog to configure the PyLint process. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#PyLintConfigDialog">PyLintConfigDialog</a></td> +<td>Class implementing a dialog to configure the PyLint process.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="PyLintConfigDialog" ID="PyLintConfigDialog"></a> +<h2>PyLintConfigDialog</h2> + +<p> + Class implementing a dialog to configure the PyLint process. +</p> +<h3>Derived from</h3> +QDialog, Ui_PyLintConfigDialog +<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> + +<tr> +<td><a href="#PyLintConfigDialog.__init__">PyLintConfigDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#PyLintConfigDialog.__createConfigDone">__createConfigDone</a></td> +<td>Private slot to handle the the finished signal of the pylint process.</td> +</tr> +<tr> +<td><a href="#PyLintConfigDialog.__initializeDefaults">__initializeDefaults</a></td> +<td>Private method to set the default values.</td> +</tr> +<tr> +<td><a href="#PyLintConfigDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal of the pylint process.</td> +</tr> +<tr> +<td><a href="#PyLintConfigDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal of the pylint process.</td> +</tr> +<tr> +<td><a href="#PyLintConfigDialog.accept">accept</a></td> +<td>Public slot called by the Ok button.</td> +</tr> +<tr> +<td><a href="#PyLintConfigDialog.generateParameters">generateParameters</a></td> +<td>Public method that generates the commandline parameters.</td> +</tr> +<tr> +<td><a href="#PyLintConfigDialog.on_configButton_clicked">on_configButton_clicked</a></td> +<td>Private slot to handle the generation of a sample configuration.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="PyLintConfigDialog.__init__" ID="PyLintConfigDialog.__init__"></a> +<h4>PyLintConfigDialog (Constructor)</h4> +<b>PyLintConfigDialog</b>(<i>ppath, exe, parms, version</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>ppath</i> (str)</dt> +<dd> +project path; used to set the default path for the + rcfile picker +</dd> +<dt><i>exe</i> (str)</dt> +<dd> +name of the pylint executable +</dd> +<dt><i>parms</i> (dict)</dt> +<dd> +parameters to set in the dialog +</dd> +<dt><i>version</i> (str)</dt> +<dd> +pylint version (unused) +</dd> +</dl> +<a NAME="PyLintConfigDialog.__createConfigDone" ID="PyLintConfigDialog.__createConfigDone"></a> +<h4>PyLintConfigDialog.__createConfigDone</h4> +<b>__createConfigDone</b>(<i>exitCode, exitStatus</i>) + +<p> + Private slot to handle the the finished signal of the pylint process. +</p> +<dl> + +<dt><i>exitCode</i> (int)</dt> +<dd> +exit code of the process +</dd> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> +<dd> +exit status of the process +</dd> +</dl> +<a NAME="PyLintConfigDialog.__initializeDefaults" ID="PyLintConfigDialog.__initializeDefaults"></a> +<h4>PyLintConfigDialog.__initializeDefaults</h4> +<b>__initializeDefaults</b>(<i></i>) + +<p> + Private method to set the default values. +</p> +<p> + These are needed later on to generate the commandline + parameters. +</p> +<a NAME="PyLintConfigDialog.__readStderr" ID="PyLintConfigDialog.__readStderr"></a> +<h4>PyLintConfigDialog.__readStderr</h4> +<b>__readStderr</b>(<i></i>) + +<p> + Private slot to handle the readyReadStandardError signal of the + pylint process. +</p> +<a NAME="PyLintConfigDialog.__readStdout" ID="PyLintConfigDialog.__readStdout"></a> +<h4>PyLintConfigDialog.__readStdout</h4> +<b>__readStdout</b>(<i></i>) + +<p> + Private slot to handle the readyReadStandardOutput signal of the + pylint process. +</p> +<a NAME="PyLintConfigDialog.accept" ID="PyLintConfigDialog.accept"></a> +<h4>PyLintConfigDialog.accept</h4> +<b>accept</b>(<i></i>) + +<p> + Public slot called by the Ok button. +</p> +<p> + It saves the values in the parameters dictionary. +</p> +<a NAME="PyLintConfigDialog.generateParameters" ID="PyLintConfigDialog.generateParameters"></a> +<h4>PyLintConfigDialog.generateParameters</h4> +<b>generateParameters</b>(<i></i>) + +<p> + Public method that generates the commandline parameters. +</p> +<p> + It generates a list of strings to be used + to set the QProcess arguments for the pylint call and + a list containing the non default parameters. The second + list can be passed back upon object generation to overwrite + the default settings. +</p> +<p> + <b>Note</b>: The arguments list contains the name of the pylint + executable as the first parameter. +</p> +<dl> +<dt>Return:</dt> +<dd> +a tuple of the commandline parameters and non default + parameters +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, dict) +</dd> +</dl> +<a NAME="PyLintConfigDialog.on_configButton_clicked" ID="PyLintConfigDialog.on_configButton_clicked"></a> +<h4>PyLintConfigDialog.on_configButton_clicked</h4> +<b>on_configButton_clicked</b>(<i></i>) + +<p> + Private slot to handle the generation of a sample configuration. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog.html Thu Dec 30 11:37:27 2021 +0100 @@ -0,0 +1,293 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog</h1> + +<p> +Module implementing a dialog to show the results of the PyLint run. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#PyLintExecDialog">PyLintExecDialog</a></td> +<td>Class implementing a dialog to show the results of the PyLint run.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="PyLintExecDialog" ID="PyLintExecDialog"></a> +<h2>PyLintExecDialog</h2> + +<p> + Class implementing a dialog to show the results of the PyLint run. +</p> +<p> + This class starts a QProcess and displays a dialog that + shows the results of the PyLint command process. +</p> +<h3>Derived from</h3> +QWidget, Ui_PyLintExecDialog +<h3>Class Attributes</h3> + +<table> +<tr><td>filenameRole</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#PyLintExecDialog.__init__">PyLintExecDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#PyLintExecDialog.__createItem">__createItem</a></td> +<td>Private method to create an entry in the message list.</td> +</tr> +<tr> +<td><a href="#PyLintExecDialog.__finish">__finish</a></td> +<td>Private slot called when the process finished.</td> +</tr> +<tr> +<td><a href="#PyLintExecDialog.__readParseStdout">__readParseStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal for parseable output.</td> +</tr> +<tr> +<td><a href="#PyLintExecDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr> +<tr> +<td><a href="#PyLintExecDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr> +<tr> +<td><a href="#PyLintExecDialog.__writeReport">__writeReport</a></td> +<td>Private slot to write the report to a report file.</td> +</tr> +<tr> +<td><a href="#PyLintExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr> +<tr> +<td><a href="#PyLintExecDialog.on_messageList_itemActivated">on_messageList_itemActivated</a></td> +<td>Private slot to handle the itemActivated signal of the message list.</td> +</tr> +<tr> +<td><a href="#PyLintExecDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> +<td>Private slot to refresh the status display.</td> +</tr> +<tr> +<td><a href="#PyLintExecDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> +<td>Private slot to save the report to a file.</td> +</tr> +<tr> +<td><a href="#PyLintExecDialog.start">start</a></td> +<td>Public slot to start PyLint.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="PyLintExecDialog.__init__" ID="PyLintExecDialog.__init__"></a> +<h4>PyLintExecDialog (Constructor)</h4> +<b>PyLintExecDialog</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QWidget)</dt> +<dd> +parent widget of this dialog +</dd> +</dl> +<a NAME="PyLintExecDialog.__createItem" ID="PyLintExecDialog.__createItem"></a> +<h4>PyLintExecDialog.__createItem</h4> +<b>__createItem</b>(<i>file, line, type_, message</i>) + +<p> + Private method to create an entry in the message list. +</p> +<dl> + +<dt><i>file</i> (str)</dt> +<dd> +filename of file +</dd> +<dt><i>line</i> (int or str)</dt> +<dd> +linenumber of message +</dd> +<dt><i>type_</i> (str)</dt> +<dd> +type of message +</dd> +<dt><i>message</i> (str)</dt> +<dd> +message text +</dd> +</dl> +<a NAME="PyLintExecDialog.__finish" ID="PyLintExecDialog.__finish"></a> +<h4>PyLintExecDialog.__finish</h4> +<b>__finish</b>(<i></i>) + +<p> + Private slot called when the process finished. +</p> +<p> + It is called when the process finished or the user pressed the button. +</p> +<a NAME="PyLintExecDialog.__readParseStdout" ID="PyLintExecDialog.__readParseStdout"></a> +<h4>PyLintExecDialog.__readParseStdout</h4> +<b>__readParseStdout</b>(<i></i>) + +<p> + Private slot to handle the readyReadStandardOutput signal for + parseable output. +</p> +<p> + It reads the output of the process, formats it and inserts it into + the message list pane. +</p> +<a NAME="PyLintExecDialog.__readStderr" ID="PyLintExecDialog.__readStderr"></a> +<h4>PyLintExecDialog.__readStderr</h4> +<b>__readStderr</b>(<i></i>) + +<p> + Private slot to handle the readyReadStandardError signal. +</p> +<p> + It reads the error output of the process and inserts it into the + error pane. +</p> +<a NAME="PyLintExecDialog.__readStdout" ID="PyLintExecDialog.__readStdout"></a> +<h4>PyLintExecDialog.__readStdout</h4> +<b>__readStdout</b>(<i></i>) + +<p> + Private slot to handle the readyReadStandardOutput signal. +</p> +<p> + It reads the output of the process, formats it and inserts it into + the contents pane. +</p> +<a NAME="PyLintExecDialog.__writeReport" ID="PyLintExecDialog.__writeReport"></a> +<h4>PyLintExecDialog.__writeReport</h4> +<b>__writeReport</b>(<i></i>) + +<p> + Private slot to write the report to a report file. +</p> +<a NAME="PyLintExecDialog.on_buttonBox_clicked" ID="PyLintExecDialog.on_buttonBox_clicked"></a> +<h4>PyLintExecDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) + +<p> + Private slot called by a button of the button box clicked. +</p> +<dl> + +<dt><i>button</i> (QAbstractButton)</dt> +<dd> +button that was clicked +</dd> +</dl> +<a NAME="PyLintExecDialog.on_messageList_itemActivated" ID="PyLintExecDialog.on_messageList_itemActivated"></a> +<h4>PyLintExecDialog.on_messageList_itemActivated</h4> +<b>on_messageList_itemActivated</b>(<i>itm, column</i>) + +<p> + Private slot to handle the itemActivated signal of the message list. +</p> +<dl> + +<dt><i>itm</i> (QTreeWidgetItem)</dt> +<dd> +The message item that was activated +</dd> +<dt><i>column</i> (int)</dt> +<dd> +column the item was activated in +</dd> +</dl> +<a NAME="PyLintExecDialog.on_refreshButton_clicked" ID="PyLintExecDialog.on_refreshButton_clicked"></a> +<h4>PyLintExecDialog.on_refreshButton_clicked</h4> +<b>on_refreshButton_clicked</b>(<i></i>) + +<p> + Private slot to refresh the status display. +</p> +<a NAME="PyLintExecDialog.on_saveButton_clicked" ID="PyLintExecDialog.on_saveButton_clicked"></a> +<h4>PyLintExecDialog.on_saveButton_clicked</h4> +<b>on_saveButton_clicked</b>(<i></i>) + +<p> + Private slot to save the report to a file. +</p> +<a NAME="PyLintExecDialog.start" ID="PyLintExecDialog.start"></a> +<h4>PyLintExecDialog.start</h4> +<b>start</b>(<i>args, fn, reportFile, ppath</i>) + +<p> + Public slot to start PyLint. +</p> +<dl> + +<dt><i>args</i> (list of str)</dt> +<dd> +commandline arguments for documentation programPyLint +</dd> +<dt><i>fn</i> (str)</dt> +<dd> +filename or dirname to be processed by PyLint +</dd> +<dt><i>reportFile</i> (str)</dt> +<dd> +filename of file to write the report to +</dd> +<dt><i>ppath</i> (str)</dt> +<dd> +project path +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating the successful start of the process +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- a/PyLintInterface/Documentation/source/index-Plugin_Checker_PyLint.PyLint.html Thu Dec 30 11:19:55 2021 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,41 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>Plugin_Checker_PyLint.PyLint</title> -<meta charset="UTF-8"> -<style> -body { - background: #EDECE6; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #85774A; } -h2 { color: white; background: #85774A; } -h3 { color: white; background: #9D936E; } -h4 { color: white; background: #9D936E; } - -a { color: #BA6D36; } - -</style> -</head> -<body> -<h1>Plugin_Checker_PyLint.PyLint</h1> - -<p> -Package containing the PyLint plugin. -</p> - - -<h3>Modules</h3> -<table> - -<tr> -<td><a href="Plugin_Checker_PyLint.PyLint.PyLintConfigDialog.html">PyLintConfigDialog</a></td> -<td>Module implementing a dialog to configure the PyLint process.</td> -</tr> -<tr> -<td><a href="Plugin_Checker_PyLint.PyLint.PyLintExecDialog.html">PyLintExecDialog</a></td> -<td>Module implementing a dialog to show the results of the PyLint run.</td> -</tr> -</table> -</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyLintInterface/Documentation/source/index-Plugin_Checker_PyLint.PyLintInterface.html Thu Dec 30 11:37:27 2021 +0100 @@ -0,0 +1,27 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Checker_PyLint.PyLintInterface</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<h1>Plugin_Checker_PyLint.PyLintInterface</h1> + +<p> +Package containing the PyLint plugin. +</p> + + +<h3>Modules</h3> +<table> + +<tr> +<td><a href="Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog.html">PyLintConfigDialog</a></td> +<td>Module implementing a dialog to configure the PyLint process.</td> +</tr> +<tr> +<td><a href="Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog.html">PyLintExecDialog</a></td> +<td>Module implementing a dialog to show the results of the PyLint run.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- a/PyLintInterface/Documentation/source/index-Plugin_Checker_PyLint.html Thu Dec 30 11:19:55 2021 +0100 +++ b/PyLintInterface/Documentation/source/index-Plugin_Checker_PyLint.html Thu Dec 30 11:37:27 2021 +0100 @@ -2,21 +2,7 @@ <html><head> <title>Plugin_Checker_PyLint</title> <meta charset="UTF-8"> -<style> -body { - background: #EDECE6; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #85774A; } -h2 { color: white; background: #85774A; } -h3 { color: white; background: #9D936E; } -h4 { color: white; background: #9D936E; } - -a { color: #BA6D36; } - -</style> +<link rel="stylesheet" href="styles.css"> </head> <body> <h1>Plugin_Checker_PyLint</h1>
--- a/PyLintInterface/Documentation/source/index.html Thu Dec 30 11:19:55 2021 +0100 +++ b/PyLintInterface/Documentation/source/index.html Thu Dec 30 11:37:27 2021 +0100 @@ -2,21 +2,7 @@ <html><head> <title>Table of contents</title> <meta charset="UTF-8"> -<style> -body { - background: #EDECE6; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #85774A; } -h2 { color: white; background: #85774A; } -h3 { color: white; background: #9D936E; } -h4 { color: white; background: #9D936E; } - -a { color: #BA6D36; } - -</style> +<link rel="stylesheet" href="styles.css"> </head> <body> <h1>Table of contents</h1>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyLintInterface/Documentation/source/styles.css Thu Dec 30 11:37:27 2021 +0100 @@ -0,0 +1,12 @@ +body { + color: black; + background: #EDECE6; + margin: 0em 1em 10em 1em; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; }
--- a/PyLintInterface/PyLintConfigDialog.py Thu Dec 30 11:19:55 2021 +0100 +++ b/PyLintInterface/PyLintConfigDialog.py Thu Dec 30 11:37:27 2021 +0100 @@ -75,7 +75,6 @@ "All Files (*)" )) - # initialize general tab self.configfilePicker.setText(self.parameters['configFile']) self.txtOutputButton.setChecked(self.parameters['txtReport'])
