Mercurial Repositories > PyInstaller Interface / file comparison

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

PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PluginPyInstaller.html

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

Mercurial Repository: PyInstaller Interface

eric ide

mercurial