--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvUpgradeExecDialog.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,267 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.VirtualEnv.VirtualenvUpgradeExecDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.VirtualEnv.VirtualenvUpgradeExecDialog</h1> + +<p> +Module implementing the virtualenv upgrade execution dialog. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#VirtualenvUpgradeExecDialog">VirtualenvUpgradeExecDialog</a></td> +<td>Class implementing the virtualenv upgrade execution dialog.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="VirtualenvUpgradeExecDialog" ID="VirtualenvUpgradeExecDialog"></a> +<h2>VirtualenvUpgradeExecDialog</h2> + +<p> + Class implementing the virtualenv upgrade execution dialog. +</p> +<h3>Derived from</h3> +QDialog, Ui_VirtualenvExecDialog +<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="#VirtualenvUpgradeExecDialog.__init__">VirtualenvUpgradeExecDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#VirtualenvUpgradeExecDialog.__changeVirtualEnvironmentInterpreter">__changeVirtualEnvironmentInterpreter</a></td> +<td>Private method to change the interpreter of the upgraded virtual environment.</td> +</tr> +<tr> +<td><a href="#VirtualenvUpgradeExecDialog.__finish">__finish</a></td> +<td>Private slot called when the process finished.</td> +</tr> +<tr> +<td><a href="#VirtualenvUpgradeExecDialog.__logError">__logError</a></td> +<td>Private method to log an error.</td> +</tr> +<tr> +<td><a href="#VirtualenvUpgradeExecDialog.__logOutput">__logOutput</a></td> +<td>Private method to log some output.</td> +</tr> +<tr> +<td><a href="#VirtualenvUpgradeExecDialog.__nextAttempt">__nextAttempt</a></td> +<td>Private method to start another attempt.</td> +</tr> +<tr> +<td><a href="#VirtualenvUpgradeExecDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr> +<tr> +<td><a href="#VirtualenvUpgradeExecDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr> +<tr> +<td><a href="#VirtualenvUpgradeExecDialog.__writeLogFile">__writeLogFile</a></td> +<td>Private method to write a log file to the virtualenv directory.</td> +</tr> +<tr> +<td><a href="#VirtualenvUpgradeExecDialog.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="#VirtualenvUpgradeExecDialog.start">start</a></td> +<td>Public slot to start the virtualenv command.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="VirtualenvUpgradeExecDialog.__init__" ID="VirtualenvUpgradeExecDialog.__init__"></a> +<h4>VirtualenvUpgradeExecDialog (Constructor)</h4> +<b>VirtualenvUpgradeExecDialog</b>(<i>venvName, interpreter, createLog, venvManager, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>venvName</i> (str)</dt> +<dd> +name of the virtual environment to be upgraded +</dd> +<dt><i>interpreter</i> (str)</dt> +<dd> +interpreter to be used for the upgrade +</dd> +<dt><i>createLog</i> (bool)</dt> +<dd> +flag indicating to create a log file for the upgrade +</dd> +<dt><i>venvManager</i> (VirtualenvManager)</dt> +<dd> +reference to the virtual environment manager +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="VirtualenvUpgradeExecDialog.__changeVirtualEnvironmentInterpreter" ID="VirtualenvUpgradeExecDialog.__changeVirtualEnvironmentInterpreter"></a> +<h4>VirtualenvUpgradeExecDialog.__changeVirtualEnvironmentInterpreter</h4> +<b>__changeVirtualEnvironmentInterpreter</b>(<i></i>) + +<p> + Private method to change the interpreter of the upgraded virtual + environment. +</p> +<a NAME="VirtualenvUpgradeExecDialog.__finish" ID="VirtualenvUpgradeExecDialog.__finish"></a> +<h4>VirtualenvUpgradeExecDialog.__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></dt> +<dd> +exit code of the process (integer) +</dd> +<dt><i>exitStatus</i></dt> +<dd> +exit status of the process (QProcess.ExitStatus) +</dd> +<dt><i>giveUp</i></dt> +<dd> +flag indicating to not start another attempt (boolean) +</dd> +</dl> +<a NAME="VirtualenvUpgradeExecDialog.__logError" ID="VirtualenvUpgradeExecDialog.__logError"></a> +<h4>VirtualenvUpgradeExecDialog.__logError</h4> +<b>__logError</b>(<i>s</i>) + +<p> + Private method to log an error. +</p> +<dl> + +<dt><i>s</i></dt> +<dd> +error string to log (string) +</dd> +</dl> +<a NAME="VirtualenvUpgradeExecDialog.__logOutput" ID="VirtualenvUpgradeExecDialog.__logOutput"></a> +<h4>VirtualenvUpgradeExecDialog.__logOutput</h4> +<b>__logOutput</b>(<i>s</i>) + +<p> + Private method to log some output. +</p> +<dl> + +<dt><i>s</i></dt> +<dd> +output string to log (string) +</dd> +</dl> +<a NAME="VirtualenvUpgradeExecDialog.__nextAttempt" ID="VirtualenvUpgradeExecDialog.__nextAttempt"></a> +<h4>VirtualenvUpgradeExecDialog.__nextAttempt</h4> +<b>__nextAttempt</b>(<i></i>) + +<p> + Private method to start another attempt. +</p> +<a NAME="VirtualenvUpgradeExecDialog.__readStderr" ID="VirtualenvUpgradeExecDialog.__readStderr"></a> +<h4>VirtualenvUpgradeExecDialog.__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="VirtualenvUpgradeExecDialog.__readStdout" ID="VirtualenvUpgradeExecDialog.__readStdout"></a> +<h4>VirtualenvUpgradeExecDialog.__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="VirtualenvUpgradeExecDialog.__writeLogFile" ID="VirtualenvUpgradeExecDialog.__writeLogFile"></a> +<h4>VirtualenvUpgradeExecDialog.__writeLogFile</h4> +<b>__writeLogFile</b>(<i></i>) + +<p> + Private method to write a log file to the virtualenv directory. +</p> +<a NAME="VirtualenvUpgradeExecDialog.on_buttonBox_clicked" ID="VirtualenvUpgradeExecDialog.on_buttonBox_clicked"></a> +<h4>VirtualenvUpgradeExecDialog.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="VirtualenvUpgradeExecDialog.start" ID="VirtualenvUpgradeExecDialog.start"></a> +<h4>VirtualenvUpgradeExecDialog.start</h4> +<b>start</b>(<i>arguments</i>) + +<p> + Public slot to start the virtualenv command. +</p> +<dl> + +<dt><i>arguments</i></dt> +<dd> +commandline arguments for virtualenv/pyvenv program + (list of strings) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file