Sat, 20 Jan 2018 17:06:15 +0100
Added source code documentation.
diff -r ba5a623378ec -r 43ef722c3873 PluginPyInstaller.e4p --- a/PluginPyInstaller.e4p Sat Jan 20 17:02:00 2018 +0100 +++ b/PluginPyInstaller.e4p Sat Jan 20 17:06:15 2018 +0100 @@ -44,6 +44,7 @@ <Other>PluginPyInstaller.e4p</Other> <Other>PluginPyInstaller.zip</Other> <Other>PyInstaller/Documentation/LICENSE.GPL3</Other> + <Other>PyInstaller/Documentation/source</Other> </Others> <MainScript>PluginPyInstaller.py</MainScript> <Vcs> @@ -168,6 +169,62 @@ <FiletypeAssociation pattern="README.*" type="OTHERS"/> <FiletypeAssociation pattern="Ui_*.py" type="__IGNORE__"/> </FiletypeAssociations> + <Documentation> + <DocumentationParams> + <dict> + <key> + <string>ERIC4DOC</string> + </key> + <value> + <dict> + <key> + <string>cssFile</string> + </key> + <value> + <string>%PYTHON%/eric6/CSSs/default.css</string> + </value> + <key> + <string>ignoreDirectories</string> + </key> + <value> + <list> + <string>.eric6project</string> + <string>.ropeproject</string> + <string>_eric6project</string> + <string>.hg</string> + </list> + </value> + <key> + <string>ignoreFilePatterns</string> + </key> + <value> + <list> + <string>Ui_*.py</string> + </list> + </value> + <key> + <string>outputDirectory</string> + </key> + <value> + <string>PyInstaller/Documentation/source</string> + </value> + <key> + <string>qtHelpEnabled</string> + </key> + <value> + <bool>False</bool> + </value> + <key> + <string>useRecursion</string> + </key> + <value> + <bool>True</bool> + </value> + </dict> + </value> + </dict> + </DocumentationParams> + </Documentation> <Checkers> <CheckersParams> <dict>
diff -r ba5a623378ec -r 43ef722c3873 PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PluginPyInstaller.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PluginPyInstaller.html Sat Jan 20 17:06:15 2018 +0100 @@ -0,0 +1,234 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Packager_PyInstaller.PluginPyInstaller</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_Packager_PyInstaller.PluginPyInstaller</h1> +<p> +Module implementing the PyInstaller interface plug-in. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>exePy2</td></tr><tr><td>exePy3</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PyInstallerPlugin">PyInstallerPlugin</a></td> +<td>Class implementing the PyInstaller interface plug-in.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr> +<td><a href="#_checkProgram">_checkProgram</a></td> +<td>Restricted function to check the availability of pyinstaller.</td> +</tr><tr> +<td><a href="#_findExecutable">_findExecutable</a></td> +<td>Restricted function to determine the names of the executables.</td> +</tr><tr> +<td><a href="#exeDisplayDataList">exeDisplayDataList</a></td> +<td>Module function to support the display of some executable info.</td> +</tr><tr> +<td><a href="#getExePath">getExePath</a></td> +<td></td> +</tr> +</table> +<hr /><hr /> +<a NAME="PyInstallerPlugin" ID="PyInstallerPlugin"></a> +<h2>PyInstallerPlugin</h2> +<p> + Class implementing the PyInstaller interface plug-in. +</p> +<h3>Derived from</h3> +QObject +<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="#PyInstallerPlugin.__init__">PyInstallerPlugin</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PyInstallerPlugin.__initialize">__initialize</a></td> +<td>Private slot to (re)initialize the plug-in.</td> +</tr><tr> +<td><a href="#PyInstallerPlugin.__loadTranslator">__loadTranslator</a></td> +<td>Private method to load the translation file.</td> +</tr><tr> +<td><a href="#PyInstallerPlugin.__projectShowMenu">__projectShowMenu</a></td> +<td>Private slot called, when the the project menu or a submenu is about to be shown.</td> +</tr><tr> +<td><a href="#PyInstallerPlugin.__pyiMakeSpec">__pyiMakeSpec</a></td> +<td>Private slot to execute the pyi-makespec command for the current project to generate a spec file to be used by pyinstaller.</td> +</tr><tr> +<td><a href="#PyInstallerPlugin.__pyinstaller">__pyinstaller</a></td> +<td>Private slot to execute the pyinstaller command for the current project.</td> +</tr><tr> +<td><a href="#PyInstallerPlugin.__pyinstallerCleanup">__pyinstallerCleanup</a></td> +<td>Private slot to remove the directories created by pyinstaller.</td> +</tr><tr> +<td><a href="#PyInstallerPlugin.activate">activate</a></td> +<td>Public method to activate this plug-in.</td> +</tr><tr> +<td><a href="#PyInstallerPlugin.deactivate">deactivate</a></td> +<td>Public method to deactivate this plug-in.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PyInstallerPlugin.__init__" ID="PyInstallerPlugin.__init__"></a> +<h4>PyInstallerPlugin (Constructor)</h4> +<b>PyInstallerPlugin</b>(<i>ui</i>) +<p> + Constructor +</p><dl> +<dt><i>ui</i> (UI.UserInterface)</dt> +<dd> +reference to the user interface object +</dd> +</dl><a NAME="PyInstallerPlugin.__initialize" ID="PyInstallerPlugin.__initialize"></a> +<h4>PyInstallerPlugin.__initialize</h4> +<b>__initialize</b>(<i></i>) +<p> + Private slot to (re)initialize the plug-in. +</p><a NAME="PyInstallerPlugin.__loadTranslator" ID="PyInstallerPlugin.__loadTranslator"></a> +<h4>PyInstallerPlugin.__loadTranslator</h4> +<b>__loadTranslator</b>(<i></i>) +<p> + Private method to load the translation file. +</p><a NAME="PyInstallerPlugin.__projectShowMenu" ID="PyInstallerPlugin.__projectShowMenu"></a> +<h4>PyInstallerPlugin.__projectShowMenu</h4> +<b>__projectShowMenu</b>(<i>menuName, menu</i>) +<p> + Private slot called, when the the project menu or a submenu is + about to be shown. +</p><dl> +<dt><i>menuName</i> (str)</dt> +<dd> +name of the menu to be shown +</dd><dt><i>menu</i> (QMenu)</dt> +<dd> +reference to the menu +</dd> +</dl><a NAME="PyInstallerPlugin.__pyiMakeSpec" ID="PyInstallerPlugin.__pyiMakeSpec"></a> +<h4>PyInstallerPlugin.__pyiMakeSpec</h4> +<b>__pyiMakeSpec</b>(<i></i>) +<p> + Private slot to execute the pyi-makespec command for the current + project to generate a spec file to be used by pyinstaller. +</p><a NAME="PyInstallerPlugin.__pyinstaller" ID="PyInstallerPlugin.__pyinstaller"></a> +<h4>PyInstallerPlugin.__pyinstaller</h4> +<b>__pyinstaller</b>(<i></i>) +<p> + Private slot to execute the pyinstaller command for the current + project. +</p><a NAME="PyInstallerPlugin.__pyinstallerCleanup" ID="PyInstallerPlugin.__pyinstallerCleanup"></a> +<h4>PyInstallerPlugin.__pyinstallerCleanup</h4> +<b>__pyinstallerCleanup</b>(<i></i>) +<p> + Private slot to remove the directories created by pyinstaller. +</p><a NAME="PyInstallerPlugin.activate" ID="PyInstallerPlugin.activate"></a> +<h4>PyInstallerPlugin.activate</h4> +<b>activate</b>(<i></i>) +<p> + Public method to activate this plug-in. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple of None and activation status (boolean) +</dd> +</dl><a NAME="PyInstallerPlugin.deactivate" ID="PyInstallerPlugin.deactivate"></a> +<h4>PyInstallerPlugin.deactivate</h4> +<b>deactivate</b>(<i></i>) +<p> + Public method to deactivate this plug-in. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="_checkProgram" ID="_checkProgram"></a> +<h2>_checkProgram</h2> +<b>_checkProgram</b>(<i></i>) +<p> + Restricted function to check the availability of pyinstaller. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating availability (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="_findExecutable" ID="_findExecutable"></a> +<h2>_findExecutable</h2> +<b>_findExecutable</b>(<i>majorVersion</i>) +<p> + Restricted function to determine the names of the executables. +</p><dl> +<dt><i>majorVersion</i> (int)</dt> +<dd> +major python version +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +names of the executables +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a> +<h2>exeDisplayDataList</h2> +<b>exeDisplayDataList</b>(<i></i>) +<p> + Module function to support the display of some executable info. +</p><dl> +<dt>Returns:</dt> +<dd> +list of dictionaries containing the data to query the presence of + the executable +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +list of dict +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getExePath" ID="getExePath"></a> +<h2>getExePath</h2> +<b>getExePath</b>(<i>branch, access, versionStr</i>) + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
diff -r ba5a623378ec -r 43ef722c3873 PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PyInstaller.PyInstallerCleanupDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PyInstaller.PyInstallerCleanupDialog.html Sat Jan 20 17:06:15 2018 +0100 @@ -0,0 +1,99 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Packager_PyInstaller.PyInstaller.PyInstallerCleanupDialog</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_Packager_PyInstaller.PyInstaller.PyInstallerCleanupDialog</h1> +<p> +Module implementing a dialog to select the cleanup action. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PyInstallerCleanupDialog">PyInstallerCleanupDialog</a></td> +<td>Class implementing a dialog to select the cleanup action.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PyInstallerCleanupDialog" ID="PyInstallerCleanupDialog"></a> +<h2>PyInstallerCleanupDialog</h2> +<p> + Class implementing a dialog to select the cleanup action. +</p> +<h3>Derived from</h3> +QDialog, Ui_PyInstallerCleanupDialog +<h3>Class Attributes</h3> +<table> +<tr><td>BuildPath</td></tr><tr><td>DistPath</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#PyInstallerCleanupDialog.__init__">PyInstallerCleanupDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PyInstallerCleanupDialog.getDirectories">getDirectories</a></td> +<td>Public method to get the project relative directories to be cleaned.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PyInstallerCleanupDialog.__init__" ID="PyInstallerCleanupDialog.__init__"></a> +<h4>PyInstallerCleanupDialog (Constructor)</h4> +<b>PyInstallerCleanupDialog</b>(<i>parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl><a NAME="PyInstallerCleanupDialog.getDirectories" ID="PyInstallerCleanupDialog.getDirectories"></a> +<h4>PyInstallerCleanupDialog.getDirectories</h4> +<b>getDirectories</b>(<i></i>) +<p> + Public method to get the project relative directories to be cleaned. +</p><dl> +<dt>Returns:</dt> +<dd> +list of directories to be removed +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
diff -r ba5a623378ec -r 43ef722c3873 PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PyInstaller.PyInstallerConfigDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PyInstaller.PyInstallerConfigDialog.html Sat Jan 20 17:06:15 2018 +0100 @@ -0,0 +1,198 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Packager_PyInstaller.PyInstaller.PyInstallerConfigDialog</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_Packager_PyInstaller.PyInstaller.PyInstallerConfigDialog</h1> +<p> +Module implementing PyInstallerConfigDialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PyInstallerConfigDialog">PyInstallerConfigDialog</a></td> +<td>Class implementing a dialog to enter the parameters for pyinstaller and pyi-makespec.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PyInstallerConfigDialog" ID="PyInstallerConfigDialog"></a> +<h2>PyInstallerConfigDialog</h2> +<p> + Class implementing a dialog to enter the parameters for pyinstaller + and pyi-makespec. +</p> +<h3>Derived from</h3> +QDialog, Ui_PyInstallerConfigDialog +<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="#PyInstallerConfigDialog.__init__">PyInstallerConfigDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.__initializeDefaults">__initializeDefaults</a></td> +<td>Private method to set the default values.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.__updateOkButton">__updateOkButton</a></td> +<td>Private method to update the enabled state of the OK button.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.accept">accept</a></td> +<td>Public method called by the Ok button.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.generateParameters">generateParameters</a></td> +<td>Public method that generates the command line parameters.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.on_iconFilePicker_textChanged">on_iconFilePicker_textChanged</a></td> +<td>Private slot to handle changes of the icon file.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.on_iconIdEdit_textChanged">on_iconIdEdit_textChanged</a></td> +<td>Private slot to handle changes of the icon ID.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.on_inputFilePicker_textChanged">on_inputFilePicker_textChanged</a></td> +<td>Private slot to handle changes of the input file.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.on_selectedScriptButton_toggled">on_selectedScriptButton_toggled</a></td> +<td>Private slot to handle changes of the radio button state.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PyInstallerConfigDialog.__init__" ID="PyInstallerConfigDialog.__init__"></a> +<h4>PyInstallerConfigDialog (Constructor)</h4> +<b>PyInstallerConfigDialog</b>(<i>project, executables, params=None, mode="installer", parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>project</i> (Project.Project)</dt> +<dd> +reference to the project object +</dd><dt><i>executables</i> (list of str)</dt> +<dd> +names of the pyinstaller executables +</dd><dt><i>params</i> (dict)</dt> +<dd> +parameters to set in the dialog +</dd><dt><i>mode</i> (str (one of 'installer' or 'spec'))</dt> +<dd> +mode of the dialog +</dd><dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl><a NAME="PyInstallerConfigDialog.__initializeDefaults" ID="PyInstallerConfigDialog.__initializeDefaults"></a> +<h4>PyInstallerConfigDialog.__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 command line parameters. +</p><a NAME="PyInstallerConfigDialog.__updateOkButton" ID="PyInstallerConfigDialog.__updateOkButton"></a> +<h4>PyInstallerConfigDialog.__updateOkButton</h4> +<b>__updateOkButton</b>(<i></i>) +<p> + Private method to update the enabled state of the OK button. +</p><a NAME="PyInstallerConfigDialog.accept" ID="PyInstallerConfigDialog.accept"></a> +<h4>PyInstallerConfigDialog.accept</h4> +<b>accept</b>(<i></i>) +<p> + Public method called by the Ok button. +</p><p> + It saves the values in the parameters dictionary. +</p><a NAME="PyInstallerConfigDialog.generateParameters" ID="PyInstallerConfigDialog.generateParameters"></a> +<h4>PyInstallerConfigDialog.generateParameters</h4> +<b>generateParameters</b>(<i></i>) +<p> + Public method that generates the command line parameters. +</p><p> + It generates a list of strings to be used to set the QProcess arguments + for the pyinstaller/pyi-makespec 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><dl> +<dt>Returns:</dt> +<dd> +a tuple of the command line parameters, non default parameters + and the script path +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, dict, str) +</dd> +</dl><a NAME="PyInstallerConfigDialog.on_iconFilePicker_textChanged" ID="PyInstallerConfigDialog.on_iconFilePicker_textChanged"></a> +<h4>PyInstallerConfigDialog.on_iconFilePicker_textChanged</h4> +<b>on_iconFilePicker_textChanged</b>(<i>txt</i>) +<p> + Private slot to handle changes of the icon file. +</p><dl> +<dt><i>txt</i> (str)</dt> +<dd> +text of the file edit +</dd> +</dl><a NAME="PyInstallerConfigDialog.on_iconIdEdit_textChanged" ID="PyInstallerConfigDialog.on_iconIdEdit_textChanged"></a> +<h4>PyInstallerConfigDialog.on_iconIdEdit_textChanged</h4> +<b>on_iconIdEdit_textChanged</b>(<i>txt</i>) +<p> + Private slot to handle changes of the icon ID. +</p><dl> +<dt><i>txt</i> (str)</dt> +<dd> +iconID +</dd> +</dl><a NAME="PyInstallerConfigDialog.on_inputFilePicker_textChanged" ID="PyInstallerConfigDialog.on_inputFilePicker_textChanged"></a> +<h4>PyInstallerConfigDialog.on_inputFilePicker_textChanged</h4> +<b>on_inputFilePicker_textChanged</b>(<i>txt</i>) +<p> + Private slot to handle changes of the input file. +</p><dl> +<dt><i>txt</i> (str)</dt> +<dd> +text of the file edit +</dd> +</dl><a NAME="PyInstallerConfigDialog.on_selectedScriptButton_toggled" ID="PyInstallerConfigDialog.on_selectedScriptButton_toggled"></a> +<h4>PyInstallerConfigDialog.on_selectedScriptButton_toggled</h4> +<b>on_selectedScriptButton_toggled</b>(<i>checked</i>) +<p> + Private slot to handle changes of the radio button state. +</p><dl> +<dt><i>checked</i> (bool)</dt> +<dd> +state of the radio button +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
diff -r ba5a623378ec -r 43ef722c3873 PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PyInstaller.PyInstallerExecDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PyInstaller.PyInstallerExecDialog.html Sat Jan 20 17:06:15 2018 +0100 @@ -0,0 +1,190 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Packager_PyInstaller.PyInstaller.PyInstallerExecDialog</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_Packager_PyInstaller.PyInstaller.PyInstallerExecDialog</h1> +<p> +Module implementing a dialog to show the output of the pyinstaller/pyi-makespec +process. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PyInstallerExecDialog">PyInstallerExecDialog</a></td> +<td>Class implementing a dialog to show the output of the pyinstaller/pyi-makespec process.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PyInstallerExecDialog" ID="PyInstallerExecDialog"></a> +<h2>PyInstallerExecDialog</h2> +<p> + Class implementing a dialog to show the output of the + pyinstaller/pyi-makespec process. +</p><p> + This class starts a QProcess and displays a dialog that + shows the output of the packager command process. +</p> +<h3>Derived from</h3> +QDialog, Ui_PyInstallerExecDialog +<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="#PyInstallerExecDialog.__init__">PyInstallerExecDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.__enableButtons">__enableButtons</a></td> +<td>Private slot called when all processes finished.</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.__finish">__finish</a></td> +<td>Private slot called when the process was canceled by the user.</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.__finishedProcess">__finishedProcess</a></td> +<td>Private slot called when the process finished.</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.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="#PyInstallerExecDialog.start">start</a></td> +<td>Public slot to start the packager command.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PyInstallerExecDialog.__init__" ID="PyInstallerExecDialog.__init__"></a> +<h4>PyInstallerExecDialog (Constructor)</h4> +<b>PyInstallerExecDialog</b>(<i>cmdname, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>cmdname</i> (str)</dt> +<dd> +name of the packager +</dd><dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl><a NAME="PyInstallerExecDialog.__enableButtons" ID="PyInstallerExecDialog.__enableButtons"></a> +<h4>PyInstallerExecDialog.__enableButtons</h4> +<b>__enableButtons</b>(<i></i>) +<p> + Private slot called when all processes finished. +</p><p> + It is called when the process finished or + the user pressed the cancel button. +</p><a NAME="PyInstallerExecDialog.__finish" ID="PyInstallerExecDialog.__finish"></a> +<h4>PyInstallerExecDialog.__finish</h4> +<b>__finish</b>(<i></i>) +<p> + Private slot called when the process was canceled by the user. +</p><p> + It is called when the process finished or + the user pressed the cancel button. +</p><a NAME="PyInstallerExecDialog.__finishedProcess" ID="PyInstallerExecDialog.__finishedProcess"></a> +<h4>PyInstallerExecDialog.__finishedProcess</h4> +<b>__finishedProcess</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 cancel button. +</p><a NAME="PyInstallerExecDialog.__readStderr" ID="PyInstallerExecDialog.__readStderr"></a> +<h4>PyInstallerExecDialog.__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="PyInstallerExecDialog.__readStdout" ID="PyInstallerExecDialog.__readStdout"></a> +<h4>PyInstallerExecDialog.__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="PyInstallerExecDialog.on_buttonBox_clicked" ID="PyInstallerExecDialog.on_buttonBox_clicked"></a> +<h4>PyInstallerExecDialog.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="PyInstallerExecDialog.start" ID="PyInstallerExecDialog.start"></a> +<h4>PyInstallerExecDialog.start</h4> +<b>start</b>(<i>args, parms, project, script</i>) +<p> + Public slot to start the packager command. +</p><dl> +<dt><i>args</i> (list of str)</dt> +<dd> +command line arguments for packager program +</dd><dt><i>parms</i> (dict)</dt> +<dd> +parameters got from the config dialog +</dd><dt><i>project</i> (Project)</dt> +<dd> +reference to the project object +</dd><dt><i>script</i> (str)</dt> +<dd> +script or spec file name to be processed by by the + packager +</dd> +</dl><dl> +<dt>Returns:</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
diff -r ba5a623378ec -r 43ef722c3873 PyInstaller/Documentation/source/index-Plugin_Packager_PyInstaller.PyInstaller.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyInstaller/Documentation/source/index-Plugin_Packager_PyInstaller.PyInstaller.html Sat Jan 20 17:06:15 2018 +0100 @@ -0,0 +1,41 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Packager_PyInstaller.PyInstaller</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_Packager_PyInstaller.PyInstaller</h1> +<p> +Package containing dialogs of the PyInstaller interface plug-in. +</p> + + +<h3>Modules</h3> +<table> +<tr> +<td><a href="Plugin_Packager_PyInstaller.PyInstaller.PyInstallerCleanupDialog.html">PyInstallerCleanupDialog</a></td> +<td>Module implementing a dialog to select the cleanup action.</td> +</tr><tr> +<td><a href="Plugin_Packager_PyInstaller.PyInstaller.PyInstallerConfigDialog.html">PyInstallerConfigDialog</a></td> +<td>Module implementing PyInstallerConfigDialog.</td> +</tr><tr> +<td><a href="Plugin_Packager_PyInstaller.PyInstaller.PyInstallerExecDialog.html">PyInstallerExecDialog</a></td> +<td>Module implementing a dialog to show the output of the pyinstaller/pyi-makespec process.</td> +</tr> +</table> +</body></html> \ No newline at end of file
diff -r ba5a623378ec -r 43ef722c3873 PyInstaller/Documentation/source/index-Plugin_Packager_PyInstaller.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyInstaller/Documentation/source/index-Plugin_Packager_PyInstaller.html Sat Jan 20 17:06:15 2018 +0100 @@ -0,0 +1,42 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Packager_PyInstaller</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_Packager_PyInstaller</h1> +<p> +Package containing the PyInstaller interface plug-in. +</p> + +<h3>Packages</h3> +<table> +<tr> +<td><a href="index-Plugin_Packager_PyInstaller.PyInstaller.html">PyInstaller</a></td> +<td>Package containing dialogs of the PyInstaller interface plug-in.</td> +</tr> +</table> + +<h3>Modules</h3> +<table> +<tr> +<td><a href="Plugin_Packager_PyInstaller.PluginPyInstaller.html">PluginPyInstaller</a></td> +<td>Module implementing the PyInstaller interface plug-in.</td> +</tr> +</table> +</body></html> \ No newline at end of file
diff -r ba5a623378ec -r 43ef722c3873 PyInstaller/Documentation/source/index.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyInstaller/Documentation/source/index.html Sat Jan 20 17:06:15 2018 +0100 @@ -0,0 +1,33 @@ +<!DOCTYPE html> +<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> +</head> +<body> +<h1>Table of contents</h1> + + +<h3>Packages</h3> +<table> +<tr> +<td><a href="index-Plugin_Packager_PyInstaller.html">Plugin_Packager_PyInstaller</a></td> +<td>Package containing the PyInstaller interface plug-in.</td> +</tr> +</table> + +</body></html> \ No newline at end of file