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

branch
eric7
changeset 148
dcbd3a96f03c
parent 147
eb28b4b6f7f5
child 157
ddbc0e38ea1b
equal deleted inserted replaced
147:eb28b4b6f7f5 148:dcbd3a96f03c
83 <tr> 83 <tr>
84 <td><a href="#Project.__adjustWorkingDirectory">__adjustWorkingDirectory</a></td> 84 <td><a href="#Project.__adjustWorkingDirectory">__adjustWorkingDirectory</a></td>
85 <td>Private method to adjust the working directory in the arguments list.</td> 85 <td>Private method to adjust the working directory in the arguments list.</td>
86 </tr> 86 </tr>
87 <tr> 87 <tr>
88 <td><a href="#Project.__assemblePyramidCommand">__assemblePyramidCommand</a></td>
89 <td>Private method to assemble the full pyramid command for a given virtual environment.</td>
90 </tr>
91 <tr>
88 <td><a href="#Project.__buildDistribution">__buildDistribution</a></td> 92 <td><a href="#Project.__buildDistribution">__buildDistribution</a></td>
89 <td>Private slot to build a distribution file for the current Pyramid project.</td> 93 <td>Private slot to build a distribution file for the current Pyramid project.</td>
90 </tr> 94 </tr>
91 <tr> 95 <tr>
96 <td><a href="#Project.__createMigration">__createMigration</a></td>
97 <td>Private slot to create a new database migration.</td>
98 </tr>
99 <tr>
92 <td><a href="#Project.__createProject">__createProject</a></td> 100 <td><a href="#Project.__createProject">__createProject</a></td>
93 <td>Private slot to create a new Pyramid project.</td> 101 <td>Private slot to create a new Pyramid project.</td>
94 </tr> 102 </tr>
95 <tr> 103 <tr>
96 <td><a href="#Project.__findProjects">__findProjects</a></td> 104 <td><a href="#Project.__findProjects">__findProjects</a></td>
115 <tr> 123 <tr>
116 <td><a href="#Project.__getVirtualEnvironment">__getVirtualEnvironment</a></td> 124 <td><a href="#Project.__getVirtualEnvironment">__getVirtualEnvironment</a></td>
117 <td>Private method to get the path of the virtual environment.</td> 125 <td>Private method to get the path of the virtual environment.</td>
118 </tr> 126 </tr>
119 <tr> 127 <tr>
128 <td><a href="#Project.__initDatabaseActions">__initDatabaseActions</a></td>
129 <td>Private method to initialize the database related actions.</td>
130 </tr>
131 <tr>
120 <td><a href="#Project.__initializeDatabase">__initializeDatabase</a></td> 132 <td><a href="#Project.__initializeDatabase">__initializeDatabase</a></td>
121 <td>Private slot to initialize the database of the Pyramid project.</td> 133 <td>Private slot to initialize the database of the Pyramid project.</td>
122 </tr> 134 </tr>
123 <tr> 135 <tr>
124 <td><a href="#Project.__isSuitableForVariant">__isSuitableForVariant</a></td> 136 <td><a href="#Project.__isSuitableForVariant">__isSuitableForVariant</a></td>
139 <tr> 151 <tr>
140 <td><a href="#Project.__projectLanguageAdded">__projectLanguageAdded</a></td> 152 <td><a href="#Project.__projectLanguageAdded">__projectLanguageAdded</a></td>
141 <td>Private slot handling the addition of a new language.</td> 153 <td>Private slot handling the addition of a new language.</td>
142 </tr> 154 </tr>
143 <tr> 155 <tr>
144 <td><a href="#Project.__projectPath">__projectPath</a></td>
145 <td>Private method to calculate the full path of the Pyramid project.</td>
146 </tr>
147 <tr>
148 <td><a href="#Project.__pyramidInfo">__pyramidInfo</a></td> 156 <td><a href="#Project.__pyramidInfo">__pyramidInfo</a></td>
149 <td>Private slot to show some info about Pyramid.</td> 157 <td>Private slot to show some info about Pyramid.</td>
150 </tr> 158 </tr>
151 <tr> 159 <tr>
152 <td><a href="#Project.__runBrowser">__runBrowser</a></td> 160 <td><a href="#Project.__runBrowser">__runBrowser</a></td>
153 <td>Private slot to start the default web browser with the server URL.</td> 161 <td>Private slot to start the default web browser with the server URL.</td>
154 </tr> 162 </tr>
155 <tr> 163 <tr>
156 <td><a href="#Project.__runLoggingServer">__runLoggingServer</a></td>
157 <td>Private slot to start the Pyramid Web server with logging.</td>
158 </tr>
159 <tr>
160 <td><a href="#Project.__runPythonShell">__runPythonShell</a></td> 164 <td><a href="#Project.__runPythonShell">__runPythonShell</a></td>
161 <td>Private slot to start a Python console for a Pyramid project.</td> 165 <td>Private slot to start a Python console for a Pyramid project.</td>
162 </tr> 166 </tr>
163 <tr> 167 <tr>
164 <td><a href="#Project.__runServer">__runServer</a></td> 168 <td><a href="#Project.__runServer">__runServer</a></td>
175 <tr> 179 <tr>
176 <td><a href="#Project.__setCurrentProject">__setCurrentProject</a></td> 180 <td><a href="#Project.__setCurrentProject">__setCurrentProject</a></td>
177 <td>Private slot to set the current project.</td> 181 <td>Private slot to set the current project.</td>
178 </tr> 182 </tr>
179 <tr> 183 <tr>
180 <td><a href="#Project.__setupDevelop">__setupDevelop</a></td>
181 <td>Private slot to set up the development environment for the current project.</td>
182 </tr>
183 <tr>
184 <td><a href="#Project.__showDocumentation">__showDocumentation</a></td> 184 <td><a href="#Project.__showDocumentation">__showDocumentation</a></td>
185 <td>Private slot to show the helpviewer with the Pyramid documentation.</td> 185 <td>Private slot to show the helpviewer with the Pyramid documentation.</td>
186 </tr> 186 </tr>
187 <tr> 187 <tr>
188 <td><a href="#Project.__showMatchingViews">__showMatchingViews</a></td> 188 <td><a href="#Project.__showMatchingViews">__showMatchingViews</a></td>
189 <td>Private slot showing all views that would match a given URL.</td> 189 <td>Private slot showing all views that would match a given URL.</td>
190 </tr> 190 </tr>
191 <tr> 191 <tr>
192 <td><a href="#Project.__showMigrationsHistory">__showMigrationsHistory</a></td>
193 <td>Private slot to show the full migrations history.</td>
194 </tr>
195 <tr>
196 <td><a href="#Project.__showMigrationsSummary">__showMigrationsSummary</a></td>
197 <td>Private slot to show a migrations history summary.</td>
198 </tr>
199 <tr>
192 <td><a href="#Project.__showRoutes">__showRoutes</a></td> 200 <td><a href="#Project.__showRoutes">__showRoutes</a></td>
193 <td>Private slot showing all URL dispatch routes.</td> 201 <td>Private slot showing all URL dispatch routes.</td>
194 </tr> 202 </tr>
195 <tr> 203 <tr>
196 <td><a href="#Project.__showTweens">__showTweens</a></td> 204 <td><a href="#Project.__showTweens">__showTweens</a></td>
203 <tr> 211 <tr>
204 <td><a href="#Project.compileSelectedCatalogs">compileSelectedCatalogs</a></td> 212 <td><a href="#Project.compileSelectedCatalogs">compileSelectedCatalogs</a></td>
205 <td>Public method to update the message catalogs.</td> 213 <td>Public method to update the message catalogs.</td>
206 </tr> 214 </tr>
207 <tr> 215 <tr>
216 <td><a href="#Project.downgradeDatabase">downgradeDatabase</a></td>
217 <td>Public slot to downgrade the database to the previous or a given version.</td>
218 </tr>
219 <tr>
208 <td><a href="#Project.extractMessages">extractMessages</a></td> 220 <td><a href="#Project.extractMessages">extractMessages</a></td>
209 <td>Public method to extract the messages catalog template file.</td> 221 <td>Public method to extract the messages catalog template file.</td>
210 </tr> 222 </tr>
211 <tr> 223 <tr>
224 <td><a href="#Project.getAlembicCommand">getAlembicCommand</a></td>
225 <td>Public method to get the path to the alembic executable of the current Pyramid project.</td>
226 </tr>
227 <tr>
212 <td><a href="#Project.getMenu">getMenu</a></td> 228 <td><a href="#Project.getMenu">getMenu</a></td>
213 <td>Public method to get a reference to the requested menu.</td> 229 <td>Public method to get a reference to the requested menu.</td>
214 </tr> 230 </tr>
215 <tr> 231 <tr>
216 <td><a href="#Project.getMenuNames">getMenuNames</a></td> 232 <td><a href="#Project.getMenuNames">getMenuNames</a></td>
217 <td>Public method to get the names of all menus.</td> 233 <td>Public method to get the names of all menus.</td>
218 </tr> 234 </tr>
219 <tr> 235 <tr>
236 <td><a href="#Project.getProjectVirtualEnvironment">getProjectVirtualEnvironment</a></td>
237 <td>Public method to generate the path of the project virtual environment.</td>
238 </tr>
239 <tr>
220 <td><a href="#Project.getPyramidCommand">getPyramidCommand</a></td> 240 <td><a href="#Project.getPyramidCommand">getPyramidCommand</a></td>
221 <td>Public method to build a Pyramid command.</td> 241 <td>Public method to build a Pyramid command.</td>
222 </tr> 242 </tr>
223 <tr> 243 <tr>
224 <td><a href="#Project.getPyramidVersion">getPyramidVersion</a></td> 244 <td><a href="#Project.getPyramidVersion">getPyramidVersion</a></td>
243 <tr> 263 <tr>
244 <td><a href="#Project.isSpawningConsole">isSpawningConsole</a></td> 264 <td><a href="#Project.isSpawningConsole">isSpawningConsole</a></td>
245 <td>Public method to check, if the given console is a spawning console.</td> 265 <td>Public method to check, if the given console is a spawning console.</td>
246 </tr> 266 </tr>
247 <tr> 267 <tr>
268 <td><a href="#Project.migrationsPath">migrationsPath</a></td>
269 <td>Public method to get the path to the migrations directory of the current Pyramid project.</td>
270 </tr>
271 <tr>
248 <td><a href="#Project.newForm">newForm</a></td> 272 <td><a href="#Project.newForm">newForm</a></td>
249 <td>Public method to create a new form.</td> 273 <td>Public method to create a new form.</td>
250 </tr> 274 </tr>
251 <tr> 275 <tr>
252 <td><a href="#Project.openPOEditor">openPOEditor</a></td> 276 <td><a href="#Project.openPOEditor">openPOEditor</a></td>
263 <tr> 287 <tr>
264 <td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td> 288 <td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td>
265 <td>Public method to add our hook methods.</td> 289 <td>Public method to add our hook methods.</td>
266 </tr> 290 </tr>
267 <tr> 291 <tr>
292 <td><a href="#Project.projectPath">projectPath</a></td>
293 <td>Public method to calculate the full path of the Pyramid project.</td>
294 </tr>
295 <tr>
268 <td><a href="#Project.registerOpenHook">registerOpenHook</a></td> 296 <td><a href="#Project.registerOpenHook">registerOpenHook</a></td>
269 <td>Public method to register the open hook to open a translations file in a translations editor.</td> 297 <td>Public method to register the open hook to open a translations file in a translations editor.</td>
270 </tr> 298 </tr>
271 <tr> 299 <tr>
272 <td><a href="#Project.supportedPythonVariants">supportedPythonVariants</a></td> 300 <td><a href="#Project.supportedPythonVariants">supportedPythonVariants</a></td>
277 <td>Public method to update the message catalogs.</td> 305 <td>Public method to update the message catalogs.</td>
278 </tr> 306 </tr>
279 <tr> 307 <tr>
280 <td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td> 308 <td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td>
281 <td>Public method to update the message catalogs.</td> 309 <td>Public method to update the message catalogs.</td>
310 </tr>
311 <tr>
312 <td><a href="#Project.upgradeDatabase">upgradeDatabase</a></td>
313 <td>Public slot to upgrade the database to the head or a given version.</td>
282 </tr> 314 </tr>
283 </table> 315 </table>
284 <h3>Static Methods</h3> 316 <h3>Static Methods</h3>
285 317
286 <table> 318 <table>
325 <dt><i>wd</i> (str)</dt> 357 <dt><i>wd</i> (str)</dt>
326 <dd> 358 <dd>
327 working directory 359 working directory
328 </dd> 360 </dd>
329 </dl> 361 </dl>
362 <a NAME="Project.__assemblePyramidCommand" ID="Project.__assemblePyramidCommand"></a>
363 <h4>Project.__assemblePyramidCommand</h4>
364 <b>__assemblePyramidCommand</b>(<i>cmd, virtualEnv</i>)
365
366 <p>
367 Private method to assemble the full pyramid command for a given virtual
368 environment.
369 </p>
370 <dl>
371
372 <dt><i>cmd</i> (str)</dt>
373 <dd>
374 command
375 </dd>
376 <dt><i>virtualEnv</i> (str)</dt>
377 <dd>
378 path of the project's Python virtual environment
379 </dd>
380 </dl>
381 <dl>
382 <dt>Return:</dt>
383 <dd>
384 assembled pyramid command
385 </dd>
386 </dl>
387 <dl>
388 <dt>Return Type:</dt>
389 <dd>
390 str
391 </dd>
392 </dl>
330 <a NAME="Project.__buildDistribution" ID="Project.__buildDistribution"></a> 393 <a NAME="Project.__buildDistribution" ID="Project.__buildDistribution"></a>
331 <h4>Project.__buildDistribution</h4> 394 <h4>Project.__buildDistribution</h4>
332 <b>__buildDistribution</b>(<i></i>) 395 <b>__buildDistribution</b>(<i></i>)
333 396
334 <p> 397 <p>
335 Private slot to build a distribution file for the current Pyramid 398 Private slot to build a distribution file for the current Pyramid
336 project. 399 project.
337 </p> 400 </p>
401 <a NAME="Project.__createMigration" ID="Project.__createMigration"></a>
402 <h4>Project.__createMigration</h4>
403 <b>__createMigration</b>(<i></i>)
404
405 <p>
406 Private slot to create a new database migration.
407 </p>
338 <a NAME="Project.__createProject" ID="Project.__createProject"></a> 408 <a NAME="Project.__createProject" ID="Project.__createProject"></a>
339 <h4>Project.__createProject</h4> 409 <h4>Project.__createProject</h4>
340 <b>__createProject</b>(<i></i>) 410 <b>__createProject</b>(<i></i>)
341 411
342 <p> 412 <p>
488 <dt>Return Type:</dt> 558 <dt>Return Type:</dt>
489 <dd> 559 <dd>
490 str 560 str
491 </dd> 561 </dd>
492 </dl> 562 </dl>
563 <a NAME="Project.__initDatabaseActions" ID="Project.__initDatabaseActions"></a>
564 <h4>Project.__initDatabaseActions</h4>
565 <b>__initDatabaseActions</b>(<i></i>)
566
567 <p>
568 Private method to initialize the database related actions.
569 </p>
493 <a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a> 570 <a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a>
494 <h4>Project.__initializeDatabase</h4> 571 <h4>Project.__initializeDatabase</h4>
495 <b>__initializeDatabase</b>(<i></i>) 572 <b>__initializeDatabase</b>(<i></i>)
496 573
497 <p> 574 <p>
619 <dt><i>code</i> (str)</dt> 696 <dt><i>code</i> (str)</dt>
620 <dd> 697 <dd>
621 language code of the new language 698 language code of the new language
622 </dd> 699 </dd>
623 </dl> 700 </dl>
624 <a NAME="Project.__projectPath" ID="Project.__projectPath"></a>
625 <h4>Project.__projectPath</h4>
626 <b>__projectPath</b>(<i></i>)
627
628 <p>
629 Private method to calculate the full path of the Pyramid project.
630 </p>
631 <dl>
632 <dt>Return:</dt>
633 <dd>
634 path of the project
635 </dd>
636 </dl>
637 <dl>
638 <dt>Return Type:</dt>
639 <dd>
640 str
641 </dd>
642 </dl>
643 <dl>
644
645 <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt>
646 <dd>
647 raised, if no project is
648 selected
649 </dd>
650 </dl>
651 <a NAME="Project.__pyramidInfo" ID="Project.__pyramidInfo"></a> 701 <a NAME="Project.__pyramidInfo" ID="Project.__pyramidInfo"></a>
652 <h4>Project.__pyramidInfo</h4> 702 <h4>Project.__pyramidInfo</h4>
653 <b>__pyramidInfo</b>(<i></i>) 703 <b>__pyramidInfo</b>(<i></i>)
654 704
655 <p> 705 <p>
660 <b>__runBrowser</b>(<i></i>) 710 <b>__runBrowser</b>(<i></i>)
661 711
662 <p> 712 <p>
663 Private slot to start the default web browser with the server URL. 713 Private slot to start the default web browser with the server URL.
664 </p> 714 </p>
665 <a NAME="Project.__runLoggingServer" ID="Project.__runLoggingServer"></a>
666 <h4>Project.__runLoggingServer</h4>
667 <b>__runLoggingServer</b>(<i></i>)
668
669 <p>
670 Private slot to start the Pyramid Web server with logging.
671 </p>
672 <a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a> 715 <a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a>
673 <h4>Project.__runPythonShell</h4> 716 <h4>Project.__runPythonShell</h4>
674 <b>__runPythonShell</b>(<i></i>) 717 <b>__runPythonShell</b>(<i></i>)
675 718
676 <p> 719 <p>
677 Private slot to start a Python console for a Pyramid project. 720 Private slot to start a Python console for a Pyramid project.
678 </p> 721 </p>
679 <a NAME="Project.__runServer" ID="Project.__runServer"></a> 722 <a NAME="Project.__runServer" ID="Project.__runServer"></a>
680 <h4>Project.__runServer</h4> 723 <h4>Project.__runServer</h4>
681 <b>__runServer</b>(<i>logging=False</i>) 724 <b>__runServer</b>(<i></i>)
682 725
683 <p> 726 <p>
684 Private slot to start the Pyramid Web server. 727 Private slot to start the Pyramid Web server.
685 </p> 728 </p>
686 <dl>
687
688 <dt><i>logging</i> (bool)</dt>
689 <dd>
690 flag indicating to enable logging
691 </dd>
692 </dl>
693 <a NAME="Project.__selectProject" ID="Project.__selectProject"></a> 729 <a NAME="Project.__selectProject" ID="Project.__selectProject"></a>
694 <h4>Project.__selectProject</h4> 730 <h4>Project.__selectProject</h4>
695 <b>__selectProject</b>(<i></i>) 731 <b>__selectProject</b>(<i></i>)
696 732
697 <p> 733 <p>
716 <dt><i>project</i> (str)</dt> 752 <dt><i>project</i> (str)</dt>
717 <dd> 753 <dd>
718 name of the project 754 name of the project
719 </dd> 755 </dd>
720 </dl> 756 </dl>
721 <a NAME="Project.__setupDevelop" ID="Project.__setupDevelop"></a>
722 <h4>Project.__setupDevelop</h4>
723 <b>__setupDevelop</b>(<i></i>)
724
725 <p>
726 Private slot to set up the development environment for the current
727 project.
728 </p>
729 <a NAME="Project.__showDocumentation" ID="Project.__showDocumentation"></a> 757 <a NAME="Project.__showDocumentation" ID="Project.__showDocumentation"></a>
730 <h4>Project.__showDocumentation</h4> 758 <h4>Project.__showDocumentation</h4>
731 <b>__showDocumentation</b>(<i></i>) 759 <b>__showDocumentation</b>(<i></i>)
732 760
733 <p> 761 <p>
738 <b>__showMatchingViews</b>(<i></i>) 766 <b>__showMatchingViews</b>(<i></i>)
739 767
740 <p> 768 <p>
741 Private slot showing all views that would match a given URL. 769 Private slot showing all views that would match a given URL.
742 </p> 770 </p>
771 <a NAME="Project.__showMigrationsHistory" ID="Project.__showMigrationsHistory"></a>
772 <h4>Project.__showMigrationsHistory</h4>
773 <b>__showMigrationsHistory</b>(<i></i>)
774
775 <p>
776 Private slot to show the full migrations history.
777 </p>
778 <a NAME="Project.__showMigrationsSummary" ID="Project.__showMigrationsSummary"></a>
779 <h4>Project.__showMigrationsSummary</h4>
780 <b>__showMigrationsSummary</b>(<i></i>)
781
782 <p>
783 Private slot to show a migrations history summary.
784 </p>
743 <a NAME="Project.__showRoutes" ID="Project.__showRoutes"></a> 785 <a NAME="Project.__showRoutes" ID="Project.__showRoutes"></a>
744 <h4>Project.__showRoutes</h4> 786 <h4>Project.__showRoutes</h4>
745 <b>__showRoutes</b>(<i></i>) 787 <b>__showRoutes</b>(<i></i>)
746 788
747 <p> 789 <p>
780 <dt><i>filenames</i> (list of str)</dt> 822 <dt><i>filenames</i> (list of str)</dt>
781 <dd> 823 <dd>
782 list of file names 824 list of file names
783 </dd> 825 </dd>
784 </dl> 826 </dl>
827 <a NAME="Project.downgradeDatabase" ID="Project.downgradeDatabase"></a>
828 <h4>Project.downgradeDatabase</h4>
829 <b>downgradeDatabase</b>(<i>revision=None</i>)
830
831 <p>
832 Public slot to downgrade the database to the previous or a given
833 version.
834 </p>
835 <dl>
836
837 <dt><i>revision</i> (str)</dt>
838 <dd>
839 migration revision to downgrade to
840 </dd>
841 </dl>
785 <a NAME="Project.extractMessages" ID="Project.extractMessages"></a> 842 <a NAME="Project.extractMessages" ID="Project.extractMessages"></a>
786 <h4>Project.extractMessages</h4> 843 <h4>Project.extractMessages</h4>
787 <b>extractMessages</b>(<i></i>) 844 <b>extractMessages</b>(<i></i>)
788 845
789 <p> 846 <p>
790 Public method to extract the messages catalog template file. 847 Public method to extract the messages catalog template file.
791 </p> 848 </p>
849 <a NAME="Project.getAlembicCommand" ID="Project.getAlembicCommand"></a>
850 <h4>Project.getAlembicCommand</h4>
851 <b>getAlembicCommand</b>(<i></i>)
852
853 <p>
854 Public method to get the path to the alembic executable of the current
855 Pyramid project.
856 </p>
857 <dl>
858 <dt>Return:</dt>
859 <dd>
860 path to the alembic executable
861 </dd>
862 </dl>
863 <dl>
864 <dt>Return Type:</dt>
865 <dd>
866 str
867 </dd>
868 </dl>
792 <a NAME="Project.getMenu" ID="Project.getMenu"></a> 869 <a NAME="Project.getMenu" ID="Project.getMenu"></a>
793 <h4>Project.getMenu</h4> 870 <h4>Project.getMenu</h4>
794 <b>getMenu</b>(<i>name</i>) 871 <b>getMenu</b>(<i>name</i>)
795 872
796 <p> 873 <p>
833 <dt>Return Type:</dt> 910 <dt>Return Type:</dt>
834 <dd> 911 <dd>
835 list of str 912 list of str
836 </dd> 913 </dd>
837 </dl> 914 </dl>
915 <a NAME="Project.getProjectVirtualEnvironment" ID="Project.getProjectVirtualEnvironment"></a>
916 <h4>Project.getProjectVirtualEnvironment</h4>
917 <b>getProjectVirtualEnvironment</b>(<i></i>)
918
919 <p>
920 Public method to generate the path of the project virtual environment.
921 </p>
922 <dl>
923 <dt>Return:</dt>
924 <dd>
925 path of the Pyramid project virtual environment
926 </dd>
927 </dl>
928 <dl>
929 <dt>Return Type:</dt>
930 <dd>
931 str
932 </dd>
933 </dl>
838 <a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a> 934 <a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a>
839 <h4>Project.getPyramidCommand</h4> 935 <h4>Project.getPyramidCommand</h4>
840 <b>getPyramidCommand</b>(<i>cmd, language=""</i>) 936 <b>getPyramidCommand</b>(<i>cmd, language="", virtualEnv=""</i>)
841 937
842 <p> 938 <p>
843 Public method to build a Pyramid command. 939 Public method to build a Pyramid command.
844 </p> 940 </p>
845 <dl> 941 <dl>
850 </dd> 946 </dd>
851 <dt><i>language</i> (str)</dt> 947 <dt><i>language</i> (str)</dt>
852 <dd> 948 <dd>
853 Python variant to get the virtual environment 949 Python variant to get the virtual environment
854 for (one of '' or 'Python3') 950 for (one of '' or 'Python3')
951 </dd>
952 <dt><i>virtualEnv</i> (str)</dt>
953 <dd>
954 path of the project's Python virtual environment
855 </dd> 955 </dd>
856 </dl> 956 </dl>
857 <dl> 957 <dl>
858 <dt>Return:</dt> 958 <dt>Return:</dt>
859 <dd> 959 <dd>
974 <dt>Return Type:</dt> 1074 <dt>Return Type:</dt>
975 <dd> 1075 <dd>
976 str 1076 str
977 </dd> 1077 </dd>
978 </dl> 1078 </dl>
1079 <a NAME="Project.migrationsPath" ID="Project.migrationsPath"></a>
1080 <h4>Project.migrationsPath</h4>
1081 <b>migrationsPath</b>(<i></i>)
1082
1083 <p>
1084 Public method to get the path to the migrations directory of the
1085 current Pyramid project.
1086 </p>
1087 <dl>
1088 <dt>Return:</dt>
1089 <dd>
1090 pathof the directory containing the migrations
1091 </dd>
1092 </dl>
1093 <dl>
1094 <dt>Return Type:</dt>
1095 <dd>
1096 str
1097 </dd>
1098 </dl>
979 <a NAME="Project.newForm" ID="Project.newForm"></a> 1099 <a NAME="Project.newForm" ID="Project.newForm"></a>
980 <h4>Project.newForm</h4> 1100 <h4>Project.newForm</h4>
981 <b>newForm</b>(<i>path</i>) 1101 <b>newForm</b>(<i>path</i>)
982 1102
983 <p> 1103 <p>
1023 <b>projectOpenedHooks</b>(<i></i>) 1143 <b>projectOpenedHooks</b>(<i></i>)
1024 1144
1025 <p> 1145 <p>
1026 Public method to add our hook methods. 1146 Public method to add our hook methods.
1027 </p> 1147 </p>
1148 <a NAME="Project.projectPath" ID="Project.projectPath"></a>
1149 <h4>Project.projectPath</h4>
1150 <b>projectPath</b>(<i></i>)
1151
1152 <p>
1153 Public method to calculate the full path of the Pyramid project.
1154 </p>
1155 <dl>
1156 <dt>Return:</dt>
1157 <dd>
1158 path of the project
1159 </dd>
1160 </dl>
1161 <dl>
1162 <dt>Return Type:</dt>
1163 <dd>
1164 str
1165 </dd>
1166 </dl>
1167 <dl>
1168
1169 <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt>
1170 <dd>
1171 raised, if no project is
1172 selected
1173 </dd>
1174 </dl>
1028 <a NAME="Project.registerOpenHook" ID="Project.registerOpenHook"></a> 1175 <a NAME="Project.registerOpenHook" ID="Project.registerOpenHook"></a>
1029 <h4>Project.registerOpenHook</h4> 1176 <h4>Project.registerOpenHook</h4>
1030 <b>registerOpenHook</b>(<i></i>) 1177 <b>registerOpenHook</b>(<i></i>)
1031 1178
1032 <p> 1179 <p>
1076 <dl> 1223 <dl>
1077 1224
1078 <dt><i>filenames</i> (list of str)</dt> 1225 <dt><i>filenames</i> (list of str)</dt>
1079 <dd> 1226 <dd>
1080 list of filenames 1227 list of filenames
1228 </dd>
1229 </dl>
1230 <a NAME="Project.upgradeDatabase" ID="Project.upgradeDatabase"></a>
1231 <h4>Project.upgradeDatabase</h4>
1232 <b>upgradeDatabase</b>(<i>revision=None</i>)
1233
1234 <p>
1235 Public slot to upgrade the database to the head or a given version.
1236 </p>
1237 <dl>
1238
1239 <dt><i>revision</i> (str)</dt>
1240 <dd>
1241 migration revision to upgrade to
1081 </dd> 1242 </dd>
1082 </dl> 1243 </dl>
1083 <div align="right"><a href="#top">Up</a></div> 1244 <div align="right"><a href="#top">Up</a></div>
1084 <hr /> 1245 <hr />
1085 <hr /> 1246 <hr />

Mercurial Repository: Pyramid Project

eric ide

mercurial