Mercurial Repositories > PyInstaller Interface / file comparison

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

PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PluginPyInstaller.html

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

Mercurial Repository: PyInstaller Interface

eric ide

mercurial