Mercurial Repositories > PyInstaller Interface / file comparison

comparison: PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PluginPyInstaller.html

PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PluginPyInstaller.html

changeset 28
3c8dbc198753
parent 9
43ef722c3873
child 35
d9b3cadaf707
equal deleted inserted replaced
27:25ff8953e335 28:3c8dbc198753
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Packager_PyInstaller.PluginPyInstaller</h1> 23 <h1>Plugin_Packager_PyInstaller.PluginPyInstaller</h1>
24
23 <p> 25 <p>
24 Module implementing the PyInstaller interface plug-in. 26 Module implementing the PyInstaller interface plug-in.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
27 <table> 29
28 <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> 30 <table>
31 <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>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#PyInstallerPlugin">PyInstallerPlugin</a></td> 38 <td><a href="#PyInstallerPlugin">PyInstallerPlugin</a></td>
34 <td>Class implementing the PyInstaller interface plug-in.</td> 39 <td>Class implementing the PyInstaller interface plug-in.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
44 <table>
45
39 <tr> 46 <tr>
40 <td><a href="#_checkProgram">_checkProgram</a></td> 47 <td><a href="#_checkProgram">_checkProgram</a></td>
41 <td>Restricted function to check the availability of pyinstaller.</td> 48 <td>Restricted function to check the availability of pyinstaller.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#_findExecutable">_findExecutable</a></td> 51 <td><a href="#_findExecutable">_findExecutable</a></td>
44 <td>Restricted function to determine the names of the executables.</td> 52 <td>Restricted function to determine the names of the executables.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td> 55 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td>
47 <td>Module function to support the display of some executable info.</td> 56 <td>Module function to support the display of some executable info.</td>
48 </tr><tr> 57 </tr>
58 <tr>
49 <td><a href="#getExePath">getExePath</a></td> 59 <td><a href="#getExePath">getExePath</a></td>
50 <td></td> 60 <td></td>
51 </tr> 61 </tr>
52 </table> 62 </table>
53 <hr /><hr /> 63 <hr />
64 <hr />
54 <a NAME="PyInstallerPlugin" ID="PyInstallerPlugin"></a> 65 <a NAME="PyInstallerPlugin" ID="PyInstallerPlugin"></a>
55 <h2>PyInstallerPlugin</h2> 66 <h2>PyInstallerPlugin</h2>
67
56 <p> 68 <p>
57 Class implementing the PyInstaller interface plug-in. 69 Class implementing the PyInstaller interface plug-in.
58 </p> 70 </p>
59 <h3>Derived from</h3> 71 <h3>Derived from</h3>
60 QObject 72 QObject
61 <h3>Class Attributes</h3> 73 <h3>Class Attributes</h3>
74
62 <table> 75 <table>
63 <tr><td>None</td></tr> 76 <tr><td>None</td></tr>
64 </table> 77 </table>
65 <h3>Class Methods</h3> 78 <h3>Class Methods</h3>
79
66 <table> 80 <table>
67 <tr><td>None</td></tr> 81 <tr><td>None</td></tr>
68 </table> 82 </table>
69 <h3>Methods</h3> 83 <h3>Methods</h3>
70 <table> 84
85 <table>
86
71 <tr> 87 <tr>
72 <td><a href="#PyInstallerPlugin.__init__">PyInstallerPlugin</a></td> 88 <td><a href="#PyInstallerPlugin.__init__">PyInstallerPlugin</a></td>
73 <td>Constructor</td> 89 <td>Constructor</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#PyInstallerPlugin.__initialize">__initialize</a></td> 92 <td><a href="#PyInstallerPlugin.__initialize">__initialize</a></td>
76 <td>Private slot to (re)initialize the plug-in.</td> 93 <td>Private slot to (re)initialize the plug-in.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#PyInstallerPlugin.__loadTranslator">__loadTranslator</a></td> 96 <td><a href="#PyInstallerPlugin.__loadTranslator">__loadTranslator</a></td>
79 <td>Private method to load the translation file.</td> 97 <td>Private method to load the translation file.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#PyInstallerPlugin.__projectShowMenu">__projectShowMenu</a></td> 100 <td><a href="#PyInstallerPlugin.__projectShowMenu">__projectShowMenu</a></td>
82 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> 101 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#PyInstallerPlugin.__pyiMakeSpec">__pyiMakeSpec</a></td> 104 <td><a href="#PyInstallerPlugin.__pyiMakeSpec">__pyiMakeSpec</a></td>
85 <td>Private slot to execute the pyi-makespec command for the current project to generate a spec file to be used by pyinstaller.</td> 105 <td>Private slot to execute the pyi-makespec command for the current project to generate a spec file to be used by pyinstaller.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#PyInstallerPlugin.__pyinstaller">__pyinstaller</a></td> 108 <td><a href="#PyInstallerPlugin.__pyinstaller">__pyinstaller</a></td>
88 <td>Private slot to execute the pyinstaller command for the current project.</td> 109 <td>Private slot to execute the pyinstaller command for the current project.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#PyInstallerPlugin.__pyinstallerCleanup">__pyinstallerCleanup</a></td> 112 <td><a href="#PyInstallerPlugin.__pyinstallerCleanup">__pyinstallerCleanup</a></td>
91 <td>Private slot to remove the directories created by pyinstaller.</td> 113 <td>Private slot to remove the directories created by pyinstaller.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#PyInstallerPlugin.activate">activate</a></td> 116 <td><a href="#PyInstallerPlugin.activate">activate</a></td>
94 <td>Public method to activate this plug-in.</td> 117 <td>Public method to activate this plug-in.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#PyInstallerPlugin.deactivate">deactivate</a></td> 120 <td><a href="#PyInstallerPlugin.deactivate">deactivate</a></td>
97 <td>Public method to deactivate this plug-in.</td> 121 <td>Public method to deactivate this plug-in.</td>
98 </tr> 122 </tr>
99 </table> 123 </table>
100 <h3>Static Methods</h3> 124 <h3>Static Methods</h3>
125
101 <table> 126 <table>
102 <tr><td>None</td></tr> 127 <tr><td>None</td></tr>
103 </table> 128 </table>
129
104 <a NAME="PyInstallerPlugin.__init__" ID="PyInstallerPlugin.__init__"></a> 130 <a NAME="PyInstallerPlugin.__init__" ID="PyInstallerPlugin.__init__"></a>
105 <h4>PyInstallerPlugin (Constructor)</h4> 131 <h4>PyInstallerPlugin (Constructor)</h4>
106 <b>PyInstallerPlugin</b>(<i>ui</i>) 132 <b>PyInstallerPlugin</b>(<i>ui</i>)
133
107 <p> 134 <p>
108 Constructor 135 Constructor
109 </p><dl> 136 </p>
137 <dl>
138
110 <dt><i>ui</i> (UI.UserInterface)</dt> 139 <dt><i>ui</i> (UI.UserInterface)</dt>
111 <dd> 140 <dd>
112 reference to the user interface object 141 reference to the user interface object
113 </dd> 142 </dd>
114 </dl><a NAME="PyInstallerPlugin.__initialize" ID="PyInstallerPlugin.__initialize"></a> 143 </dl>
144 <a NAME="PyInstallerPlugin.__initialize" ID="PyInstallerPlugin.__initialize"></a>
115 <h4>PyInstallerPlugin.__initialize</h4> 145 <h4>PyInstallerPlugin.__initialize</h4>
116 <b>__initialize</b>(<i></i>) 146 <b>__initialize</b>(<i></i>)
147
117 <p> 148 <p>
118 Private slot to (re)initialize the plug-in. 149 Private slot to (re)initialize the plug-in.
119 </p><a NAME="PyInstallerPlugin.__loadTranslator" ID="PyInstallerPlugin.__loadTranslator"></a> 150 </p>
151 <a NAME="PyInstallerPlugin.__loadTranslator" ID="PyInstallerPlugin.__loadTranslator"></a>
120 <h4>PyInstallerPlugin.__loadTranslator</h4> 152 <h4>PyInstallerPlugin.__loadTranslator</h4>
121 <b>__loadTranslator</b>(<i></i>) 153 <b>__loadTranslator</b>(<i></i>)
154
122 <p> 155 <p>
123 Private method to load the translation file. 156 Private method to load the translation file.
124 </p><a NAME="PyInstallerPlugin.__projectShowMenu" ID="PyInstallerPlugin.__projectShowMenu"></a> 157 </p>
158 <a NAME="PyInstallerPlugin.__projectShowMenu" ID="PyInstallerPlugin.__projectShowMenu"></a>
125 <h4>PyInstallerPlugin.__projectShowMenu</h4> 159 <h4>PyInstallerPlugin.__projectShowMenu</h4>
126 <b>__projectShowMenu</b>(<i>menuName, menu</i>) 160 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
161
127 <p> 162 <p>
128 Private slot called, when the the project menu or a submenu is 163 Private slot called, when the the project menu or a submenu is
129 about to be shown. 164 about to be shown.
130 </p><dl> 165 </p>
166 <dl>
167
131 <dt><i>menuName</i> (str)</dt> 168 <dt><i>menuName</i> (str)</dt>
132 <dd> 169 <dd>
133 name of the menu to be shown 170 name of the menu to be shown
134 </dd><dt><i>menu</i> (QMenu)</dt> 171 </dd>
172 <dt><i>menu</i> (QMenu)</dt>
135 <dd> 173 <dd>
136 reference to the menu 174 reference to the menu
137 </dd> 175 </dd>
138 </dl><a NAME="PyInstallerPlugin.__pyiMakeSpec" ID="PyInstallerPlugin.__pyiMakeSpec"></a> 176 </dl>
177 <a NAME="PyInstallerPlugin.__pyiMakeSpec" ID="PyInstallerPlugin.__pyiMakeSpec"></a>
139 <h4>PyInstallerPlugin.__pyiMakeSpec</h4> 178 <h4>PyInstallerPlugin.__pyiMakeSpec</h4>
140 <b>__pyiMakeSpec</b>(<i></i>) 179 <b>__pyiMakeSpec</b>(<i></i>)
180
141 <p> 181 <p>
142 Private slot to execute the pyi-makespec command for the current 182 Private slot to execute the pyi-makespec command for the current
143 project to generate a spec file to be used by pyinstaller. 183 project to generate a spec file to be used by pyinstaller.
144 </p><a NAME="PyInstallerPlugin.__pyinstaller" ID="PyInstallerPlugin.__pyinstaller"></a> 184 </p>
185 <a NAME="PyInstallerPlugin.__pyinstaller" ID="PyInstallerPlugin.__pyinstaller"></a>
145 <h4>PyInstallerPlugin.__pyinstaller</h4> 186 <h4>PyInstallerPlugin.__pyinstaller</h4>
146 <b>__pyinstaller</b>(<i></i>) 187 <b>__pyinstaller</b>(<i></i>)
188
147 <p> 189 <p>
148 Private slot to execute the pyinstaller command for the current 190 Private slot to execute the pyinstaller command for the current
149 project. 191 project.
150 </p><a NAME="PyInstallerPlugin.__pyinstallerCleanup" ID="PyInstallerPlugin.__pyinstallerCleanup"></a> 192 </p>
193 <a NAME="PyInstallerPlugin.__pyinstallerCleanup" ID="PyInstallerPlugin.__pyinstallerCleanup"></a>
151 <h4>PyInstallerPlugin.__pyinstallerCleanup</h4> 194 <h4>PyInstallerPlugin.__pyinstallerCleanup</h4>
152 <b>__pyinstallerCleanup</b>(<i></i>) 195 <b>__pyinstallerCleanup</b>(<i></i>)
196
153 <p> 197 <p>
154 Private slot to remove the directories created by pyinstaller. 198 Private slot to remove the directories created by pyinstaller.
155 </p><a NAME="PyInstallerPlugin.activate" ID="PyInstallerPlugin.activate"></a> 199 </p>
200 <a NAME="PyInstallerPlugin.activate" ID="PyInstallerPlugin.activate"></a>
156 <h4>PyInstallerPlugin.activate</h4> 201 <h4>PyInstallerPlugin.activate</h4>
157 <b>activate</b>(<i></i>) 202 <b>activate</b>(<i></i>)
203
158 <p> 204 <p>
159 Public method to activate this plug-in. 205 Public method to activate this plug-in.
160 </p><dl> 206 </p>
207 <dl>
161 <dt>Returns:</dt> 208 <dt>Returns:</dt>
162 <dd> 209 <dd>
163 tuple of None and activation status (boolean) 210 tuple of None and activation status (boolean)
164 </dd> 211 </dd>
165 </dl><a NAME="PyInstallerPlugin.deactivate" ID="PyInstallerPlugin.deactivate"></a> 212 </dl>
213 <a NAME="PyInstallerPlugin.deactivate" ID="PyInstallerPlugin.deactivate"></a>
166 <h4>PyInstallerPlugin.deactivate</h4> 214 <h4>PyInstallerPlugin.deactivate</h4>
167 <b>deactivate</b>(<i></i>) 215 <b>deactivate</b>(<i></i>)
216
168 <p> 217 <p>
169 Public method to deactivate this plug-in. 218 Public method to deactivate this plug-in.
170 </p> 219 </p>
171 <div align="right"><a href="#top">Up</a></div> 220 <div align="right"><a href="#top">Up</a></div>
172 <hr /><hr /> 221 <hr />
222 <hr />
173 <a NAME="_checkProgram" ID="_checkProgram"></a> 223 <a NAME="_checkProgram" ID="_checkProgram"></a>
174 <h2>_checkProgram</h2> 224 <h2>_checkProgram</h2>
175 <b>_checkProgram</b>(<i></i>) 225 <b>_checkProgram</b>(<i></i>)
226
176 <p> 227 <p>
177 Restricted function to check the availability of pyinstaller. 228 Restricted function to check the availability of pyinstaller.
178 </p><dl> 229 </p>
230 <dl>
179 <dt>Returns:</dt> 231 <dt>Returns:</dt>
180 <dd> 232 <dd>
181 flag indicating availability (boolean) 233 flag indicating availability (boolean)
182 </dd> 234 </dd>
183 </dl> 235 </dl>
184 <div align="right"><a href="#top">Up</a></div> 236 <div align="right"><a href="#top">Up</a></div>
185 <hr /><hr /> 237 <hr />
238 <hr />
186 <a NAME="_findExecutable" ID="_findExecutable"></a> 239 <a NAME="_findExecutable" ID="_findExecutable"></a>
187 <h2>_findExecutable</h2> 240 <h2>_findExecutable</h2>
188 <b>_findExecutable</b>(<i>majorVersion</i>) 241 <b>_findExecutable</b>(<i>majorVersion</i>)
242
189 <p> 243 <p>
190 Restricted function to determine the names of the executables. 244 Restricted function to determine the names of the executables.
191 </p><dl> 245 </p>
246 <dl>
247
192 <dt><i>majorVersion</i> (int)</dt> 248 <dt><i>majorVersion</i> (int)</dt>
193 <dd> 249 <dd>
194 major python version 250 major python version
195 </dd> 251 </dd>
196 </dl><dl> 252 </dl>
253 <dl>
197 <dt>Returns:</dt> 254 <dt>Returns:</dt>
198 <dd> 255 <dd>
199 names of the executables 256 names of the executables
200 </dd> 257 </dd>
201 </dl><dl> 258 </dl>
259 <dl>
202 <dt>Return Type:</dt> 260 <dt>Return Type:</dt>
203 <dd> 261 <dd>
204 list of str 262 list of str
205 </dd> 263 </dd>
206 </dl> 264 </dl>
207 <div align="right"><a href="#top">Up</a></div> 265 <div align="right"><a href="#top">Up</a></div>
208 <hr /><hr /> 266 <hr />
267 <hr />
209 <a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a> 268 <a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a>
210 <h2>exeDisplayDataList</h2> 269 <h2>exeDisplayDataList</h2>
211 <b>exeDisplayDataList</b>(<i></i>) 270 <b>exeDisplayDataList</b>(<i></i>)
271
212 <p> 272 <p>
213 Module function to support the display of some executable info. 273 Module function to support the display of some executable info.
214 </p><dl> 274 </p>
275 <dl>
215 <dt>Returns:</dt> 276 <dt>Returns:</dt>
216 <dd> 277 <dd>
217 list of dictionaries containing the data to query the presence of 278 list of dictionaries containing the data to query the presence of
218 the executable 279 the executable
219 </dd> 280 </dd>
220 </dl><dl> 281 </dl>
282 <dl>
221 <dt>Return Type:</dt> 283 <dt>Return Type:</dt>
222 <dd> 284 <dd>
223 list of dict 285 list of dict
224 </dd> 286 </dd>
225 </dl> 287 </dl>
226 <div align="right"><a href="#top">Up</a></div> 288 <div align="right"><a href="#top">Up</a></div>
227 <hr /><hr /> 289 <hr />
290 <hr />
228 <a NAME="getExePath" ID="getExePath"></a> 291 <a NAME="getExePath" ID="getExePath"></a>
229 <h2>getExePath</h2> 292 <h2>getExePath</h2>
230 <b>getExePath</b>(<i>branch, access, versionStr</i>) 293 <b>getExePath</b>(<i>branch, access, versionStr</i>)
231 294
232 <div align="right"><a href="#top">Up</a></div> 295 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: PyInstaller Interface

eric ide

mercurial