PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PluginPyInstaller.html

changeset 28
3c8dbc198753
parent 9
43ef722c3873
child 35
d9b3cadaf707
--- a/PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PluginPyInstaller.html	Mon May 04 18:15:28 2020 +0200
+++ b/PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PluginPyInstaller.html	Tue Jun 23 19:14:07 2020 +0200
@@ -18,213 +18,276 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<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>
+<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>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>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>
+</tr>
+<tr>
 <td><a href="#_findExecutable">_findExecutable</a></td>
 <td>Restricted function to determine the names of the executables.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td>
 <td>Module function to support the display of some executable info.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#getExePath">getExePath</a></td>
 <td></td>
 </tr>
 </table>
-<hr /><hr />
+<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>
+</tr>
+<tr>
 <td><a href="#PyInstallerPlugin.__initialize">__initialize</a></td>
 <td>Private slot to (re)initialize the plug-in.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PyInstallerPlugin.__loadTranslator">__loadTranslator</a></td>
 <td>Private method to load the translation file.</td>
-</tr><tr>
+</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>
+</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>
+</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>
+</tr>
+<tr>
 <td><a href="#PyInstallerPlugin.__pyinstallerCleanup">__pyinstallerCleanup</a></td>
 <td>Private slot to remove the directories created by pyinstaller.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PyInstallerPlugin.activate">activate</a></td>
 <td>Public method to activate this plug-in.</td>
-</tr><tr>
+</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>
+</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>
+</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>
+</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>
+</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>
+</p>
+<dl>
+
 <dt><i>menuName</i> (str)</dt>
 <dd>
 name of the menu to be shown
-</dd><dt><i>menu</i> (QMenu)</dt>
+</dd>
+<dt><i>menu</i> (QMenu)</dt>
 <dd>
 reference to the menu
 </dd>
-</dl><a NAME="PyInstallerPlugin.__pyiMakeSpec" ID="PyInstallerPlugin.__pyiMakeSpec"></a>
+</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>
+</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>
+</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>
+</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>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 tuple of None and activation status (boolean)
 </dd>
-</dl><a NAME="PyInstallerPlugin.deactivate" ID="PyInstallerPlugin.deactivate"></a>
+</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 />
+<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>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating availability (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<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>
+</p>
+<dl>
+
 <dt><i>majorVersion</i> (int)</dt>
 <dd>
 major python version
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 names of the executables
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 list of str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<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>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 list of dictionaries containing the data to query the presence of
         the executable
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 list of dict
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="getExePath" ID="getExePath"></a>
 <h2>getExePath</h2>
 <b>getExePath</b>(<i>branch, access, versionStr</i>)

eric ide

mercurial