|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>Plugin_Project_Django.ProjectDjango.Project</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_Project_Django.ProjectDjango.Project</h1> |
|
23 <p> |
|
24 Module implementing the Django project support. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#DjangoNoSiteSelectedException">DjangoNoSiteSelectedException</a></td> |
|
34 <td>Exception thrown to signal, that there is no current site.</td> |
|
35 </tr><tr> |
|
36 <td><a href="#Project">Project</a></td> |
|
37 <td>Class implementing the Django project support.</td> |
|
38 </tr> |
|
39 </table> |
|
40 <h3>Functions</h3> |
|
41 <table> |
|
42 <tr><td>None</td></tr> |
|
43 </table> |
|
44 <hr /><hr /> |
|
45 <a NAME="DjangoNoSiteSelectedException" ID="DjangoNoSiteSelectedException"></a> |
|
46 <h2>DjangoNoSiteSelectedException</h2> |
|
47 <p> |
|
48 Exception thrown to signal, that there is no current site. |
|
49 </p> |
|
50 <h3>Derived from</h3> |
|
51 Exception |
|
52 <h3>Class Attributes</h3> |
|
53 <table> |
|
54 <tr><td>None</td></tr> |
|
55 </table> |
|
56 <h3>Class Methods</h3> |
|
57 <table> |
|
58 <tr><td>None</td></tr> |
|
59 </table> |
|
60 <h3>Methods</h3> |
|
61 <table> |
|
62 <tr><td>None</td></tr> |
|
63 </table> |
|
64 <h3>Static Methods</h3> |
|
65 <table> |
|
66 <tr><td>None</td></tr> |
|
67 </table> |
|
68 |
|
69 <div align="right"><a href="#top">Up</a></div> |
|
70 <hr /><hr /> |
|
71 <a NAME="Project" ID="Project"></a> |
|
72 <h2>Project</h2> |
|
73 <p> |
|
74 Class implementing the Django project support. |
|
75 </p> |
|
76 <h3>Derived from</h3> |
|
77 QObject |
|
78 <h3>Class Attributes</h3> |
|
79 <table> |
|
80 <tr><td>RecentApplicationsKey</td></tr> |
|
81 </table> |
|
82 <h3>Class Methods</h3> |
|
83 <table> |
|
84 <tr><td>None</td></tr> |
|
85 </table> |
|
86 <h3>Methods</h3> |
|
87 <table> |
|
88 <tr> |
|
89 <td><a href="#Project.__init__">Project</a></td> |
|
90 <td>Constructor</td> |
|
91 </tr><tr> |
|
92 <td><a href="#Project.__cleanup">__cleanup</a></td> |
|
93 <td>Private slot to clean out old data from the database.</td> |
|
94 </tr><tr> |
|
95 <td><a href="#Project.__createApplication">__createApplication</a></td> |
|
96 <td>Private slot to create a new Django application.</td> |
|
97 </tr><tr> |
|
98 <td><a href="#Project.__createCacheTables">__createCacheTables</a></td> |
|
99 <td>Private slot to create the tables for the SQL caching backend.</td> |
|
100 </tr><tr> |
|
101 <td><a href="#Project.__createProject">__createProject</a></td> |
|
102 <td>Private slot to create a new Django project.</td> |
|
103 </tr><tr> |
|
104 <td><a href="#Project.__databaseFlush">__databaseFlush</a></td> |
|
105 <td>Private slot to return all database tables to the state just after their installation.</td> |
|
106 </tr><tr> |
|
107 <td><a href="#Project.__databaseInspect">__databaseInspect</a></td> |
|
108 <td>Private slot to introspect the database and output a Django model module.</td> |
|
109 </tr><tr> |
|
110 <td><a href="#Project.__databaseSqlCreateEverything">__databaseSqlCreateEverything</a></td> |
|
111 <td>Private slot to print the CREATE TABLE, custom SQL and CREATE INDEX SQL statements for one or more applications.</td> |
|
112 </tr><tr> |
|
113 <td><a href="#Project.__databaseSqlCreateIndexes">__databaseSqlCreateIndexes</a></td> |
|
114 <td>Private slot to print the CREATE INDEX SQL statements for one or more applications.</td> |
|
115 </tr><tr> |
|
116 <td><a href="#Project.__databaseSqlCreateTables">__databaseSqlCreateTables</a></td> |
|
117 <td>Private slot to print the CREATE TABLE SQL statements for one or more applications.</td> |
|
118 </tr><tr> |
|
119 <td><a href="#Project.__databaseSqlCustom">__databaseSqlCustom</a></td> |
|
120 <td>Private slot to print the custom table modifying SQL statements for one or more applications.</td> |
|
121 </tr><tr> |
|
122 <td><a href="#Project.__databaseSqlDropTables">__databaseSqlDropTables</a></td> |
|
123 <td>Private slot to print the DROP TABLE SQL statements for one or more applications.</td> |
|
124 </tr><tr> |
|
125 <td><a href="#Project.__databaseSqlFlushDatabase">__databaseSqlFlushDatabase</a></td> |
|
126 <td>Private slot to print a list of statements to return all database tables to their initial state.</td> |
|
127 </tr><tr> |
|
128 <td><a href="#Project.__databaseSqlResetSequences">__databaseSqlResetSequences</a></td> |
|
129 <td>Private slot to print the SQL statements for resetting sequences for one or more applications.</td> |
|
130 </tr><tr> |
|
131 <td><a href="#Project.__databaseSynchronize">__databaseSynchronize</a></td> |
|
132 <td>Private slot to synchronize the database.</td> |
|
133 </tr><tr> |
|
134 <td><a href="#Project.__diffSettings">__diffSettings</a></td> |
|
135 <td>Private slot to show the changes made to the settings.py file.</td> |
|
136 </tr><tr> |
|
137 <td><a href="#Project.__djangoInfo">__djangoInfo</a></td> |
|
138 <td>Private slot to show some info about Django.</td> |
|
139 </tr><tr> |
|
140 <td><a href="#Project.__dumpData">__dumpData</a></td> |
|
141 <td>Private slot to dump the database data to a fixture.</td> |
|
142 </tr><tr> |
|
143 <td><a href="#Project.__findSites">__findSites</a></td> |
|
144 <td>Private method to determine the relative path to all manage.py scripts.</td> |
|
145 </tr><tr> |
|
146 <td><a href="#Project.__getApplications">__getApplications</a></td> |
|
147 <td>Private method to ask the user for a list of application names.</td> |
|
148 </tr><tr> |
|
149 <td><a href="#Project.__getLocale">__getLocale</a></td> |
|
150 <td>Private method to extract the locale out of a file name.</td> |
|
151 </tr><tr> |
|
152 <td><a href="#Project.__getPythonExecutable">__getPythonExecutable</a></td> |
|
153 <td>Private method to determine the name of the Python executable.</td> |
|
154 </tr><tr> |
|
155 <td><a href="#Project.__initDatabaseActions">__initDatabaseActions</a></td> |
|
156 <td>Private method to define the database related actions.</td> |
|
157 </tr><tr> |
|
158 <td><a href="#Project.__initDatabaseMenu">__initDatabaseMenu</a></td> |
|
159 <td>Private slot to initialize the database menu.</td> |
|
160 </tr><tr> |
|
161 <td><a href="#Project.__initDatabaseSqlActions">__initDatabaseSqlActions</a></td> |
|
162 <td>Private method to define the database SQL related actions.</td> |
|
163 </tr><tr> |
|
164 <td><a href="#Project.__initDatabaseSqlMenu">__initDatabaseSqlMenu</a></td> |
|
165 <td>Private slot to initialize the database SQL submenu.</td> |
|
166 </tr><tr> |
|
167 <td><a href="#Project.__initTestingActions">__initTestingActions</a></td> |
|
168 <td>Private method to define the testing actions.</td> |
|
169 </tr><tr> |
|
170 <td><a href="#Project.__initTestingMenu">__initTestingMenu</a></td> |
|
171 <td>Private slot to initialize the testing menu.</td> |
|
172 </tr><tr> |
|
173 <td><a href="#Project.__initToolsActions">__initToolsActions</a></td> |
|
174 <td>Private method to define the tool actions.</td> |
|
175 </tr><tr> |
|
176 <td><a href="#Project.__initToolsMenu">__initToolsMenu</a></td> |
|
177 <td>Private slot to initialize the tools menu.</td> |
|
178 </tr><tr> |
|
179 <td><a href="#Project.__isSpawningConsole">__isSpawningConsole</a></td> |
|
180 <td>Private method to check, if the given console is a spawning console.</td> |
|
181 </tr><tr> |
|
182 <td><a href="#Project.__loadData">__loadData</a></td> |
|
183 <td>Private slot to load data from fixture files.</td> |
|
184 </tr><tr> |
|
185 <td><a href="#Project.__loadRecentApplications">__loadRecentApplications</a></td> |
|
186 <td>Private method to load the recently used applications list.</td> |
|
187 </tr><tr> |
|
188 <td><a href="#Project.__normalizeList">__normalizeList</a></td> |
|
189 <td>Private method to normalize a list of file names.</td> |
|
190 </tr><tr> |
|
191 <td><a href="#Project.__projectLanguageAdded">__projectLanguageAdded</a></td> |
|
192 <td>Private slot handling the addition of a new language.</td> |
|
193 </tr><tr> |
|
194 <td><a href="#Project.__runBrowser">__runBrowser</a></td> |
|
195 <td>Private slot to start the default web browser with the server URL.</td> |
|
196 </tr><tr> |
|
197 <td><a href="#Project.__runDatabaseClient">__runDatabaseClient</a></td> |
|
198 <td>Private slot to start a database client for a Django project.</td> |
|
199 </tr><tr> |
|
200 <td><a href="#Project.__runPythonShell">__runPythonShell</a></td> |
|
201 <td>Private slot to start a Python console for a Django project.</td> |
|
202 </tr><tr> |
|
203 <td><a href="#Project.__runServer">__runServer</a></td> |
|
204 <td>Private slot to start the Django Web server.</td> |
|
205 </tr><tr> |
|
206 <td><a href="#Project.__runTestServer">__runTestServer</a></td> |
|
207 <td>Private slot to run a development server with data from a set of fixtures.</td> |
|
208 </tr><tr> |
|
209 <td><a href="#Project.__runTestSuite">__runTestSuite</a></td> |
|
210 <td>Private slot to run the test suite for applications or the whole site.</td> |
|
211 </tr><tr> |
|
212 <td><a href="#Project.__saveRecentApplications">__saveRecentApplications</a></td> |
|
213 <td>Private method to save the list of recently used applications list.</td> |
|
214 </tr><tr> |
|
215 <td><a href="#Project.__selectSite">__selectSite</a></td> |
|
216 <td>Private method to select a site to work with.</td> |
|
217 </tr><tr> |
|
218 <td><a href="#Project.__serverProcFinished">__serverProcFinished</a></td> |
|
219 <td>Private slot connected to the finished signal.</td> |
|
220 </tr><tr> |
|
221 <td><a href="#Project.__setCurrentSite">__setCurrentSite</a></td> |
|
222 <td>Private slot to set the current site.</td> |
|
223 </tr><tr> |
|
224 <td><a href="#Project.__showHelpIndex">__showHelpIndex</a></td> |
|
225 <td>Private slot to show the help index page.</td> |
|
226 </tr><tr> |
|
227 <td><a href="#Project.__site">__site</a></td> |
|
228 <td>Private method to get the name of the current site.</td> |
|
229 </tr><tr> |
|
230 <td><a href="#Project.__siteFilteredList">__siteFilteredList</a></td> |
|
231 <td>Private method to filter a list of file names by site.</td> |
|
232 </tr><tr> |
|
233 <td><a href="#Project.__sitePath">__sitePath</a></td> |
|
234 <td>Private method to calculate the full path of the Django site.</td> |
|
235 </tr><tr> |
|
236 <td><a href="#Project.__sqlCommand">__sqlCommand</a></td> |
|
237 <td>Private method to perform an SQL creation function.</td> |
|
238 </tr><tr> |
|
239 <td><a href="#Project.__startGlobalApplication">__startGlobalApplication</a></td> |
|
240 <td>Private slot to start a new global Django application.</td> |
|
241 </tr><tr> |
|
242 <td><a href="#Project.__startLocalApplication">__startLocalApplication</a></td> |
|
243 <td>Private slot to start a new local Django application.</td> |
|
244 </tr><tr> |
|
245 <td><a href="#Project.__startProject">__startProject</a></td> |
|
246 <td>Private slot to start a new Django project.</td> |
|
247 </tr><tr> |
|
248 <td><a href="#Project.__testServerProcFinished">__testServerProcFinished</a></td> |
|
249 <td>Private slot connected to the finished signal of the test server.</td> |
|
250 </tr><tr> |
|
251 <td><a href="#Project.__validate">__validate</a></td> |
|
252 <td>Private slot to validate all installed models.</td> |
|
253 </tr><tr> |
|
254 <td><a href="#Project.compileCatalogs">compileCatalogs</a></td> |
|
255 <td>Public method to compile the message catalogs.</td> |
|
256 </tr><tr> |
|
257 <td><a href="#Project.compileSelectedCatalogs">compileSelectedCatalogs</a></td> |
|
258 <td>Public method to update the message catalogs.</td> |
|
259 </tr><tr> |
|
260 <td><a href="#Project.getDjangoVersion">getDjangoVersion</a></td> |
|
261 <td>Public method to get the Django version.</td> |
|
262 </tr><tr> |
|
263 <td><a href="#Project.getProjectPath">getProjectPath</a></td> |
|
264 <td>Public method to get the path of the eric5 project.</td> |
|
265 </tr><tr> |
|
266 <td><a href="#Project.getRecentApplications">getRecentApplications</a></td> |
|
267 <td>Public method to get the list of recent applications.</td> |
|
268 </tr><tr> |
|
269 <td><a href="#Project.initActions">initActions</a></td> |
|
270 <td>Public method to define the Pyramid actions.</td> |
|
271 </tr><tr> |
|
272 <td><a href="#Project.initMenu">initMenu</a></td> |
|
273 <td>Public slot to initialize the Django menu.</td> |
|
274 </tr><tr> |
|
275 <td><a href="#Project.newForm">newForm</a></td> |
|
276 <td>Public method to create a new form.</td> |
|
277 </tr><tr> |
|
278 <td><a href="#Project.projectClosed">projectClosed</a></td> |
|
279 <td>Public method to handle the closing of a project.</td> |
|
280 </tr><tr> |
|
281 <td><a href="#Project.projectClosedHooks">projectClosedHooks</a></td> |
|
282 <td>Public method to remove our hook methods.</td> |
|
283 </tr><tr> |
|
284 <td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td> |
|
285 <td>Public method to add our hook methods.</td> |
|
286 </tr><tr> |
|
287 <td><a href="#Project.setMostRecentApplication">setMostRecentApplication</a></td> |
|
288 <td>Public method to set the most recently used applications entry.</td> |
|
289 </tr><tr> |
|
290 <td><a href="#Project.startProjectOrApplication">startProjectOrApplication</a></td> |
|
291 <td>Public slot to start a new Django project or application.</td> |
|
292 </tr><tr> |
|
293 <td><a href="#Project.updateCatalogs">updateCatalogs</a></td> |
|
294 <td>Public method to update the message catalogs.</td> |
|
295 </tr><tr> |
|
296 <td><a href="#Project.updateCatalogsWithObsolete">updateCatalogsWithObsolete</a></td> |
|
297 <td>Public method to update the message catalogs keeping obsolete messages.</td> |
|
298 </tr><tr> |
|
299 <td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td> |
|
300 <td>Public method to update the message catalogs.</td> |
|
301 </tr><tr> |
|
302 <td><a href="#Project.updateSelectedCatalogsWithObsolete">updateSelectedCatalogsWithObsolete</a></td> |
|
303 <td>Public method to update the message catalogs keeping obsolete messages.</td> |
|
304 </tr> |
|
305 </table> |
|
306 <h3>Static Methods</h3> |
|
307 <table> |
|
308 <tr><td>None</td></tr> |
|
309 </table> |
|
310 <a NAME="Project.__init__" ID="Project.__init__"></a> |
|
311 <h4>Project (Constructor)</h4> |
|
312 <b>Project</b>(<i>plugin, parent=None</i>) |
|
313 <p> |
|
314 Constructor |
|
315 </p><dl> |
|
316 <dt><i>plugin</i></dt> |
|
317 <dd> |
|
318 reference to the plugin object |
|
319 </dd><dt><i>parent</i></dt> |
|
320 <dd> |
|
321 parent (QObject) |
|
322 </dd> |
|
323 </dl><a NAME="Project.__cleanup" ID="Project.__cleanup"></a> |
|
324 <h4>Project.__cleanup</h4> |
|
325 <b>__cleanup</b>(<i></i>) |
|
326 <p> |
|
327 Private slot to clean out old data from the database. |
|
328 </p><a NAME="Project.__createApplication" ID="Project.__createApplication"></a> |
|
329 <h4>Project.__createApplication</h4> |
|
330 <b>__createApplication</b>(<i>applName, path, isGlobal = True</i>) |
|
331 <p> |
|
332 Private slot to create a new Django application. |
|
333 </p><dl> |
|
334 <dt><i>applName</i></dt> |
|
335 <dd> |
|
336 name of the new application (string) |
|
337 </dd><dt><i>path</i></dt> |
|
338 <dd> |
|
339 the directory where the application should be created |
|
340 (string) |
|
341 </dd><dt><i>isGlobal</i></dt> |
|
342 <dd> |
|
343 flag indicating a standalone Django application (boolean) |
|
344 </dd> |
|
345 </dl><dl> |
|
346 <dt>Returns:</dt> |
|
347 <dd> |
|
348 flag indicating a successful creation (boolean) |
|
349 </dd> |
|
350 </dl><a NAME="Project.__createCacheTables" ID="Project.__createCacheTables"></a> |
|
351 <h4>Project.__createCacheTables</h4> |
|
352 <b>__createCacheTables</b>(<i></i>) |
|
353 <p> |
|
354 Private slot to create the tables for the SQL caching backend. |
|
355 </p><a NAME="Project.__createProject" ID="Project.__createProject"></a> |
|
356 <h4>Project.__createProject</h4> |
|
357 <b>__createProject</b>(<i>projectName, path</i>) |
|
358 <p> |
|
359 Private slot to create a new Django project. |
|
360 </p><dl> |
|
361 <dt><i>projectName</i></dt> |
|
362 <dd> |
|
363 name of the new project (string) |
|
364 </dd><dt><i>path</i></dt> |
|
365 <dd> |
|
366 the directory where the project should be created |
|
367 (string) |
|
368 </dd> |
|
369 </dl><dl> |
|
370 <dt>Returns:</dt> |
|
371 <dd> |
|
372 flag indicating a successful creation (boolean) |
|
373 </dd> |
|
374 </dl><a NAME="Project.__databaseFlush" ID="Project.__databaseFlush"></a> |
|
375 <h4>Project.__databaseFlush</h4> |
|
376 <b>__databaseFlush</b>(<i></i>) |
|
377 <p> |
|
378 Private slot to return all database tables to the state just after their |
|
379 installation. |
|
380 </p><a NAME="Project.__databaseInspect" ID="Project.__databaseInspect"></a> |
|
381 <h4>Project.__databaseInspect</h4> |
|
382 <b>__databaseInspect</b>(<i></i>) |
|
383 <p> |
|
384 Private slot to introspect the database and output a Django model module. |
|
385 </p><a NAME="Project.__databaseSqlCreateEverything" ID="Project.__databaseSqlCreateEverything"></a> |
|
386 <h4>Project.__databaseSqlCreateEverything</h4> |
|
387 <b>__databaseSqlCreateEverything</b>(<i></i>) |
|
388 <p> |
|
389 Private slot to print the CREATE TABLE, custom SQL and |
|
390 CREATE INDEX SQL statements for one or more applications. |
|
391 </p><a NAME="Project.__databaseSqlCreateIndexes" ID="Project.__databaseSqlCreateIndexes"></a> |
|
392 <h4>Project.__databaseSqlCreateIndexes</h4> |
|
393 <b>__databaseSqlCreateIndexes</b>(<i></i>) |
|
394 <p> |
|
395 Private slot to print the CREATE INDEX SQL statements for one |
|
396 or more applications. |
|
397 </p><a NAME="Project.__databaseSqlCreateTables" ID="Project.__databaseSqlCreateTables"></a> |
|
398 <h4>Project.__databaseSqlCreateTables</h4> |
|
399 <b>__databaseSqlCreateTables</b>(<i></i>) |
|
400 <p> |
|
401 Private slot to print the CREATE TABLE SQL statements for one |
|
402 or more applications. |
|
403 </p><a NAME="Project.__databaseSqlCustom" ID="Project.__databaseSqlCustom"></a> |
|
404 <h4>Project.__databaseSqlCustom</h4> |
|
405 <b>__databaseSqlCustom</b>(<i></i>) |
|
406 <p> |
|
407 Private slot to print the custom table modifying SQL statements |
|
408 for one or more applications. |
|
409 </p><a NAME="Project.__databaseSqlDropTables" ID="Project.__databaseSqlDropTables"></a> |
|
410 <h4>Project.__databaseSqlDropTables</h4> |
|
411 <b>__databaseSqlDropTables</b>(<i></i>) |
|
412 <p> |
|
413 Private slot to print the DROP TABLE SQL statements for one or |
|
414 more applications. |
|
415 </p><a NAME="Project.__databaseSqlFlushDatabase" ID="Project.__databaseSqlFlushDatabase"></a> |
|
416 <h4>Project.__databaseSqlFlushDatabase</h4> |
|
417 <b>__databaseSqlFlushDatabase</b>(<i></i>) |
|
418 <p> |
|
419 Private slot to print a list of statements to return all database |
|
420 tables to their initial state. |
|
421 </p><a NAME="Project.__databaseSqlResetSequences" ID="Project.__databaseSqlResetSequences"></a> |
|
422 <h4>Project.__databaseSqlResetSequences</h4> |
|
423 <b>__databaseSqlResetSequences</b>(<i></i>) |
|
424 <p> |
|
425 Private slot to print the SQL statements for resetting sequences for |
|
426 one or more applications. |
|
427 </p><a NAME="Project.__databaseSynchronize" ID="Project.__databaseSynchronize"></a> |
|
428 <h4>Project.__databaseSynchronize</h4> |
|
429 <b>__databaseSynchronize</b>(<i></i>) |
|
430 <p> |
|
431 Private slot to synchronize the database. |
|
432 </p><a NAME="Project.__diffSettings" ID="Project.__diffSettings"></a> |
|
433 <h4>Project.__diffSettings</h4> |
|
434 <b>__diffSettings</b>(<i></i>) |
|
435 <p> |
|
436 Private slot to show the changes made to the settings.py file. |
|
437 </p><a NAME="Project.__djangoInfo" ID="Project.__djangoInfo"></a> |
|
438 <h4>Project.__djangoInfo</h4> |
|
439 <b>__djangoInfo</b>(<i></i>) |
|
440 <p> |
|
441 Private slot to show some info about Django. |
|
442 </p><a NAME="Project.__dumpData" ID="Project.__dumpData"></a> |
|
443 <h4>Project.__dumpData</h4> |
|
444 <b>__dumpData</b>(<i></i>) |
|
445 <p> |
|
446 Private slot to dump the database data to a fixture. |
|
447 </p><a NAME="Project.__findSites" ID="Project.__findSites"></a> |
|
448 <h4>Project.__findSites</h4> |
|
449 <b>__findSites</b>(<i></i>) |
|
450 <p> |
|
451 Private method to determine the relative path to all manage.py scripts. |
|
452 </p><dl> |
|
453 <dt>Returns:</dt> |
|
454 <dd> |
|
455 list of sites (list of strings) |
|
456 </dd> |
|
457 </dl><a NAME="Project.__getApplications" ID="Project.__getApplications"></a> |
|
458 <h4>Project.__getApplications</h4> |
|
459 <b>__getApplications</b>(<i></i>) |
|
460 <p> |
|
461 Private method to ask the user for a list of application names. |
|
462 </p><dl> |
|
463 <dt>Returns:</dt> |
|
464 <dd> |
|
465 list of application names (list of strings) |
|
466 </dd> |
|
467 </dl><a NAME="Project.__getLocale" ID="Project.__getLocale"></a> |
|
468 <h4>Project.__getLocale</h4> |
|
469 <b>__getLocale</b>(<i>filename</i>) |
|
470 <p> |
|
471 Private method to extract the locale out of a file name. |
|
472 </p><dl> |
|
473 <dt><i>filename</i></dt> |
|
474 <dd> |
|
475 name of the file used for extraction (string) |
|
476 </dd> |
|
477 </dl><dl> |
|
478 <dt>Returns:</dt> |
|
479 <dd> |
|
480 extracted locale (string) or None |
|
481 </dd> |
|
482 </dl><a NAME="Project.__getPythonExecutable" ID="Project.__getPythonExecutable"></a> |
|
483 <h4>Project.__getPythonExecutable</h4> |
|
484 <b>__getPythonExecutable</b>(<i></i>) |
|
485 <p> |
|
486 Private method to determine the name of the Python executable. |
|
487 </p><dl> |
|
488 <dt>Returns:</dt> |
|
489 <dd> |
|
490 Python executable (string) |
|
491 </dd> |
|
492 </dl><a NAME="Project.__initDatabaseActions" ID="Project.__initDatabaseActions"></a> |
|
493 <h4>Project.__initDatabaseActions</h4> |
|
494 <b>__initDatabaseActions</b>(<i></i>) |
|
495 <p> |
|
496 Private method to define the database related actions. |
|
497 </p><a NAME="Project.__initDatabaseMenu" ID="Project.__initDatabaseMenu"></a> |
|
498 <h4>Project.__initDatabaseMenu</h4> |
|
499 <b>__initDatabaseMenu</b>(<i></i>) |
|
500 <p> |
|
501 Private slot to initialize the database menu. |
|
502 </p><dl> |
|
503 <dt>Returns:</dt> |
|
504 <dd> |
|
505 the menu generated (QMenu) |
|
506 </dd> |
|
507 </dl><a NAME="Project.__initDatabaseSqlActions" ID="Project.__initDatabaseSqlActions"></a> |
|
508 <h4>Project.__initDatabaseSqlActions</h4> |
|
509 <b>__initDatabaseSqlActions</b>(<i></i>) |
|
510 <p> |
|
511 Private method to define the database SQL related actions. |
|
512 </p><a NAME="Project.__initDatabaseSqlMenu" ID="Project.__initDatabaseSqlMenu"></a> |
|
513 <h4>Project.__initDatabaseSqlMenu</h4> |
|
514 <b>__initDatabaseSqlMenu</b>(<i></i>) |
|
515 <p> |
|
516 Private slot to initialize the database SQL submenu. |
|
517 </p><dl> |
|
518 <dt>Returns:</dt> |
|
519 <dd> |
|
520 the menu generated (QMenu) |
|
521 </dd> |
|
522 </dl><a NAME="Project.__initTestingActions" ID="Project.__initTestingActions"></a> |
|
523 <h4>Project.__initTestingActions</h4> |
|
524 <b>__initTestingActions</b>(<i></i>) |
|
525 <p> |
|
526 Private method to define the testing actions. |
|
527 </p><a NAME="Project.__initTestingMenu" ID="Project.__initTestingMenu"></a> |
|
528 <h4>Project.__initTestingMenu</h4> |
|
529 <b>__initTestingMenu</b>(<i></i>) |
|
530 <p> |
|
531 Private slot to initialize the testing menu. |
|
532 </p><dl> |
|
533 <dt>Returns:</dt> |
|
534 <dd> |
|
535 the menu generated (QMenu) |
|
536 </dd> |
|
537 </dl><a NAME="Project.__initToolsActions" ID="Project.__initToolsActions"></a> |
|
538 <h4>Project.__initToolsActions</h4> |
|
539 <b>__initToolsActions</b>(<i></i>) |
|
540 <p> |
|
541 Private method to define the tool actions. |
|
542 </p><a NAME="Project.__initToolsMenu" ID="Project.__initToolsMenu"></a> |
|
543 <h4>Project.__initToolsMenu</h4> |
|
544 <b>__initToolsMenu</b>(<i></i>) |
|
545 <p> |
|
546 Private slot to initialize the tools menu. |
|
547 </p><dl> |
|
548 <dt>Returns:</dt> |
|
549 <dd> |
|
550 the menu generated (QMenu) |
|
551 </dd> |
|
552 </dl><a NAME="Project.__isSpawningConsole" ID="Project.__isSpawningConsole"></a> |
|
553 <h4>Project.__isSpawningConsole</h4> |
|
554 <b>__isSpawningConsole</b>(<i>consoleCmd</i>) |
|
555 <p> |
|
556 Private method to check, if the given console is a spawning console. |
|
557 </p><dl> |
|
558 <dt><i>consoleCmd</i></dt> |
|
559 <dd> |
|
560 console command (string) |
|
561 </dd> |
|
562 </dl><dl> |
|
563 <dt>Returns:</dt> |
|
564 <dd> |
|
565 tuple of two entries giving an indication, if the console |
|
566 is spawning (boolean) and the (possibly) cleaned console command |
|
567 (string) |
|
568 </dd> |
|
569 </dl><a NAME="Project.__loadData" ID="Project.__loadData"></a> |
|
570 <h4>Project.__loadData</h4> |
|
571 <b>__loadData</b>(<i></i>) |
|
572 <p> |
|
573 Private slot to load data from fixture files. |
|
574 </p><a NAME="Project.__loadRecentApplications" ID="Project.__loadRecentApplications"></a> |
|
575 <h4>Project.__loadRecentApplications</h4> |
|
576 <b>__loadRecentApplications</b>(<i></i>) |
|
577 <p> |
|
578 Private method to load the recently used applications list. |
|
579 </p><a NAME="Project.__normalizeList" ID="Project.__normalizeList"></a> |
|
580 <h4>Project.__normalizeList</h4> |
|
581 <b>__normalizeList</b>(<i>filenames</i>) |
|
582 <p> |
|
583 Private method to normalize a list of file names. |
|
584 </p><dl> |
|
585 <dt><i>filenames</i></dt> |
|
586 <dd> |
|
587 list of file names to normalize (list of strings) |
|
588 </dd> |
|
589 </dl><dl> |
|
590 <dt>Returns:</dt> |
|
591 <dd> |
|
592 normalized file names (list of strings) |
|
593 </dd> |
|
594 </dl><a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a> |
|
595 <h4>Project.__projectLanguageAdded</h4> |
|
596 <b>__projectLanguageAdded</b>(<i>code</i>) |
|
597 <p> |
|
598 Private slot handling the addition of a new language. |
|
599 </p><dl> |
|
600 <dt><i>code</i></dt> |
|
601 <dd> |
|
602 language code of the new language (string) |
|
603 </dd> |
|
604 </dl><a NAME="Project.__runBrowser" ID="Project.__runBrowser"></a> |
|
605 <h4>Project.__runBrowser</h4> |
|
606 <b>__runBrowser</b>(<i></i>) |
|
607 <p> |
|
608 Private slot to start the default web browser with the server URL. |
|
609 </p><a NAME="Project.__runDatabaseClient" ID="Project.__runDatabaseClient"></a> |
|
610 <h4>Project.__runDatabaseClient</h4> |
|
611 <b>__runDatabaseClient</b>(<i></i>) |
|
612 <p> |
|
613 Private slot to start a database client for a Django project. |
|
614 </p><a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a> |
|
615 <h4>Project.__runPythonShell</h4> |
|
616 <b>__runPythonShell</b>(<i></i>) |
|
617 <p> |
|
618 Private slot to start a Python console for a Django project. |
|
619 </p><a NAME="Project.__runServer" ID="Project.__runServer"></a> |
|
620 <h4>Project.__runServer</h4> |
|
621 <b>__runServer</b>(<i></i>) |
|
622 <p> |
|
623 Private slot to start the Django Web server. |
|
624 </p><a NAME="Project.__runTestServer" ID="Project.__runTestServer"></a> |
|
625 <h4>Project.__runTestServer</h4> |
|
626 <b>__runTestServer</b>(<i></i>) |
|
627 <p> |
|
628 Private slot to run a development server with data from a set of fixtures. |
|
629 </p><a NAME="Project.__runTestSuite" ID="Project.__runTestSuite"></a> |
|
630 <h4>Project.__runTestSuite</h4> |
|
631 <b>__runTestSuite</b>(<i></i>) |
|
632 <p> |
|
633 Private slot to run the test suite for applications or the whole site. |
|
634 </p><a NAME="Project.__saveRecentApplications" ID="Project.__saveRecentApplications"></a> |
|
635 <h4>Project.__saveRecentApplications</h4> |
|
636 <b>__saveRecentApplications</b>(<i></i>) |
|
637 <p> |
|
638 Private method to save the list of recently used applications list. |
|
639 </p><a NAME="Project.__selectSite" ID="Project.__selectSite"></a> |
|
640 <h4>Project.__selectSite</h4> |
|
641 <b>__selectSite</b>(<i></i>) |
|
642 <p> |
|
643 Private method to select a site to work with. |
|
644 </p><dl> |
|
645 <dt>Returns:</dt> |
|
646 <dd> |
|
647 selected site (string) |
|
648 </dd> |
|
649 </dl><a NAME="Project.__serverProcFinished" ID="Project.__serverProcFinished"></a> |
|
650 <h4>Project.__serverProcFinished</h4> |
|
651 <b>__serverProcFinished</b>(<i></i>) |
|
652 <p> |
|
653 Private slot connected to the finished signal. |
|
654 </p><a NAME="Project.__setCurrentSite" ID="Project.__setCurrentSite"></a> |
|
655 <h4>Project.__setCurrentSite</h4> |
|
656 <b>__setCurrentSite</b>(<i>site</i>) |
|
657 <p> |
|
658 Private slot to set the current site. |
|
659 </p><dl> |
|
660 <dt><i>site</i></dt> |
|
661 <dd> |
|
662 name of the site (string) |
|
663 </dd> |
|
664 </dl><a NAME="Project.__showHelpIndex" ID="Project.__showHelpIndex"></a> |
|
665 <h4>Project.__showHelpIndex</h4> |
|
666 <b>__showHelpIndex</b>(<i></i>) |
|
667 <p> |
|
668 Private slot to show the help index page. |
|
669 </p><a NAME="Project.__site" ID="Project.__site"></a> |
|
670 <h4>Project.__site</h4> |
|
671 <b>__site</b>(<i></i>) |
|
672 <p> |
|
673 Private method to get the name of the current site. |
|
674 </p><dl> |
|
675 <dt>Returns:</dt> |
|
676 <dd> |
|
677 name of the site (string) |
|
678 </dd> |
|
679 </dl><dl> |
|
680 <dt>Raises <b>DjangoNoSiteSelectedException</b>:</dt> |
|
681 <dd> |
|
682 raised, if no site is selected |
|
683 </dd> |
|
684 </dl><a NAME="Project.__siteFilteredList" ID="Project.__siteFilteredList"></a> |
|
685 <h4>Project.__siteFilteredList</h4> |
|
686 <b>__siteFilteredList</b>(<i>filenames</i>) |
|
687 <p> |
|
688 Private method to filter a list of file names by site. |
|
689 </p><dl> |
|
690 <dt><i>filenames</i></dt> |
|
691 <dd> |
|
692 list of file names to be filtered (list of strings) |
|
693 </dd> |
|
694 </dl><dl> |
|
695 <dt>Returns:</dt> |
|
696 <dd> |
|
697 file names belonging to the current site (list of strings) |
|
698 </dd> |
|
699 </dl><a NAME="Project.__sitePath" ID="Project.__sitePath"></a> |
|
700 <h4>Project.__sitePath</h4> |
|
701 <b>__sitePath</b>(<i></i>) |
|
702 <p> |
|
703 Private method to calculate the full path of the Django site. |
|
704 </p><dl> |
|
705 <dt>Returns:</dt> |
|
706 <dd> |
|
707 path of the site (string) |
|
708 </dd> |
|
709 </dl><dl> |
|
710 <dt>Raises <b>DjangoNoSiteSelectedException</b>:</dt> |
|
711 <dd> |
|
712 raised, if no site is selected |
|
713 </dd> |
|
714 </dl><a NAME="Project.__sqlCommand" ID="Project.__sqlCommand"></a> |
|
715 <h4>Project.__sqlCommand</h4> |
|
716 <b>__sqlCommand</b>(<i>title, command, requestApps = True</i>) |
|
717 <p> |
|
718 Private method to perform an SQL creation function. |
|
719 </p><dl> |
|
720 <dt><i>title</i></dt> |
|
721 <dd> |
|
722 dialog title (string) |
|
723 </dd><dt><i>command</i></dt> |
|
724 <dd> |
|
725 Django sql... command (string) |
|
726 </dd><dt><i>requestApps</i></dt> |
|
727 <dd> |
|
728 flag indicating to request a list of applications |
|
729 to work on (boolean) |
|
730 </dd> |
|
731 </dl><a NAME="Project.__startGlobalApplication" ID="Project.__startGlobalApplication"></a> |
|
732 <h4>Project.__startGlobalApplication</h4> |
|
733 <b>__startGlobalApplication</b>(<i></i>) |
|
734 <p> |
|
735 Private slot to start a new global Django application. |
|
736 </p><a NAME="Project.__startLocalApplication" ID="Project.__startLocalApplication"></a> |
|
737 <h4>Project.__startLocalApplication</h4> |
|
738 <b>__startLocalApplication</b>(<i></i>) |
|
739 <p> |
|
740 Private slot to start a new local Django application. |
|
741 </p><a NAME="Project.__startProject" ID="Project.__startProject"></a> |
|
742 <h4>Project.__startProject</h4> |
|
743 <b>__startProject</b>(<i></i>) |
|
744 <p> |
|
745 Private slot to start a new Django project. |
|
746 </p><a NAME="Project.__testServerProcFinished" ID="Project.__testServerProcFinished"></a> |
|
747 <h4>Project.__testServerProcFinished</h4> |
|
748 <b>__testServerProcFinished</b>(<i></i>) |
|
749 <p> |
|
750 Private slot connected to the finished signal of the test server. |
|
751 </p><a NAME="Project.__validate" ID="Project.__validate"></a> |
|
752 <h4>Project.__validate</h4> |
|
753 <b>__validate</b>(<i></i>) |
|
754 <p> |
|
755 Private slot to validate all installed models. |
|
756 </p><a NAME="Project.compileCatalogs" ID="Project.compileCatalogs"></a> |
|
757 <h4>Project.compileCatalogs</h4> |
|
758 <b>compileCatalogs</b>(<i>filenames</i>) |
|
759 <p> |
|
760 Public method to compile the message catalogs. |
|
761 </p><dl> |
|
762 <dt><i>filenames</i></dt> |
|
763 <dd> |
|
764 list of filenames (not used) |
|
765 </dd> |
|
766 </dl><a NAME="Project.compileSelectedCatalogs" ID="Project.compileSelectedCatalogs"></a> |
|
767 <h4>Project.compileSelectedCatalogs</h4> |
|
768 <b>compileSelectedCatalogs</b>(<i>filenames</i>) |
|
769 <p> |
|
770 Public method to update the message catalogs. |
|
771 </p><dl> |
|
772 <dt><i>filenames</i></dt> |
|
773 <dd> |
|
774 list of filenames |
|
775 </dd> |
|
776 </dl><a NAME="Project.getDjangoVersion" ID="Project.getDjangoVersion"></a> |
|
777 <h4>Project.getDjangoVersion</h4> |
|
778 <b>getDjangoVersion</b>(<i></i>) |
|
779 <p> |
|
780 Public method to get the Django version. |
|
781 </p><dl> |
|
782 <dt>Returns:</dt> |
|
783 <dd> |
|
784 Django version as a tuple |
|
785 </dd> |
|
786 </dl><a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a> |
|
787 <h4>Project.getProjectPath</h4> |
|
788 <b>getProjectPath</b>(<i></i>) |
|
789 <p> |
|
790 Public method to get the path of the eric5 project. |
|
791 </p><dl> |
|
792 <dt>Returns:</dt> |
|
793 <dd> |
|
794 path of the eric5 project (string) |
|
795 </dd> |
|
796 </dl><a NAME="Project.getRecentApplications" ID="Project.getRecentApplications"></a> |
|
797 <h4>Project.getRecentApplications</h4> |
|
798 <b>getRecentApplications</b>(<i></i>) |
|
799 <p> |
|
800 Public method to get the list of recent applications. |
|
801 </p><dl> |
|
802 <dt>Returns:</dt> |
|
803 <dd> |
|
804 list of recent applications entries (list of strings) |
|
805 </dd> |
|
806 </dl><a NAME="Project.initActions" ID="Project.initActions"></a> |
|
807 <h4>Project.initActions</h4> |
|
808 <b>initActions</b>(<i></i>) |
|
809 <p> |
|
810 Public method to define the Pyramid actions. |
|
811 </p><a NAME="Project.initMenu" ID="Project.initMenu"></a> |
|
812 <h4>Project.initMenu</h4> |
|
813 <b>initMenu</b>(<i></i>) |
|
814 <p> |
|
815 Public slot to initialize the Django menu. |
|
816 </p><dl> |
|
817 <dt>Returns:</dt> |
|
818 <dd> |
|
819 the menu generated (QMenu) |
|
820 </dd> |
|
821 </dl><a NAME="Project.newForm" ID="Project.newForm"></a> |
|
822 <h4>Project.newForm</h4> |
|
823 <b>newForm</b>(<i>path</i>) |
|
824 <p> |
|
825 Public method to create a new form. |
|
826 </p><dl> |
|
827 <dt><i>path</i></dt> |
|
828 <dd> |
|
829 full directory path for the new form file (string) |
|
830 </dd> |
|
831 </dl><a NAME="Project.projectClosed" ID="Project.projectClosed"></a> |
|
832 <h4>Project.projectClosed</h4> |
|
833 <b>projectClosed</b>(<i></i>) |
|
834 <p> |
|
835 Public method to handle the closing of a project. |
|
836 </p><a NAME="Project.projectClosedHooks" ID="Project.projectClosedHooks"></a> |
|
837 <h4>Project.projectClosedHooks</h4> |
|
838 <b>projectClosedHooks</b>(<i></i>) |
|
839 <p> |
|
840 Public method to remove our hook methods. |
|
841 </p><a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a> |
|
842 <h4>Project.projectOpenedHooks</h4> |
|
843 <b>projectOpenedHooks</b>(<i></i>) |
|
844 <p> |
|
845 Public method to add our hook methods. |
|
846 </p><a NAME="Project.setMostRecentApplication" ID="Project.setMostRecentApplication"></a> |
|
847 <h4>Project.setMostRecentApplication</h4> |
|
848 <b>setMostRecentApplication</b>(<i>applStr</i>) |
|
849 <p> |
|
850 Public method to set the most recently used applications entry. |
|
851 </p><dl> |
|
852 <dt><i>applStr</i></dt> |
|
853 <dd> |
|
854 applications entry (string) |
|
855 </dd> |
|
856 </dl><a NAME="Project.startProjectOrApplication" ID="Project.startProjectOrApplication"></a> |
|
857 <h4>Project.startProjectOrApplication</h4> |
|
858 <b>startProjectOrApplication</b>(<i></i>) |
|
859 <p> |
|
860 Public slot to start a new Django project or application. |
|
861 </p><a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a> |
|
862 <h4>Project.updateCatalogs</h4> |
|
863 <b>updateCatalogs</b>(<i>filenames</i>) |
|
864 <p> |
|
865 Public method to update the message catalogs. |
|
866 </p><dl> |
|
867 <dt><i>filenames</i></dt> |
|
868 <dd> |
|
869 list of filenames (not used) |
|
870 </dd> |
|
871 </dl><a NAME="Project.updateCatalogsWithObsolete" ID="Project.updateCatalogsWithObsolete"></a> |
|
872 <h4>Project.updateCatalogsWithObsolete</h4> |
|
873 <b>updateCatalogsWithObsolete</b>(<i>filenames</i>) |
|
874 <p> |
|
875 Public method to update the message catalogs keeping obsolete messages. |
|
876 </p><dl> |
|
877 <dt><i>filenames</i></dt> |
|
878 <dd> |
|
879 list of filenames (not used) |
|
880 </dd> |
|
881 </dl><a NAME="Project.updateSelectedCatalogs" ID="Project.updateSelectedCatalogs"></a> |
|
882 <h4>Project.updateSelectedCatalogs</h4> |
|
883 <b>updateSelectedCatalogs</b>(<i>filenames</i>) |
|
884 <p> |
|
885 Public method to update the message catalogs. |
|
886 </p><dl> |
|
887 <dt><i>filenames</i></dt> |
|
888 <dd> |
|
889 list of file names (list of strings) |
|
890 </dd> |
|
891 </dl><a NAME="Project.updateSelectedCatalogsWithObsolete" ID="Project.updateSelectedCatalogsWithObsolete"></a> |
|
892 <h4>Project.updateSelectedCatalogsWithObsolete</h4> |
|
893 <b>updateSelectedCatalogsWithObsolete</b>(<i>filenames</i>) |
|
894 <p> |
|
895 Public method to update the message catalogs keeping obsolete messages. |
|
896 </p><dl> |
|
897 <dt><i>filenames</i></dt> |
|
898 <dd> |
|
899 list of filenames |
|
900 </dd> |
|
901 </dl> |
|
902 <div align="right"><a href="#top">Up</a></div> |
|
903 <hr /> |
|
904 </body></html> |