eric7/Documentation/Source/eric7.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog</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>eric7.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog</h1>

<p>
Module implementing the setup.py wizard dialog.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#SetupWizardDialog">SetupWizardDialog</a></td>
<td>Class implementing the setup.py wizard dialog.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing the setup.py wizard dialog.
</p>
<p>
    It displays a dialog for entering the parameters
    for the EricMessageBox code generator.
</p>
<h3>Derived from</h3>
QDialog, Ui_SetupWizardDialog
<h3>Class Attributes</h3>

<table>
<tr><td>ClassifiersUrl</td></tr>
</table>
<h3>Class Methods</h3>

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

<table>

<tr>
<td><a href="#SetupWizardDialog.__init__">SetupWizardDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.__addClassifierEntry">__addClassifierEntry</a></td>
<td>Private method to add a new entry to the list of trove classifiers.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.__addPackage">__addPackage</a></td>
<td>Private method to add a package to the list.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.__classifiersDownloadDone">__classifiersDownloadDone</a></td>
<td>Private slot called, after the classifiers file has been downloaded from the internet.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.__enableOkButton">__enableOkButton</a></td>
<td>Private slot to set the state of the OK button.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.__getLicenseText">__getLicenseText</a></td>
<td>Private method to get the license text.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.__getStartDir">__getStartDir</a></td>
<td>Private method to get the start directory for selection dialogs.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.__loadClassifiersFromPyPI">__loadClassifiersFromPyPI</a></td>
<td>Private method to populate the classifiers list with data retrieved from PyPI.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.__populateClassifiers">__populateClassifiers</a></td>
<td>Private method to populate the classifiers.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.getCode">getCode</a></td>
<td>Public method to get the source code.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_addExludePatternButton_clicked">on_addExludePatternButton_clicked</a></td>
<td>Private slot to add an exclude pattern to the list.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_addModuleButton_clicked">on_addModuleButton_clicked</a></td>
<td>Private slot to add Python modules to the list.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_addPackageButton_clicked">on_addPackageButton_clicked</a></td>
<td>Private slot to add a package to the list.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_addScriptButton_clicked">on_addScriptButton_clicked</a></td>
<td>Private slot to add scripts to the list.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_autodiscoverPackagesButton_clicked">on_autodiscoverPackagesButton_clicked</a></td>
<td>Private slot to discover packages automatically.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_deleteExcludePatternButton_clicked">on_deleteExcludePatternButton_clicked</a></td>
<td>Private slot to delete the selected exclude pattern items.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_deleteModuleButton_clicked">on_deleteModuleButton_clicked</a></td>
<td>Private slot to delete the selected script items.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_deletePackageButton_clicked">on_deletePackageButton_clicked</a></td>
<td>Private slot to delete the selected package items.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_deleteScriptButton_clicked">on_deleteScriptButton_clicked</a></td>
<td>Private slot to delete the selected script items.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_excludePatternEdit_returnPressed">on_excludePatternEdit_returnPressed</a></td>
<td>Private slot handling a press of the return button of the exclude pattern edit.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_excludePatternEdit_textChanged">on_excludePatternEdit_textChanged</a></td>
<td>Private slot to handle a change of the exclude pattern text.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_excludePatternList_itemSelectionChanged">on_excludePatternList_itemSelectionChanged</a></td>
<td>Private slot to handle a change of selected items of the exclude pattern list.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_localClassifiersButton_clicked">on_localClassifiersButton_clicked</a></td>
<td>Private method to populate lists from the Trove list file.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_modulesList_itemSelectionChanged">on_modulesList_itemSelectionChanged</a></td>
<td>Private slot to handle a change of selected items of the modules list.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_packageDirButton_clicked">on_packageDirButton_clicked</a></td>
<td>Private slot to select a package directory via a directory selection dialog.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_packageEdit_returnPressed">on_packageEdit_returnPressed</a></td>
<td>Private slot handling a press of the return button of the package edit.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_packageEdit_textChanged">on_packageEdit_textChanged</a></td>
<td>Private slot to handle a change of the package text.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_packageRootDirButton_clicked">on_packageRootDirButton_clicked</a></td>
<td>Private slot to select the packages root directory via a directory selection dialog.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_packageRootEdit_textChanged">on_packageRootEdit_textChanged</a></td>
<td>Private slot handling the entering of a packages root.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_packagesList_itemSelectionChanged">on_packagesList_itemSelectionChanged</a></td>
<td>Private slot to handle a change of selected items of the packages list.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_projectButton_clicked">on_projectButton_clicked</a></td>
<td>Private slot to populate some fields with data retrieved from the current project.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_scriptsList_itemSelectionChanged">on_scriptsList_itemSelectionChanged</a></td>
<td>Private slot to handle a change of selected items of the scripts list.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_sourceDirectoryButton_clicked">on_sourceDirectoryButton_clicked</a></td>
<td>Private slot to select the packages root directory via a directory selection dialog.</td>
</tr>
<tr>
<td><a href="#SetupWizardDialog.on_variantComboBox_currentIndexChanged">on_variantComboBox_currentIndexChanged</a></td>
<td>Private slot handling a change of the setup variant.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="SetupWizardDialog.__init__" ID="SetupWizardDialog.__init__"></a>
<h4>SetupWizardDialog (Constructor)</h4>
<b>SetupWizardDialog</b>(<i>parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl>
<a NAME="SetupWizardDialog.__addClassifierEntry" ID="SetupWizardDialog.__addClassifierEntry"></a>
<h4>SetupWizardDialog.__addClassifierEntry</h4>
<b>__addClassifierEntry</b>(<i>line</i>)

<p>
        Private method to add a new entry to the list of trove classifiers.
</p>
<dl>

<dt><i>line</i></dt>
<dd>
line containing the data for the entry (string)
</dd>
</dl>
<a NAME="SetupWizardDialog.__addPackage" ID="SetupWizardDialog.__addPackage"></a>
<h4>SetupWizardDialog.__addPackage</h4>
<b>__addPackage</b>(<i>pkgDir</i>)

<p>
        Private method to add a package to the list.
</p>
<dl>

<dt><i>pkgDir</i></dt>
<dd>
name of the package directory (string)
</dd>
</dl>
<a NAME="SetupWizardDialog.__classifiersDownloadDone" ID="SetupWizardDialog.__classifiersDownloadDone"></a>
<h4>SetupWizardDialog.__classifiersDownloadDone</h4>
<b>__classifiersDownloadDone</b>(<i>reply</i>)

<p>
        Private slot called, after the classifiers file has been downloaded
        from the internet.
</p>
<dl>

<dt><i>reply</i> (QNetworkReply)</dt>
<dd>
reference to the network reply
</dd>
</dl>
<a NAME="SetupWizardDialog.__enableOkButton" ID="SetupWizardDialog.__enableOkButton"></a>
<h4>SetupWizardDialog.__enableOkButton</h4>
<b>__enableOkButton</b>(<i></i>)

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

<p>
        Private method to get the license text.
</p>
<dl>
<dt>Return:</dt>
<dd>
license text (string)
</dd>
</dl>
<a NAME="SetupWizardDialog.__getStartDir" ID="SetupWizardDialog.__getStartDir"></a>
<h4>SetupWizardDialog.__getStartDir</h4>
<b>__getStartDir</b>(<i></i>)

<p>
        Private method to get the start directory for selection dialogs.
</p>
<dl>
<dt>Return:</dt>
<dd>
start directory (string)
</dd>
</dl>
<a NAME="SetupWizardDialog.__loadClassifiersFromPyPI" ID="SetupWizardDialog.__loadClassifiersFromPyPI"></a>
<h4>SetupWizardDialog.__loadClassifiersFromPyPI</h4>
<b>__loadClassifiersFromPyPI</b>(<i></i>)

<p>
        Private method to populate the classifiers list with data retrieved
        from PyPI.
</p>
<a NAME="SetupWizardDialog.__populateClassifiers" ID="SetupWizardDialog.__populateClassifiers"></a>
<h4>SetupWizardDialog.__populateClassifiers</h4>
<b>__populateClassifiers</b>(<i>classifiers</i>)

<p>
        Private method to populate the classifiers.
</p>
<dl>

<dt><i>classifiers</i> (list of str)</dt>
<dd>
list of classifiers read from a local file or
            retrieved from PyPI
</dd>
</dl>
<a NAME="SetupWizardDialog.getCode" ID="SetupWizardDialog.getCode"></a>
<h4>SetupWizardDialog.getCode</h4>
<b>getCode</b>(<i>indLevel, indString</i>)

<p>
        Public method to get the source code.
</p>
<dl>

<dt><i>indLevel</i></dt>
<dd>
indentation level (int)
</dd>
<dt><i>indString</i></dt>
<dd>
string used for indentation (space or tab) (string)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
generated code (string)
</dd>
</dl>
<a NAME="SetupWizardDialog.on_addExludePatternButton_clicked" ID="SetupWizardDialog.on_addExludePatternButton_clicked"></a>
<h4>SetupWizardDialog.on_addExludePatternButton_clicked</h4>
<b>on_addExludePatternButton_clicked</b>(<i></i>)

<p>
        Private slot to add an exclude pattern to the list.
</p>
<a NAME="SetupWizardDialog.on_addModuleButton_clicked" ID="SetupWizardDialog.on_addModuleButton_clicked"></a>
<h4>SetupWizardDialog.on_addModuleButton_clicked</h4>
<b>on_addModuleButton_clicked</b>(<i></i>)

<p>
        Private slot to add Python modules to the list.
</p>
<a NAME="SetupWizardDialog.on_addPackageButton_clicked" ID="SetupWizardDialog.on_addPackageButton_clicked"></a>
<h4>SetupWizardDialog.on_addPackageButton_clicked</h4>
<b>on_addPackageButton_clicked</b>(<i></i>)

<p>
        Private slot to add a package to the list.
</p>
<a NAME="SetupWizardDialog.on_addScriptButton_clicked" ID="SetupWizardDialog.on_addScriptButton_clicked"></a>
<h4>SetupWizardDialog.on_addScriptButton_clicked</h4>
<b>on_addScriptButton_clicked</b>(<i></i>)

<p>
        Private slot to add scripts to the list.
</p>
<a NAME="SetupWizardDialog.on_autodiscoverPackagesButton_clicked" ID="SetupWizardDialog.on_autodiscoverPackagesButton_clicked"></a>
<h4>SetupWizardDialog.on_autodiscoverPackagesButton_clicked</h4>
<b>on_autodiscoverPackagesButton_clicked</b>(<i></i>)

<p>
        Private slot to discover packages automatically.
</p>
<a NAME="SetupWizardDialog.on_deleteExcludePatternButton_clicked" ID="SetupWizardDialog.on_deleteExcludePatternButton_clicked"></a>
<h4>SetupWizardDialog.on_deleteExcludePatternButton_clicked</h4>
<b>on_deleteExcludePatternButton_clicked</b>(<i></i>)

<p>
        Private slot to delete the selected exclude pattern items.
</p>
<a NAME="SetupWizardDialog.on_deleteModuleButton_clicked" ID="SetupWizardDialog.on_deleteModuleButton_clicked"></a>
<h4>SetupWizardDialog.on_deleteModuleButton_clicked</h4>
<b>on_deleteModuleButton_clicked</b>(<i></i>)

<p>
        Private slot to delete the selected script items.
</p>
<a NAME="SetupWizardDialog.on_deletePackageButton_clicked" ID="SetupWizardDialog.on_deletePackageButton_clicked"></a>
<h4>SetupWizardDialog.on_deletePackageButton_clicked</h4>
<b>on_deletePackageButton_clicked</b>(<i></i>)

<p>
        Private slot to delete the selected package items.
</p>
<a NAME="SetupWizardDialog.on_deleteScriptButton_clicked" ID="SetupWizardDialog.on_deleteScriptButton_clicked"></a>
<h4>SetupWizardDialog.on_deleteScriptButton_clicked</h4>
<b>on_deleteScriptButton_clicked</b>(<i></i>)

<p>
        Private slot to delete the selected script items.
</p>
<a NAME="SetupWizardDialog.on_excludePatternEdit_returnPressed" ID="SetupWizardDialog.on_excludePatternEdit_returnPressed"></a>
<h4>SetupWizardDialog.on_excludePatternEdit_returnPressed</h4>
<b>on_excludePatternEdit_returnPressed</b>(<i></i>)

<p>
        Private slot handling a press of the return button of the
        exclude pattern edit.
</p>
<a NAME="SetupWizardDialog.on_excludePatternEdit_textChanged" ID="SetupWizardDialog.on_excludePatternEdit_textChanged"></a>
<h4>SetupWizardDialog.on_excludePatternEdit_textChanged</h4>
<b>on_excludePatternEdit_textChanged</b>(<i>txt</i>)

<p>
        Private slot to handle a change of the exclude pattern text.
</p>
<dl>

<dt><i>txt</i></dt>
<dd>
text of the line edit (string)
</dd>
</dl>
<a NAME="SetupWizardDialog.on_excludePatternList_itemSelectionChanged" ID="SetupWizardDialog.on_excludePatternList_itemSelectionChanged"></a>
<h4>SetupWizardDialog.on_excludePatternList_itemSelectionChanged</h4>
<b>on_excludePatternList_itemSelectionChanged</b>(<i></i>)

<p>
        Private slot to handle a change of selected items of the
        exclude pattern list.
</p>
<a NAME="SetupWizardDialog.on_localClassifiersButton_clicked" ID="SetupWizardDialog.on_localClassifiersButton_clicked"></a>
<h4>SetupWizardDialog.on_localClassifiersButton_clicked</h4>
<b>on_localClassifiersButton_clicked</b>(<i></i>)

<p>
        Private method to populate lists from the Trove list file.
</p>
<p>
        Note: The trove list file was created from querying
        "https://pypi.org/pypi?%3Aaction=list_classifiers".
</p>
<a NAME="SetupWizardDialog.on_modulesList_itemSelectionChanged" ID="SetupWizardDialog.on_modulesList_itemSelectionChanged"></a>
<h4>SetupWizardDialog.on_modulesList_itemSelectionChanged</h4>
<b>on_modulesList_itemSelectionChanged</b>(<i></i>)

<p>
        Private slot to handle a change of selected items of the
        modules list.
</p>
<a NAME="SetupWizardDialog.on_packageDirButton_clicked" ID="SetupWizardDialog.on_packageDirButton_clicked"></a>
<h4>SetupWizardDialog.on_packageDirButton_clicked</h4>
<b>on_packageDirButton_clicked</b>(<i></i>)

<p>
        Private slot to select a package directory via a directory
        selection dialog.
</p>
<a NAME="SetupWizardDialog.on_packageEdit_returnPressed" ID="SetupWizardDialog.on_packageEdit_returnPressed"></a>
<h4>SetupWizardDialog.on_packageEdit_returnPressed</h4>
<b>on_packageEdit_returnPressed</b>(<i></i>)

<p>
        Private slot handling a press of the return button of the
        package edit.
</p>
<a NAME="SetupWizardDialog.on_packageEdit_textChanged" ID="SetupWizardDialog.on_packageEdit_textChanged"></a>
<h4>SetupWizardDialog.on_packageEdit_textChanged</h4>
<b>on_packageEdit_textChanged</b>(<i>txt</i>)

<p>
        Private slot to handle a change of the package text.
</p>
<dl>

<dt><i>txt</i></dt>
<dd>
text of the line edit (string)
</dd>
</dl>
<a NAME="SetupWizardDialog.on_packageRootDirButton_clicked" ID="SetupWizardDialog.on_packageRootDirButton_clicked"></a>
<h4>SetupWizardDialog.on_packageRootDirButton_clicked</h4>
<b>on_packageRootDirButton_clicked</b>(<i></i>)

<p>
        Private slot to select the packages root directory via a
        directory selection dialog.
</p>
<a NAME="SetupWizardDialog.on_packageRootEdit_textChanged" ID="SetupWizardDialog.on_packageRootEdit_textChanged"></a>
<h4>SetupWizardDialog.on_packageRootEdit_textChanged</h4>
<b>on_packageRootEdit_textChanged</b>(<i>txt</i>)

<p>
        Private slot handling the entering of a packages root.
</p>
<dl>

<dt><i>txt</i></dt>
<dd>
text of the line edit (string)
</dd>
</dl>
<a NAME="SetupWizardDialog.on_packagesList_itemSelectionChanged" ID="SetupWizardDialog.on_packagesList_itemSelectionChanged"></a>
<h4>SetupWizardDialog.on_packagesList_itemSelectionChanged</h4>
<b>on_packagesList_itemSelectionChanged</b>(<i></i>)

<p>
        Private slot to handle a change of selected items of the
        packages list.
</p>
<a NAME="SetupWizardDialog.on_projectButton_clicked" ID="SetupWizardDialog.on_projectButton_clicked"></a>
<h4>SetupWizardDialog.on_projectButton_clicked</h4>
<b>on_projectButton_clicked</b>(<i></i>)

<p>
        Private slot to populate some fields with data retrieved from the
        current project.
</p>
<a NAME="SetupWizardDialog.on_scriptsList_itemSelectionChanged" ID="SetupWizardDialog.on_scriptsList_itemSelectionChanged"></a>
<h4>SetupWizardDialog.on_scriptsList_itemSelectionChanged</h4>
<b>on_scriptsList_itemSelectionChanged</b>(<i></i>)

<p>
        Private slot to handle a change of selected items of the
        scripts list.
</p>
<a NAME="SetupWizardDialog.on_sourceDirectoryButton_clicked" ID="SetupWizardDialog.on_sourceDirectoryButton_clicked"></a>
<h4>SetupWizardDialog.on_sourceDirectoryButton_clicked</h4>
<b>on_sourceDirectoryButton_clicked</b>(<i></i>)

<p>
        Private slot to select the packages root directory via a
        directory selection dialog.
</p>
<a NAME="SetupWizardDialog.on_variantComboBox_currentIndexChanged" ID="SetupWizardDialog.on_variantComboBox_currentIndexChanged"></a>
<h4>SetupWizardDialog.on_variantComboBox_currentIndexChanged</h4>
<b>on_variantComboBox_currentIndexChanged</b>(<i>index</i>)

<p>
        Private slot handling a change of the setup variant.
</p>
<dl>

<dt><i>index</i></dt>
<dd>
index of the selected entry (integer)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>