diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.CondaInterface.CondaExecDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.CondaInterface.CondaExecDialog.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,277 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.CondaInterface.CondaExecDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.CondaInterface.CondaExecDialog</h1> + +<p> +Module implementing a dialog to show the output of a conda execution. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#CondaExecDialog">CondaExecDialog</a></td> +<td>Class implementing a dialog to show the output of a conda execution.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="CondaExecDialog" ID="CondaExecDialog"></a> +<h2>CondaExecDialog</h2> + +<p> + Class implementing a dialog to show the output of a conda execution. +</p> +<h3>Derived from</h3> +QDialog, Ui_CondaExecDialog +<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="#CondaExecDialog.__init__">CondaExecDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#CondaExecDialog.__finish">__finish</a></td> +<td>Private slot called when the process finished.</td> +</tr> +<tr> +<td><a href="#CondaExecDialog.__logError">__logError</a></td> +<td>Private method to log an error.</td> +</tr> +<tr> +<td><a href="#CondaExecDialog.__logOutput">__logOutput</a></td> +<td>Private method to log some output.</td> +</tr> +<tr> +<td><a href="#CondaExecDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr> +<tr> +<td><a href="#CondaExecDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr> +<tr> +<td><a href="#CondaExecDialog.__setProgressValues">__setProgressValues</a></td> +<td>Private method to set the value of the progress bar.</td> +</tr> +<tr> +<td><a href="#CondaExecDialog.getResult">getResult</a></td> +<td>Public method to the result of the command execution.</td> +</tr> +<tr> +<td><a href="#CondaExecDialog.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="#CondaExecDialog.start">start</a></td> +<td>Public slot to start the conda command.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="CondaExecDialog.__init__" ID="CondaExecDialog.__init__"></a> +<h4>CondaExecDialog (Constructor)</h4> +<b>CondaExecDialog</b>(<i>command, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>command</i> (str)</dt> +<dd> +conda command executed +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="CondaExecDialog.__finish" ID="CondaExecDialog.__finish"></a> +<h4>CondaExecDialog.__finish</h4> +<b>__finish</b>(<i>exitCode, exitStatus, giveUp=False</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> +<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> +<dt><i>giveUp</i> (bool)</dt> +<dd> +flag indicating to not start another attempt +</dd> +</dl> +<a NAME="CondaExecDialog.__logError" ID="CondaExecDialog.__logError"></a> +<h4>CondaExecDialog.__logError</h4> +<b>__logError</b>(<i>stderr</i>) + +<p> + Private method to log an error. +</p> +<dl> + +<dt><i>stderr</i> (str)</dt> +<dd> +error string to log +</dd> +</dl> +<a NAME="CondaExecDialog.__logOutput" ID="CondaExecDialog.__logOutput"></a> +<h4>CondaExecDialog.__logOutput</h4> +<b>__logOutput</b>(<i>stdout</i>) + +<p> + Private method to log some output. +</p> +<dl> + +<dt><i>stdout</i> (str)</dt> +<dd> +output string to log +</dd> +</dl> +<a NAME="CondaExecDialog.__readStderr" ID="CondaExecDialog.__readStderr"></a> +<h4>CondaExecDialog.__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="CondaExecDialog.__readStdout" ID="CondaExecDialog.__readStdout"></a> +<h4>CondaExecDialog.__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="CondaExecDialog.__setProgressValues" ID="CondaExecDialog.__setProgressValues"></a> +<h4>CondaExecDialog.__setProgressValues</h4> +<b>__setProgressValues</b>(<i>jsonDict, progressType</i>) + +<p> + Private method to set the value of the progress bar. +</p> +<dl> + +<dt><i>jsonDict</i> (dict)</dt> +<dd> +dictionary containing the progress info +</dd> +<dt><i>progressType</i> (str)</dt> +<dd> +action type to check for +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="CondaExecDialog.getResult" ID="CondaExecDialog.getResult"></a> +<h4>CondaExecDialog.getResult</h4> +<b>getResult</b>(<i></i>) + +<p> + Public method to the result of the command execution. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating success and the result data. +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, dict) +</dd> +</dl> +<a NAME="CondaExecDialog.on_buttonBox_clicked" ID="CondaExecDialog.on_buttonBox_clicked"></a> +<h4>CondaExecDialog.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="CondaExecDialog.start" ID="CondaExecDialog.start"></a> +<h4>CondaExecDialog.start</h4> +<b>start</b>(<i>arguments</i>) + +<p> + Public slot to start the conda command. +</p> +<dl> + +<dt><i>arguments</i> (list of str)</dt> +<dd> +commandline arguments for conda program +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file