src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvUpgradeConfigurationDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.VirtualEnv.VirtualenvUpgradeConfigurationDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.VirtualEnv.VirtualenvUpgradeConfigurationDialog</h1>

<p>
Module implementing a dialog to enter the virtual environment upgrade
parameters.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#VirtualenvUpgradeConfigurationDialog">VirtualenvUpgradeConfigurationDialog</a></td>
<td>Class implementing a dialog to enter the virtual environment upgrade parameters.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="VirtualenvUpgradeConfigurationDialog" ID="VirtualenvUpgradeConfigurationDialog"></a>
<h2>VirtualenvUpgradeConfigurationDialog</h2>

<p>
    Class implementing a dialog to enter the virtual environment upgrade
    parameters.
</p>
<h3>Derived from</h3>
QDialog, Ui_VirtualenvUpgradeConfigurationDialog
<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="#VirtualenvUpgradeConfigurationDialog.__init__">VirtualenvUpgradeConfigurationDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#VirtualenvUpgradeConfigurationDialog.__getPyvenvVersion">__getPyvenvVersion</a></td>
<td>Private method to determine the version of the venv module.</td>
</tr>
<tr>
<td><a href="#VirtualenvUpgradeConfigurationDialog.__updateOkButton">__updateOkButton</a></td>
<td>Private slot to set the enabled state of the OK button.</td>
</tr>
<tr>
<td><a href="#VirtualenvUpgradeConfigurationDialog.__updateUpgradeDepsCheckBox">__updateUpgradeDepsCheckBox</a></td>
<td>Private slot to set the enabled state of the button depending on the version of the given Python interpreter.</td>
</tr>
<tr>
<td><a href="#VirtualenvUpgradeConfigurationDialog.getData">getData</a></td>
<td>Public method to retrieve the dialog data.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="VirtualenvUpgradeConfigurationDialog.__init__" ID="VirtualenvUpgradeConfigurationDialog.__init__"></a>
<h4>VirtualenvUpgradeConfigurationDialog (Constructor)</h4>
<b>VirtualenvUpgradeConfigurationDialog</b>(<i>envName, envPath, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>envName</i> (str)</dt>
<dd>
name of the environment to be upgraded
</dd>
<dt><i>envPath</i> (str)</dt>
<dd>
directory of the environment to be upgraded
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="VirtualenvUpgradeConfigurationDialog.__getPyvenvVersion" ID="VirtualenvUpgradeConfigurationDialog.__getPyvenvVersion"></a>
<h4>VirtualenvUpgradeConfigurationDialog.__getPyvenvVersion</h4>
<b>__getPyvenvVersion</b>(<i></i>)

<p>
        Private method to determine the version of the venv module.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple containing the venv modules version
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (int, int, int)
</dd>
</dl>
<a NAME="VirtualenvUpgradeConfigurationDialog.__updateOkButton" ID="VirtualenvUpgradeConfigurationDialog.__updateOkButton"></a>
<h4>VirtualenvUpgradeConfigurationDialog.__updateOkButton</h4>
<b>__updateOkButton</b>(<i></i>)

<p>
        Private slot to set the enabled state of the OK button.
</p>
<a NAME="VirtualenvUpgradeConfigurationDialog.__updateUpgradeDepsCheckBox" ID="VirtualenvUpgradeConfigurationDialog.__updateUpgradeDepsCheckBox"></a>
<h4>VirtualenvUpgradeConfigurationDialog.__updateUpgradeDepsCheckBox</h4>
<b>__updateUpgradeDepsCheckBox</b>(<i></i>)

<p>
        Private slot to set the enabled state of the button depending
        on the version of the given Python interpreter.
</p>
<a NAME="VirtualenvUpgradeConfigurationDialog.getData" ID="VirtualenvUpgradeConfigurationDialog.getData"></a>
<h4>VirtualenvUpgradeConfigurationDialog.getData</h4>
<b>getData</b>(<i></i>)

<p>
        Public method to retrieve the dialog data.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple containing the selected python executable, the list of
            arguments and a flag indicating to write a log file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, list of str, bool)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>