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

changeset 44
989c961c33ab
parent 37
1b089e0fba1e
child 48
c313efdb01de
equal deleted inserted replaced
43:14e0bd707f16 44:989c961c33ab
70 <td>Private slot to create a new Pyramid project.</td> 70 <td>Private slot to create a new Pyramid project.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#Project.__findProjects">__findProjects</a></td> 72 <td><a href="#Project.__findProjects">__findProjects</a></td>
73 <td>Private method to determine the relative path of all Pyramid projects (= top level dirs).</td> 73 <td>Private method to determine the relative path of all Pyramid projects (= top level dirs).</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#Project.__getExecutablePaths">__getExecutablePaths</a></td>
76 <td>Private method to build all full path of an executable file from the environment.</td>
77 </tr><tr>
75 <td><a href="#Project.__getInitDbCommand">__getInitDbCommand</a></td> 78 <td><a href="#Project.__getInitDbCommand">__getInitDbCommand</a></td>
76 <td>Private method to create the path to the initialization script.</td> 79 <td>Private method to create the path to the initialization script.</td>
77 </tr><tr> 80 </tr><tr>
78 <td><a href="#Project.__getLocale">__getLocale</a></td> 81 <td><a href="#Project.__getLocale">__getLocale</a></td>
79 <td>Private method to extract the locale out of a file name.</td> 82 <td>Private method to extract the locale out of a file name.</td>
148 <td>Public method to extract the messages catalog template file.</td> 151 <td>Public method to extract the messages catalog template file.</td>
149 </tr><tr> 152 </tr><tr>
150 <td><a href="#Project.getPyramidCommand">getPyramidCommand</a></td> 153 <td><a href="#Project.getPyramidCommand">getPyramidCommand</a></td>
151 <td>Public method to build a Pyramid command.</td> 154 <td>Public method to build a Pyramid command.</td>
152 </tr><tr> 155 </tr><tr>
156 <td><a href="#Project.getPyramidVersion">getPyramidVersion</a></td>
157 <td>Public method to get the Pyramid version.</td>
158 </tr><tr>
153 <td><a href="#Project.getPythonCommand">getPythonCommand</a></td> 159 <td><a href="#Project.getPythonCommand">getPythonCommand</a></td>
154 <td>Public method to build the Python command.</td> 160 <td>Public method to build the Python command.</td>
155 </tr><tr> 161 </tr><tr>
156 <td><a href="#Project.initActions">initActions</a></td> 162 <td><a href="#Project.initActions">initActions</a></td>
157 <td>Public method to define the Pyramid actions.</td> 163 <td>Public method to define the Pyramid actions.</td>
171 <td><a href="#Project.projectClosedHooks">projectClosedHooks</a></td> 177 <td><a href="#Project.projectClosedHooks">projectClosedHooks</a></td>
172 <td>Public method to remove our hook methods.</td> 178 <td>Public method to remove our hook methods.</td>
173 </tr><tr> 179 </tr><tr>
174 <td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td> 180 <td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td>
175 <td>Public method to add our hook methods.</td> 181 <td>Public method to add our hook methods.</td>
182 </tr><tr>
183 <td><a href="#Project.supportedPythonVariants">supportedPythonVariants</a></td>
184 <td>Public method to get the supported Python variants.</td>
176 </tr><tr> 185 </tr><tr>
177 <td><a href="#Project.updateCatalogs">updateCatalogs</a></td> 186 <td><a href="#Project.updateCatalogs">updateCatalogs</a></td>
178 <td>Public method to update the message catalogs.</td> 187 <td>Public method to update the message catalogs.</td>
179 </tr><tr> 188 </tr><tr>
180 <td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td> 189 <td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td>
217 </p><dl> 226 </p><dl>
218 <dt>Returns:</dt> 227 <dt>Returns:</dt>
219 <dd> 228 <dd>
220 list of projects (list of string) 229 list of projects (list of string)
221 </dd> 230 </dd>
231 </dl><a NAME="Project.__getExecutablePaths" ID="Project.__getExecutablePaths"></a>
232 <h4>Project.__getExecutablePaths</h4>
233 <b>__getExecutablePaths</b>(<i>file</i>)
234 <p>
235 Private method to build all full path of an executable file from
236 the environment.
237 </p><dl>
238 <dt><i>file</i></dt>
239 <dd>
240 filename of the executable (string)
241 </dd>
242 </dl><dl>
243 <dt>Returns:</dt>
244 <dd>
245 list of full executable names, if the executable file is accessible
246 via the searchpath defined by the PATH environment variable, or an
247 empty list otherwise.
248 </dd>
222 </dl><a NAME="Project.__getInitDbCommand" ID="Project.__getInitDbCommand"></a> 249 </dl><a NAME="Project.__getInitDbCommand" ID="Project.__getInitDbCommand"></a>
223 <h4>Project.__getInitDbCommand</h4> 250 <h4>Project.__getInitDbCommand</h4>
224 <b>__getInitDbCommand</b>(<i></i>) 251 <b>__getInitDbCommand</b>(<i></i>)
225 <p> 252 <p>
226 Private method to create the path to the initialization script. 253 Private method to create the path to the initialization script.
244 <dd> 271 <dd>
245 extracted locale (string) or None 272 extracted locale (string) or None
246 </dd> 273 </dd>
247 </dl><a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a> 274 </dl><a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a>
248 <h4>Project.__getVirtualEnvironment</h4> 275 <h4>Project.__getVirtualEnvironment</h4>
249 <b>__getVirtualEnvironment</b>(<i></i>) 276 <b>__getVirtualEnvironment</b>(<i>language=""</i>)
250 <p> 277 <p>
251 Private method to get the path of the virtual environment. 278 Private method to get the path of the virtual environment.
252 </p><dl> 279 </p><dl>
280 <dt><i>language</i></dt>
281 <dd>
282 Python variant to get the virtual environment
283 for (string, one of '', 'Python2' or 'Python3')
284 </dd>
285 </dl><dl>
253 <dt>Returns:</dt> 286 <dt>Returns:</dt>
254 <dd> 287 <dd>
255 path of the virtual environment (string) 288 path of the virtual environment (string)
256 </dd> 289 </dd>
257 </dl><a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a> 290 </dl><a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a>
434 <b>extractMessages</b>(<i></i>) 467 <b>extractMessages</b>(<i></i>)
435 <p> 468 <p>
436 Public method to extract the messages catalog template file. 469 Public method to extract the messages catalog template file.
437 </p><a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a> 470 </p><a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a>
438 <h4>Project.getPyramidCommand</h4> 471 <h4>Project.getPyramidCommand</h4>
439 <b>getPyramidCommand</b>(<i>cmd</i>) 472 <b>getPyramidCommand</b>(<i>cmd, language=""</i>)
440 <p> 473 <p>
441 Public method to build a Pyramid command. 474 Public method to build a Pyramid command.
442 </p><dl> 475 </p><dl>
443 <dt><i>cmd</i></dt> 476 <dt><i>cmd</i></dt>
444 <dd> 477 <dd>
445 command (string) 478 command (string)
479 </dd><dt><i>language</i></dt>
480 <dd>
481 Python variant to get the virtual environment
482 for (string, one of '', 'Python2' or 'Python3')
446 </dd> 483 </dd>
447 </dl><dl> 484 </dl><dl>
448 <dt>Returns:</dt> 485 <dt>Returns:</dt>
449 <dd> 486 <dd>
450 full pyramid command (string) 487 full pyramid command (string)
488 </dd>
489 </dl><a NAME="Project.getPyramidVersion" ID="Project.getPyramidVersion"></a>
490 <h4>Project.getPyramidVersion</h4>
491 <b>getPyramidVersion</b>(<i></i>)
492 <p>
493 Public method to get the Pyramid version.
494 </p><dl>
495 <dt>Returns:</dt>
496 <dd>
497 Pyramid version (string)
451 </dd> 498 </dd>
452 </dl><a NAME="Project.getPythonCommand" ID="Project.getPythonCommand"></a> 499 </dl><a NAME="Project.getPythonCommand" ID="Project.getPythonCommand"></a>
453 <h4>Project.getPythonCommand</h4> 500 <h4>Project.getPythonCommand</h4>
454 <b>getPythonCommand</b>(<i></i>) 501 <b>getPythonCommand</b>(<i></i>)
455 <p> 502 <p>
514 </p><a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a> 561 </p><a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a>
515 <h4>Project.projectOpenedHooks</h4> 562 <h4>Project.projectOpenedHooks</h4>
516 <b>projectOpenedHooks</b>(<i></i>) 563 <b>projectOpenedHooks</b>(<i></i>)
517 <p> 564 <p>
518 Public method to add our hook methods. 565 Public method to add our hook methods.
519 </p><a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a> 566 </p><a NAME="Project.supportedPythonVariants" ID="Project.supportedPythonVariants"></a>
567 <h4>Project.supportedPythonVariants</h4>
568 <b>supportedPythonVariants</b>(<i></i>)
569 <p>
570 Public method to get the supported Python variants.
571 </p><dl>
572 <dt>Returns:</dt>
573 <dd>
574 list of supported Python variants (list of strings)
575 </dd>
576 </dl><a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a>
520 <h4>Project.updateCatalogs</h4> 577 <h4>Project.updateCatalogs</h4>
521 <b>updateCatalogs</b>(<i>filenames</i>) 578 <b>updateCatalogs</b>(<i>filenames</i>)
522 <p> 579 <p>
523 Public method to update the message catalogs. 580 Public method to update the message catalogs.
524 </p><dl> 581 </p><dl>

eric ide

mercurial