Mercurial Repositories > Pyramid Project / file comparison

comparison: ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.Project.html

ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.Project.html

changeset 15
db83e46b35da
child 25
2dd3d1cf573a
equal deleted inserted replaced
14:e3cb581b4653 15:db83e46b35da
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>Plugin_Project_Pyramid.ProjectPyramid.Project</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>Plugin_Project_Pyramid.ProjectPyramid.Project</h1>
24 <p>
25 Module implementing the Pyramid project support.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#Project">Project</a></td>
35 <td>Class implementing the Pyramid project support.</td>
36 </tr><tr>
37 <td><a href="#PyramidNoProjectSelectedException">PyramidNoProjectSelectedException</a></td>
38 <td>Exception thrown to signal, that there is no current Pyramid project.</td>
39 </tr>
40 </table>
41 <h3>Functions</h3>
42 <table>
43 <tr><td>None</td></tr>
44 </table>
45 <hr /><hr />
46 <a NAME="Project" ID="Project"></a>
47 <h2>Project</h2>
48 <p>
49 Class implementing the Pyramid project support.
50 </p>
51 <h3>Derived from</h3>
52 QObject
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Class Methods</h3>
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62 <table>
63 <tr>
64 <td><a href="#Project.__init__">Project</a></td>
65 <td>Constructor</td>
66 </tr><tr>
67 <td><a href="#Project.__buildDistribution">__buildDistribution</a></td>
68 <td>Private slot to build a distribution file for the current Pyramid project.</td>
69 </tr><tr>
70 <td><a href="#Project.__createProject">__createProject</a></td>
71 <td>Private slot to create a new Pyramid project.</td>
72 </tr><tr>
73 <td><a href="#Project.__findProjects">__findProjects</a></td>
74 <td>Private method to determine the relative path of all Pyramid projects (= top level dirs).</td>
75 </tr><tr>
76 <td><a href="#Project.__getInitDbCommand">__getInitDbCommand</a></td>
77 <td>Private method to create the path to the initialization script.</td>
78 </tr><tr>
79 <td><a href="#Project.__getLocale">__getLocale</a></td>
80 <td>Private method to extract the locale out of a file name.</td>
81 </tr><tr>
82 <td><a href="#Project.__getVirtualEnvironment">__getVirtualEnvironment</a></td>
83 <td>Private method to get the path of the virtual environment.</td>
84 </tr><tr>
85 <td><a href="#Project.__initializeDatabase">__initializeDatabase</a></td>
86 <td>Private slot to initialize the database of the Pyramid project.</td>
87 </tr><tr>
88 <td><a href="#Project.__normalizeList">__normalizeList</a></td>
89 <td>Private method to normalize a list of file names.</td>
90 </tr><tr>
91 <td><a href="#Project.__project">__project</a></td>
92 <td>Private method to get the name of the current Pyramid project.</td>
93 </tr><tr>
94 <td><a href="#Project.__projectFilteredList">__projectFilteredList</a></td>
95 <td>Private method to filter a list of file names by Pyramid project.</td>
96 </tr><tr>
97 <td><a href="#Project.__projectLanguageAdded">__projectLanguageAdded</a></td>
98 <td>Private slot handling the addition of a new language.</td>
99 </tr><tr>
100 <td><a href="#Project.__projectPath">__projectPath</a></td>
101 <td>Private method to calculate the full path of the Pyramid project.</td>
102 </tr><tr>
103 <td><a href="#Project.__pyramidInfo">__pyramidInfo</a></td>
104 <td>Private slot to show some info about Pyramid.</td>
105 </tr><tr>
106 <td><a href="#Project.__runBrowser">__runBrowser</a></td>
107 <td>Private slot to start the default web browser with the server URL.</td>
108 </tr><tr>
109 <td><a href="#Project.__runLoggingServer">__runLoggingServer</a></td>
110 <td>Private slot to start the Pyramid Web server with logging.</td>
111 </tr><tr>
112 <td><a href="#Project.__runPythonShell">__runPythonShell</a></td>
113 <td>Private slot to start a Python console for a Pyramid project.</td>
114 </tr><tr>
115 <td><a href="#Project.__runServer">__runServer</a></td>
116 <td>Private slot to start the Pyramid Web server.</td>
117 </tr><tr>
118 <td><a href="#Project.__selectProject">__selectProject</a></td>
119 <td>Private method to select a Pyramid project to work with.</td>
120 </tr><tr>
121 <td><a href="#Project.__serverProcFinished">__serverProcFinished</a></td>
122 <td>Private slot connected to the finished signal.</td>
123 </tr><tr>
124 <td><a href="#Project.__setCurrentProject">__setCurrentProject</a></td>
125 <td>Private slot to set the current project.</td>
126 </tr><tr>
127 <td><a href="#Project.__setupDevelop">__setupDevelop</a></td>
128 <td>Private slot to set up the development environment for the current project.</td>
129 </tr><tr>
130 <td><a href="#Project.__showDocumentation">__showDocumentation</a></td>
131 <td>Private slot to show the helpviewer with the Pyramid documentation.</td>
132 </tr><tr>
133 <td><a href="#Project.__showMatchingViews">__showMatchingViews</a></td>
134 <td>Private slot showing all views that would match a given URL.</td>
135 </tr><tr>
136 <td><a href="#Project.__showRoutes">__showRoutes</a></td>
137 <td>Private slot showing all URL dispatch routes.</td>
138 </tr><tr>
139 <td><a href="#Project.__showTweens">__showTweens</a></td>
140 <td>Private slot showing all implicit and explicit tween objects.</td>
141 </tr><tr>
142 <td><a href="#Project.compileCatalogs">compileCatalogs</a></td>
143 <td>Public method to compile the message catalogs.</td>
144 </tr><tr>
145 <td><a href="#Project.compileSelectedCatalogs">compileSelectedCatalogs</a></td>
146 <td>Public method to update the message catalogs.</td>
147 </tr><tr>
148 <td><a href="#Project.extractMessages">extractMessages</a></td>
149 <td>Public method to extract the messages catalog template file.</td>
150 </tr><tr>
151 <td><a href="#Project.getPyramidCommand">getPyramidCommand</a></td>
152 <td>Public method to build a Pyramid command.</td>
153 </tr><tr>
154 <td><a href="#Project.getPythonCommand">getPythonCommand</a></td>
155 <td>Public method to build the Python command.</td>
156 </tr><tr>
157 <td><a href="#Project.initActions">initActions</a></td>
158 <td>Public method to define the Pyramid actions.</td>
159 </tr><tr>
160 <td><a href="#Project.initMenu">initMenu</a></td>
161 <td>Public slot to initialize the Pyramid menu.</td>
162 </tr><tr>
163 <td><a href="#Project.isSpawningConsole">isSpawningConsole</a></td>
164 <td>Public method to check, if the given console is a spawning console.</td>
165 </tr><tr>
166 <td><a href="#Project.newForm">newForm</a></td>
167 <td>Public method to create a new form.</td>
168 </tr><tr>
169 <td><a href="#Project.projectClosed">projectClosed</a></td>
170 <td>Public method to handle the closing of a project.</td>
171 </tr><tr>
172 <td><a href="#Project.projectClosedHooks">projectClosedHooks</a></td>
173 <td>Public method to remove our hook methods.</td>
174 </tr><tr>
175 <td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td>
176 <td>Public method to add our hook methods.</td>
177 </tr><tr>
178 <td><a href="#Project.updateCatalogs">updateCatalogs</a></td>
179 <td>Public method to update the message catalogs.</td>
180 </tr><tr>
181 <td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td>
182 <td>Public method to update the message catalogs.</td>
183 </tr>
184 </table>
185 <h3>Static Methods</h3>
186 <table>
187 <tr><td>None</td></tr>
188 </table>
189 <a NAME="Project.__init__" ID="Project.__init__"></a>
190 <h4>Project (Constructor)</h4>
191 <b>Project</b>(<i>plugin, parent = None</i>)
192 <p>
193 Constructor
194 </p><dl>
195 <dt><i>plugin</i></dt>
196 <dd>
197 reference to the plugin object
198 </dd><dt><i>parent</i></dt>
199 <dd>
200 parent (QObject)
201 </dd>
202 </dl><a NAME="Project.__buildDistribution" ID="Project.__buildDistribution"></a>
203 <h4>Project.__buildDistribution</h4>
204 <b>__buildDistribution</b>(<i></i>)
205 <p>
206 Private slot to build a distribution file for the current Pyramid project.
207 </p><a NAME="Project.__createProject" ID="Project.__createProject"></a>
208 <h4>Project.__createProject</h4>
209 <b>__createProject</b>(<i></i>)
210 <p>
211 Private slot to create a new Pyramid project.
212 </p><a NAME="Project.__findProjects" ID="Project.__findProjects"></a>
213 <h4>Project.__findProjects</h4>
214 <b>__findProjects</b>(<i></i>)
215 <p>
216 Private method to determine the relative path of all Pyramid
217 projects (= top level dirs).
218 </p><dl>
219 <dt>Returns:</dt>
220 <dd>
221 list of projects (list of string)
222 </dd>
223 </dl><a NAME="Project.__getInitDbCommand" ID="Project.__getInitDbCommand"></a>
224 <h4>Project.__getInitDbCommand</h4>
225 <b>__getInitDbCommand</b>(<i></i>)
226 <p>
227 Private method to create the path to the initialization script.
228 </p><dl>
229 <dt>Returns:</dt>
230 <dd>
231 path to the initialization script (string)
232 </dd>
233 </dl><a NAME="Project.__getLocale" ID="Project.__getLocale"></a>
234 <h4>Project.__getLocale</h4>
235 <b>__getLocale</b>(<i>filename</i>)
236 <p>
237 Private method to extract the locale out of a file name.
238 </p><dl>
239 <dt><i>filename</i></dt>
240 <dd>
241 name of the file used for extraction (string)
242 </dd>
243 </dl><dl>
244 <dt>Returns:</dt>
245 <dd>
246 extracted locale (string) or None
247 </dd>
248 </dl><a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a>
249 <h4>Project.__getVirtualEnvironment</h4>
250 <b>__getVirtualEnvironment</b>(<i></i>)
251 <p>
252 Private method to get the path of the virtual environment.
253 </p><dl>
254 <dt>Returns:</dt>
255 <dd>
256 path of the virtual environment (string)
257 </dd>
258 </dl><a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a>
259 <h4>Project.__initializeDatabase</h4>
260 <b>__initializeDatabase</b>(<i></i>)
261 <p>
262 Private slot to initialize the database of the Pyramid project.
263 </p><a NAME="Project.__normalizeList" ID="Project.__normalizeList"></a>
264 <h4>Project.__normalizeList</h4>
265 <b>__normalizeList</b>(<i>filenames</i>)
266 <p>
267 Private method to normalize a list of file names.
268 </p><dl>
269 <dt><i>filenames</i></dt>
270 <dd>
271 list of file names to normalize (list of string)
272 </dd>
273 </dl><dl>
274 <dt>Returns:</dt>
275 <dd>
276 normalized file names (list of string)
277 </dd>
278 </dl><a NAME="Project.__project" ID="Project.__project"></a>
279 <h4>Project.__project</h4>
280 <b>__project</b>(<i></i>)
281 <p>
282 Private method to get the name of the current Pyramid project.
283 </p><dl>
284 <dt>Returns:</dt>
285 <dd>
286 name of the project (string)
287 </dd>
288 </dl><dl>
289 <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt>
290 <dd>
291 raised, if no project is selected
292 </dd>
293 </dl><a NAME="Project.__projectFilteredList" ID="Project.__projectFilteredList"></a>
294 <h4>Project.__projectFilteredList</h4>
295 <b>__projectFilteredList</b>(<i>filenames</i>)
296 <p>
297 Private method to filter a list of file names by Pyramid project.
298 </p><dl>
299 <dt><i>filenames</i></dt>
300 <dd>
301 list of file names to be filtered (list of string)
302 </dd>
303 </dl><dl>
304 <dt>Returns:</dt>
305 <dd>
306 file names belonging to the current site (list of string)
307 </dd>
308 </dl><a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a>
309 <h4>Project.__projectLanguageAdded</h4>
310 <b>__projectLanguageAdded</b>(<i>code</i>)
311 <p>
312 Private slot handling the addition of a new language.
313 </p><dl>
314 <dt><i>code</i></dt>
315 <dd>
316 language code of the new language (string)
317 </dd>
318 </dl><a NAME="Project.__projectPath" ID="Project.__projectPath"></a>
319 <h4>Project.__projectPath</h4>
320 <b>__projectPath</b>(<i></i>)
321 <p>
322 Private method to calculate the full path of the Pyramid project.
323 </p><dl>
324 <dt>Returns:</dt>
325 <dd>
326 path of the project (string)
327 </dd>
328 </dl><dl>
329 <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt>
330 <dd>
331 raised, if no project is selected
332 </dd>
333 </dl><a NAME="Project.__pyramidInfo" ID="Project.__pyramidInfo"></a>
334 <h4>Project.__pyramidInfo</h4>
335 <b>__pyramidInfo</b>(<i></i>)
336 <p>
337 Private slot to show some info about Pyramid.
338 </p><a NAME="Project.__runBrowser" ID="Project.__runBrowser"></a>
339 <h4>Project.__runBrowser</h4>
340 <b>__runBrowser</b>(<i></i>)
341 <p>
342 Private slot to start the default web browser with the server URL.
343 </p><a NAME="Project.__runLoggingServer" ID="Project.__runLoggingServer"></a>
344 <h4>Project.__runLoggingServer</h4>
345 <b>__runLoggingServer</b>(<i></i>)
346 <p>
347 Private slot to start the Pyramid Web server with logging.
348 </p><a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a>
349 <h4>Project.__runPythonShell</h4>
350 <b>__runPythonShell</b>(<i></i>)
351 <p>
352 Private slot to start a Python console for a Pyramid project.
353 </p><a NAME="Project.__runServer" ID="Project.__runServer"></a>
354 <h4>Project.__runServer</h4>
355 <b>__runServer</b>(<i>logging = False</i>)
356 <p>
357 Private slot to start the Pyramid Web server.
358 </p><dl>
359 <dt><i>logging</i></dt>
360 <dd>
361 flag indicating to enable logging (boolean)
362 </dd>
363 </dl><a NAME="Project.__selectProject" ID="Project.__selectProject"></a>
364 <h4>Project.__selectProject</h4>
365 <b>__selectProject</b>(<i></i>)
366 <p>
367 Private method to select a Pyramid project to work with.
368 </p><dl>
369 <dt>Returns:</dt>
370 <dd>
371 selected project (string)
372 </dd>
373 </dl><a NAME="Project.__serverProcFinished" ID="Project.__serverProcFinished"></a>
374 <h4>Project.__serverProcFinished</h4>
375 <b>__serverProcFinished</b>(<i></i>)
376 <p>
377 Private slot connected to the finished signal.
378 </p><a NAME="Project.__setCurrentProject" ID="Project.__setCurrentProject"></a>
379 <h4>Project.__setCurrentProject</h4>
380 <b>__setCurrentProject</b>(<i>project</i>)
381 <p>
382 Private slot to set the current project.
383 </p><dl>
384 <dt><i>project</i></dt>
385 <dd>
386 name of the project (string)
387 </dd>
388 </dl><a NAME="Project.__setupDevelop" ID="Project.__setupDevelop"></a>
389 <h4>Project.__setupDevelop</h4>
390 <b>__setupDevelop</b>(<i></i>)
391 <p>
392 Private slot to set up the development environment for the current project.
393 </p><a NAME="Project.__showDocumentation" ID="Project.__showDocumentation"></a>
394 <h4>Project.__showDocumentation</h4>
395 <b>__showDocumentation</b>(<i></i>)
396 <p>
397 Private slot to show the helpviewer with the Pyramid documentation.
398 </p><a NAME="Project.__showMatchingViews" ID="Project.__showMatchingViews"></a>
399 <h4>Project.__showMatchingViews</h4>
400 <b>__showMatchingViews</b>(<i></i>)
401 <p>
402 Private slot showing all views that would match a given URL.
403 </p><a NAME="Project.__showRoutes" ID="Project.__showRoutes"></a>
404 <h4>Project.__showRoutes</h4>
405 <b>__showRoutes</b>(<i></i>)
406 <p>
407 Private slot showing all URL dispatch routes.
408 </p><a NAME="Project.__showTweens" ID="Project.__showTweens"></a>
409 <h4>Project.__showTweens</h4>
410 <b>__showTweens</b>(<i></i>)
411 <p>
412 Private slot showing all implicit and explicit tween objects.
413 </p><a NAME="Project.compileCatalogs" ID="Project.compileCatalogs"></a>
414 <h4>Project.compileCatalogs</h4>
415 <b>compileCatalogs</b>(<i>filenames</i>)
416 <p>
417 Public method to compile the message catalogs.
418 </p><dl>
419 <dt><i>filenames</i></dt>
420 <dd>
421 list of filenames (not used)
422 </dd>
423 </dl><a NAME="Project.compileSelectedCatalogs" ID="Project.compileSelectedCatalogs"></a>
424 <h4>Project.compileSelectedCatalogs</h4>
425 <b>compileSelectedCatalogs</b>(<i>filenames</i>)
426 <p>
427 Public method to update the message catalogs.
428 </p><dl>
429 <dt><i>filenames</i></dt>
430 <dd>
431 list of file names (list of string)
432 </dd>
433 </dl><a NAME="Project.extractMessages" ID="Project.extractMessages"></a>
434 <h4>Project.extractMessages</h4>
435 <b>extractMessages</b>(<i></i>)
436 <p>
437 Public method to extract the messages catalog template file.
438 </p><a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a>
439 <h4>Project.getPyramidCommand</h4>
440 <b>getPyramidCommand</b>(<i>cmd</i>)
441 <p>
442 Public method to build a Pyramid command.
443 </p><dl>
444 <dt><i>cmd</i></dt>
445 <dd>
446 command (string)
447 </dd>
448 </dl><dl>
449 <dt>Returns:</dt>
450 <dd>
451 full pyramid command (string)
452 </dd>
453 </dl><a NAME="Project.getPythonCommand" ID="Project.getPythonCommand"></a>
454 <h4>Project.getPythonCommand</h4>
455 <b>getPythonCommand</b>(<i></i>)
456 <p>
457 Public method to build the Python command.
458 </p><dl>
459 <dt>Returns:</dt>
460 <dd>
461 python command (string)
462 </dd>
463 </dl><a NAME="Project.initActions" ID="Project.initActions"></a>
464 <h4>Project.initActions</h4>
465 <b>initActions</b>(<i></i>)
466 <p>
467 Public method to define the Pyramid actions.
468 </p><a NAME="Project.initMenu" ID="Project.initMenu"></a>
469 <h4>Project.initMenu</h4>
470 <b>initMenu</b>(<i></i>)
471 <p>
472 Public slot to initialize the Pyramid menu.
473 </p><dl>
474 <dt>Returns:</dt>
475 <dd>
476 the menu generated (QMenu)
477 </dd>
478 </dl><a NAME="Project.isSpawningConsole" ID="Project.isSpawningConsole"></a>
479 <h4>Project.isSpawningConsole</h4>
480 <b>isSpawningConsole</b>(<i>consoleCmd</i>)
481 <p>
482 Public method to check, if the given console is a spawning console.
483 </p><dl>
484 <dt><i>consoleCmd</i></dt>
485 <dd>
486 console command (string)
487 </dd>
488 </dl><dl>
489 <dt>Returns:</dt>
490 <dd>
491 tuple of two entries giving an indication, if the console
492 is spawning (boolean) and the (possibly) cleaned console command
493 (string)
494 </dd>
495 </dl><a NAME="Project.newForm" ID="Project.newForm"></a>
496 <h4>Project.newForm</h4>
497 <b>newForm</b>(<i>path</i>)
498 <p>
499 Public method to create a new form.
500 </p><dl>
501 <dt><i>path</i></dt>
502 <dd>
503 full directory path for the new form file (string)
504 </dd>
505 </dl><a NAME="Project.projectClosed" ID="Project.projectClosed"></a>
506 <h4>Project.projectClosed</h4>
507 <b>projectClosed</b>(<i></i>)
508 <p>
509 Public method to handle the closing of a project.
510 </p><a NAME="Project.projectClosedHooks" ID="Project.projectClosedHooks"></a>
511 <h4>Project.projectClosedHooks</h4>
512 <b>projectClosedHooks</b>(<i></i>)
513 <p>
514 Public method to remove our hook methods.
515 </p><a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a>
516 <h4>Project.projectOpenedHooks</h4>
517 <b>projectOpenedHooks</b>(<i></i>)
518 <p>
519 Public method to add our hook methods.
520 </p><a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a>
521 <h4>Project.updateCatalogs</h4>
522 <b>updateCatalogs</b>(<i>filenames</i>)
523 <p>
524 Public method to update the message catalogs.
525 </p><dl>
526 <dt><i>filenames</i></dt>
527 <dd>
528 list of filenames (not used)
529 </dd>
530 </dl><a NAME="Project.updateSelectedCatalogs" ID="Project.updateSelectedCatalogs"></a>
531 <h4>Project.updateSelectedCatalogs</h4>
532 <b>updateSelectedCatalogs</b>(<i>filenames</i>)
533 <p>
534 Public method to update the message catalogs.
535 </p><dl>
536 <dt><i>filenames</i></dt>
537 <dd>
538 list of filenames
539 </dd>
540 </dl>
541 <div align="right"><a href="#top">Up</a></div>
542 <hr /><hr />
543 <a NAME="PyramidNoProjectSelectedException" ID="PyramidNoProjectSelectedException"></a>
544 <h2>PyramidNoProjectSelectedException</h2>
545 <p>
546 Exception thrown to signal, that there is no current Pyramid project.
547 </p>
548 <h3>Derived from</h3>
549 Exception
550 <h3>Class Attributes</h3>
551 <table>
552 <tr><td>None</td></tr>
553 </table>
554 <h3>Class Methods</h3>
555 <table>
556 <tr><td>None</td></tr>
557 </table>
558 <h3>Methods</h3>
559 <table>
560 <tr><td>None</td></tr>
561 </table>
562 <h3>Static Methods</h3>
563 <table>
564 <tr><td>None</td></tr>
565 </table>
566
567 <div align="right"><a href="#top">Up</a></div>
568 <hr />
569 </body></html>

Mercurial Repository: Pyramid Project

eric ide

mercurial