PyInstallerInterface/Documentation/source/Plugin_Packager_PyInstaller.PluginPyInstaller.html

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

eric ide

mercurial