Django Project: comparison ProjectDjango/Documentation/source/Plugin_Project

-:2667e16a3379
+:dd36f90e77ee
 <link rel="stylesheet" href="styles.css">
 </head>
 <body>
 <a NAME="top" ID="top"></a>
 <h1>Plugin_Project_Django.ProjectDjango.Project</h1>
 <p>
 Module implementing the Django project support.
 </p>
 <h3>Global Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
 <table>
 <tr>
 <td><a href="#DjangoNoSiteSelectedError">DjangoNoSiteSelectedError</a></td>
 <td>Exception thrown to signal, that there is no current site.</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#QProcess">QProcess</a></td>
 <td>Class transforming the call arguments in case of gnome-terminal.</td>
 </tr>
 </table>
 <h3>Functions</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <hr />
 <hr />
 <a NAME="DjangoNoSiteSelectedError" ID="DjangoNoSiteSelectedError"></a>
 <h2>DjangoNoSiteSelectedError</h2>
 <p>
 Exception thrown to signal, that there is no current site.
 </p>
 <h3>Derived from</h3>
 Exception
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="Project" ID="Project"></a>
 <h2>Project</h2>
 <p>
 Class implementing the Django project support.
 </p>
 <h3>Derived from</h3>
 QObject
 <h3>Class Attributes</h3>
 <table>
-<tr><td>RecentApplicationsKey</td></tr><tr><td>RecentDatabaseNamesKey</td></tr>
+<tr><td>RecentApplicationsKey</td></tr>
+<tr><td>RecentDatabaseNamesKey</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
 <tr>
 <td><a href="#Project.__init__">Project</a></td>
 <td>Constructor</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#Project.updateSelectedCatalogsWithObsolete">updateSelectedCatalogsWithObsolete</a></td>
 <td>Public method to update the message catalogs keeping obsolete messages.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="Project.__init__" ID="Project.__init__"></a>
 <h4>Project (Constructor)</h4>
 <b>Project</b>(<i>plugin, iconSuffix, parent=None</i>)
 <p>
 Constructor
 </p>
 <dl>
 <dt><i>plugin</i> (ProjectDjangoPlugin)</dt>
 <dd>
 reference to the plugin object
 </dd>
 </dl>
 <a NAME="Project.__adjustWorkingDirectory" ID="Project.__adjustWorkingDirectory"></a>
 <h4>Project.__adjustWorkingDirectory</h4>
 <b>__adjustWorkingDirectory</b>(<i>args, wd</i>)
 <p>
 Private method to adjust the working directory in the arguments list.
 </p>
 <dl>
 <dt><i>args</i> (list of str)</dt>
 <dd>
 list of arguments to be modified
 </dd>
 </dl>
 <a NAME="Project.__applyAllMigrations" ID="Project.__applyAllMigrations"></a>
 <h4>Project.__applyAllMigrations</h4>
 <b>__applyAllMigrations</b>(<i></i>)
 <p>
 Private slot to apply all migrations.
 </p>
 <a NAME="Project.__applySelectedMigrations" ID="Project.__applySelectedMigrations"></a>
 <h4>Project.__applySelectedMigrations</h4>
 <b>__applySelectedMigrations</b>(<i></i>)
 <p>
 Private slot to apply selected migrations of a selected app.
 </p>
 <a NAME="Project.__changePassword" ID="Project.__changePassword"></a>
 <h4>Project.__changePassword</h4>
 <b>__changePassword</b>(<i></i>)
 <p>
 Private slot to change the password of a user.
 </p>
 <a NAME="Project.__clearSessions" ID="Project.__clearSessions"></a>
 <h4>Project.__clearSessions</h4>
 <b>__clearSessions</b>(<i></i>)
 <p>
 Private slot to clear expired sessions.
 </p>
 <a NAME="Project.__createApplication" ID="Project.__createApplication"></a>
 <h4>Project.__createApplication</h4>
 <b>__createApplication</b>(<i>applName, path, isGlobal=True</i>)
 <p>
 Private slot to create a new Django application.
 </p>
 <dl>
 <dt><i>applName</i> (str)</dt>
 <dd>
 name of the new application
 </dd>
 </dl>
 <a NAME="Project.__createCacheTables" ID="Project.__createCacheTables"></a>
 <h4>Project.__createCacheTables</h4>
 <b>__createCacheTables</b>(<i></i>)
 <p>
 Private slot to create the tables for the SQL caching backend.
 </p>
 <a NAME="Project.__createProject" ID="Project.__createProject"></a>
 <h4>Project.__createProject</h4>
 <b>__createProject</b>(<i>projectName, path</i>)
 <p>
 Private slot to create a new Django project.
 </p>
 <dl>
 <dt><i>projectName</i> (str)</dt>
 <dd>
 name of the new project
 </dd>
 </dl>
 <a NAME="Project.__createSuperUser" ID="Project.__createSuperUser"></a>
 <h4>Project.__createSuperUser</h4>
 <b>__createSuperUser</b>(<i></i>)
 <p>
 Private slot to create a super user account.
 </p>
 <a NAME="Project.__databaseFlush" ID="Project.__databaseFlush"></a>
 <h4>Project.__databaseFlush</h4>
 <b>__databaseFlush</b>(<i></i>)
 <p>
 Private slot to return all database tables to the state just after
 their installation.
 </p>
 <a NAME="Project.__databaseInspect" ID="Project.__databaseInspect"></a>
 <h4>Project.__databaseInspect</h4>
 <b>__databaseInspect</b>(<i></i>)
 <p>
 Private slot to introspect the database and output a Django model
 module.
 </p>
 <a NAME="Project.__databaseSqlFlushDatabase" ID="Project.__databaseSqlFlushDatabase"></a>
 <h4>Project.__databaseSqlFlushDatabase</h4>
 <b>__databaseSqlFlushDatabase</b>(<i></i>)
 <p>
 Private slot to print a list of statements to return all database
 tables to their initial state.
 </p>
 <a NAME="Project.__databaseSqlMigrate" ID="Project.__databaseSqlMigrate"></a>
 <h4>Project.__databaseSqlMigrate</h4>
 <b>__databaseSqlMigrate</b>(<i>backwards=False</i>)
 <p>
 Private slot to print the SQL statements for a migration of an
 application.
 </p>
 <dl>
 <dt><i>backwards</i> (bool)</dt>
 <dd>
 flag indicating to generate the SQL code to revert
 </dd>
 </dl>
 <a NAME="Project.__databaseSqlResetSequences" ID="Project.__databaseSqlResetSequences"></a>
 <h4>Project.__databaseSqlResetSequences</h4>
 <b>__databaseSqlResetSequences</b>(<i></i>)
 <p>
 Private slot to print the SQL statements for resetting sequences for
 one or more applications.
 </p>
 <a NAME="Project.__diffSettings" ID="Project.__diffSettings"></a>
 <h4>Project.__diffSettings</h4>
 <b>__diffSettings</b>(<i></i>)
 <p>
 Private slot to show the changes made to the settings.py file.
 </p>
 <a NAME="Project.__djangoInfo" ID="Project.__djangoInfo"></a>
 <h4>Project.__djangoInfo</h4>
 <b>__djangoInfo</b>(<i></i>)
 <p>
 Private slot to show some info about Django.
 </p>
 <a NAME="Project.__dumpData" ID="Project.__dumpData"></a>
 <h4>Project.__dumpData</h4>
 <b>__dumpData</b>(<i></i>)
 <p>
 Private slot to dump the database data to a fixture.
 </p>
 <a NAME="Project.__findSites" ID="Project.__findSites"></a>
 <h4>Project.__findSites</h4>
 <b>__findSites</b>(<i></i>)
 <p>
 Private method to determine the relative path to all manage.py scripts.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 list of sites
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__getApplications" ID="Project.__getApplications"></a>
 <h4>Project.__getApplications</h4>
 <b>__getApplications</b>(<i></i>)
 <p>
 Private method to ask the user for a list of application names.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 list of application names
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__getDebugEnvironment" ID="Project.__getDebugEnvironment"></a>
 <h4>Project.__getDebugEnvironment</h4>
 <b>__getDebugEnvironment</b>(<i>language=""</i>)
 <p>
 Private method to get the path of the debugger environment.
 </p>
 <dl>
 <dt><i>language</i> (str)</dt>
 <dd>
 Python variant to get the debugger environment
 </dd>
 </dl>
 <a NAME="Project.__getDjangoAdminCommand" ID="Project.__getDjangoAdminCommand"></a>
 <h4>Project.__getDjangoAdminCommand</h4>
 <b>__getDjangoAdminCommand</b>(<i>language=""</i>)
 <p>
 Private method to build a django-admin.py command.
 </p>
 <dl>
 <dt><i>language</i> (str)</dt>
 <dd>
 Python variant to get the django-admin.py
 </dd>
 </dl>
 <a NAME="Project.__getExecutablePaths" ID="Project.__getExecutablePaths"></a>
 <h4>Project.__getExecutablePaths</h4>
 <b>__getExecutablePaths</b>(<i>file</i>)
 <p>
 Private method to build all full paths of an executable file from
 the environment.
 </p>
 <dl>
 <dt><i>file</i> (str)</dt>
 <dd>
 filename of the executable
 </dd>
 </dl>
 <a NAME="Project.__getLocale" ID="Project.__getLocale"></a>
 <h4>Project.__getLocale</h4>
 <b>__getLocale</b>(<i>filename</i>)
 <p>
 Private method to extract the locale out of a file name.
 </p>
 <dl>
 <dt><i>filename</i> (str)</dt>
 <dd>
 name of the file used for extraction
 </dd>
 </dl>
 <a NAME="Project.__getMigrations" ID="Project.__getMigrations"></a>
 <h4>Project.__getMigrations</h4>
 <b>__getMigrations</b>(<i></i>)
 <p>
 Private method to get the available migrations.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 dictionary containing the available migrations
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__getPythonExecutable" ID="Project.__getPythonExecutable"></a>
 <h4>Project.__getPythonExecutable</h4>
 <b>__getPythonExecutable</b>(<i></i>)
 <p>
 Private method to build the Python command.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 python command
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a>
 <h4>Project.__getVirtualEnvironment</h4>
 <b>__getVirtualEnvironment</b>(<i>language=""</i>)
 <p>
 Private method to get the path of the virtual environment.
 </p>
 <dl>
 <dt><i>language</i> (str)</dt>
 <dd>
 Python variant to get the virtual environment
 </dd>
 </dl>
 <a NAME="Project.__initAuthorizationActions" ID="Project.__initAuthorizationActions"></a>
 <h4>Project.__initAuthorizationActions</h4>
 <b>__initAuthorizationActions</b>(<i></i>)
 <p>
 Private method to define the authorization actions.
 </p>
 <a NAME="Project.__initAuthorizationMenu" ID="Project.__initAuthorizationMenu"></a>
 <h4>Project.__initAuthorizationMenu</h4>
 <b>__initAuthorizationMenu</b>(<i></i>)
 <p>
 Private method to initialize the authorization menu.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 the menu generated
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__initDatabaseActions" ID="Project.__initDatabaseActions"></a>
 <h4>Project.__initDatabaseActions</h4>
 <b>__initDatabaseActions</b>(<i></i>)
 <p>
 Private method to define the database related actions.
 </p>
 <a NAME="Project.__initDatabaseMenu" ID="Project.__initDatabaseMenu"></a>
 <h4>Project.__initDatabaseMenu</h4>
 <b>__initDatabaseMenu</b>(<i></i>)
 <p>
 Private method to initialize the database menu.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 the menu generated
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__initDatabaseSqlActions" ID="Project.__initDatabaseSqlActions"></a>
 <h4>Project.__initDatabaseSqlActions</h4>
 <b>__initDatabaseSqlActions</b>(<i></i>)
 <p>
 Private method to define the database SQL related actions.
 </p>
 <a NAME="Project.__initDatabaseSqlMenu" ID="Project.__initDatabaseSqlMenu"></a>
 <h4>Project.__initDatabaseSqlMenu</h4>
 <b>__initDatabaseSqlMenu</b>(<i></i>)
 <p>
 Private method to initialize the database SQL submenu.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 the menu generated
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__initMigrationActions" ID="Project.__initMigrationActions"></a>
 <h4>Project.__initMigrationActions</h4>
 <b>__initMigrationActions</b>(<i></i>)
 <p>
 Private method to define the migration actions.
 </p>
 <a NAME="Project.__initMigrationsMenu" ID="Project.__initMigrationsMenu"></a>
 <h4>Project.__initMigrationsMenu</h4>
 <b>__initMigrationsMenu</b>(<i></i>)
 <p>
 Private method to initialize the Migrations submenu.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 the menu generated
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__initSessionActions" ID="Project.__initSessionActions"></a>
 <h4>Project.__initSessionActions</h4>
 <b>__initSessionActions</b>(<i></i>)
 <p>
 Private method to define the session actions.
 </p>
 <a NAME="Project.__initSessionMenu" ID="Project.__initSessionMenu"></a>
 <h4>Project.__initSessionMenu</h4>
 <b>__initSessionMenu</b>(<i></i>)
 <p>
 Private method to initialize the authorization menu.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 the menu generated
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__initTestingActions" ID="Project.__initTestingActions"></a>
 <h4>Project.__initTestingActions</h4>
 <b>__initTestingActions</b>(<i></i>)
 <p>
 Private method to define the testing actions.
 </p>
 <a NAME="Project.__initTestingMenu" ID="Project.__initTestingMenu"></a>
 <h4>Project.__initTestingMenu</h4>
 <b>__initTestingMenu</b>(<i></i>)
 <p>
 Private method to initialize the testing menu.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 the menu generated
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__initToolsActions" ID="Project.__initToolsActions"></a>
 <h4>Project.__initToolsActions</h4>
 <b>__initToolsActions</b>(<i></i>)
 <p>
 Private method to define the tool actions.
 </p>
 <a NAME="Project.__initToolsMenu" ID="Project.__initToolsMenu"></a>
 <h4>Project.__initToolsMenu</h4>
 <b>__initToolsMenu</b>(<i></i>)
 <p>
 Private method to initialize the tools menu.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 the menu generated
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__isSpawningConsole" ID="Project.__isSpawningConsole"></a>
 <h4>Project.__isSpawningConsole</h4>
 <b>__isSpawningConsole</b>(<i>consoleCmd</i>)
 <p>
 Private method to check, if the given console is a spawning console.
 </p>
 <dl>
 <dt><i>consoleCmd</i> (str)</dt>
 <dd>
 console command
 </dd>
 </dl>
 <a NAME="Project.__isSuitableForVariant" ID="Project.__isSuitableForVariant"></a>
 <h4>Project.__isSuitableForVariant</h4>
 <b>__isSuitableForVariant</b>(<i>variant, line0</i>)
 <p>
 Private method to test, if a detected command file is suitable for the
 given Python variant.
 </p>
 <dl>
 <dt><i>variant</i> (str)</dt>
 <dd>
 Python variant to test for
 </dd>
 </dl>
 <a NAME="Project.__loadData" ID="Project.__loadData"></a>
 <h4>Project.__loadData</h4>
 <b>__loadData</b>(<i></i>)
 <p>
 Private slot to load data from fixture files.
 </p>
 <a NAME="Project.__loadRecentApplications" ID="Project.__loadRecentApplications"></a>
 <h4>Project.__loadRecentApplications</h4>
 <b>__loadRecentApplications</b>(<i></i>)
 <p>
 Private method to load the recently used applications list.
 </p>
 <a NAME="Project.__loadRecentDatabaseNames" ID="Project.__loadRecentDatabaseNames"></a>
 <h4>Project.__loadRecentDatabaseNames</h4>
 <b>__loadRecentDatabaseNames</b>(<i></i>)
 <p>
 Private method to load the list of recently used database names.
 </p>
 <a NAME="Project.__loadRecentTestData" ID="Project.__loadRecentTestData"></a>
 <h4>Project.__loadRecentTestData</h4>
 <b>__loadRecentTestData</b>(<i></i>)
 <p>
 Private method to load the recently used test data lists.
 </p>
 <a NAME="Project.__makeMigrations" ID="Project.__makeMigrations"></a>
 <h4>Project.__makeMigrations</h4>
 <b>__makeMigrations</b>(<i></i>)
 <p>
 Private slot to generate migrations for the Django project.
 </p>
 <a NAME="Project.__normalizeList" ID="Project.__normalizeList"></a>
 <h4>Project.__normalizeList</h4>
 <b>__normalizeList</b>(<i>filenames</i>)
 <p>
 Private method to normalize a list of file names.
 </p>
 <dl>
 <dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of file names to normalize
 </dd>
 </dl>
 <a NAME="Project.__performCheck" ID="Project.__performCheck"></a>
 <h4>Project.__performCheck</h4>
 <b>__performCheck</b>(<i></i>)
 <p>
 Private slot to inspect the project for common problems.
 </p>
 <a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a>
 <h4>Project.__projectLanguageAdded</h4>
 <b>__projectLanguageAdded</b>(<i>code</i>)
 <p>
 Private slot handling the addition of a new language.
 </p>
 <dl>
 <dt><i>code</i> (str)</dt>
 <dd>
 language code of the new language
 </dd>
 </dl>
 <a NAME="Project.__runBrowser" ID="Project.__runBrowser"></a>
 <h4>Project.__runBrowser</h4>
 <b>__runBrowser</b>(<i></i>)
 <p>
 Private slot to start the default web browser with the server URL.
 </p>
 <a NAME="Project.__runDatabaseClient" ID="Project.__runDatabaseClient"></a>
 <h4>Project.__runDatabaseClient</h4>
 <b>__runDatabaseClient</b>(<i></i>)
 <p>
 Private slot to start a database client for a Django project.
 </p>
 <a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a>
 <h4>Project.__runPythonShell</h4>
 <b>__runPythonShell</b>(<i></i>)
 <p>
 Private slot to start a Python console for a Django project.
 </p>
 <a NAME="Project.__runServer" ID="Project.__runServer"></a>
 <h4>Project.__runServer</h4>
 <b>__runServer</b>(<i></i>)
 <p>
 Private slot to start the Django Web server.
 </p>
 <a NAME="Project.__runTestServer" ID="Project.__runTestServer"></a>
 <h4>Project.__runTestServer</h4>
 <b>__runTestServer</b>(<i></i>)
 <p>
 Private slot to run a development server with data from a set of
 fixtures.
 </p>
 <a NAME="Project.__runTestSuite" ID="Project.__runTestSuite"></a>
 <h4>Project.__runTestSuite</h4>
 <b>__runTestSuite</b>(<i>deprecation=False</i>)
 <p>
 Private slot to run the test suite for applications or the whole site.
 </p>
 <dl>
 <dt><i>deprecation</i> (bool)</dt>
 <dd>
 flag indicating to test for deprecation warnings
 </dd>
 </dl>
 <a NAME="Project.__saveRecentApplications" ID="Project.__saveRecentApplications"></a>
 <h4>Project.__saveRecentApplications</h4>
 <b>__saveRecentApplications</b>(<i></i>)
 <p>
 Private method to save the list of recently used applications list.
 </p>
 <a NAME="Project.__saveRecentDatabaseNames" ID="Project.__saveRecentDatabaseNames"></a>
 <h4>Project.__saveRecentDatabaseNames</h4>
 <b>__saveRecentDatabaseNames</b>(<i></i>)
 <p>
 Private method to save the list of recently used database names.
 </p>
 <a NAME="Project.__saveRecentTestData" ID="Project.__saveRecentTestData"></a>
 <h4>Project.__saveRecentTestData</h4>
 <b>__saveRecentTestData</b>(<i></i>)
 <p>
 Private method to save the list of recently used test data.
 </p>
 <a NAME="Project.__selectDatabaseName" ID="Project.__selectDatabaseName"></a>
 <h4>Project.__selectDatabaseName</h4>
 <b>__selectDatabaseName</b>(<i></i>)
 <p>
 Private method to select the name of the database to work with.
 </p>
 <a NAME="Project.__selectSite" ID="Project.__selectSite"></a>
 <h4>Project.__selectSite</h4>
 <b>__selectSite</b>(<i></i>)
 <p>
 Private method to select a site to work with.
 </p>
 <a NAME="Project.__sendTestEmail" ID="Project.__sendTestEmail"></a>
 <h4>Project.__sendTestEmail</h4>
 <b>__sendTestEmail</b>(<i></i>)
 <p>
 Private slot to send a test email through Django.
 </p>
 <a NAME="Project.__serverProcFinished" ID="Project.__serverProcFinished"></a>
 <h4>Project.__serverProcFinished</h4>
 <b>__serverProcFinished</b>(<i></i>)
 <p>
 Private slot connected to the finished signal.
 </p>
 <a NAME="Project.__setCurrentDatabase" ID="Project.__setCurrentDatabase"></a>
 <h4>Project.__setCurrentDatabase</h4>
 <b>__setCurrentDatabase</b>(<i>database</i>)
 <p>
 Private method to set the database name to be used.
 </p>
 <dl>
 <dt><i>database</i> (str)</dt>
 <dd>
 name of the database
 </dd>
 </dl>
 <a NAME="Project.__setCurrentSite" ID="Project.__setCurrentSite"></a>
 <h4>Project.__setCurrentSite</h4>
 <b>__setCurrentSite</b>(<i>site</i>)
 <p>
 Private slot to set the current site.
 </p>
 <dl>
 <dt><i>site</i> (str)</dt>
 <dd>
 name of the site
 </dd>
 </dl>
 <a NAME="Project.__showHelpIndex" ID="Project.__showHelpIndex"></a>
 <h4>Project.__showHelpIndex</h4>
 <b>__showHelpIndex</b>(<i></i>)
 <p>
 Private slot to show the help index page.
 </p>
 <a NAME="Project.__showMigrationsList" ID="Project.__showMigrationsList"></a>
 <h4>Project.__showMigrationsList</h4>
 <b>__showMigrationsList</b>(<i></i>)
 <p>
 Private slot to show the available migrations and their status.
 </p>
 <a NAME="Project.__showMigrationsPlan" ID="Project.__showMigrationsPlan"></a>
 <h4>Project.__showMigrationsPlan</h4>
 <b>__showMigrationsPlan</b>(<i></i>)
 <p>
 Private slot to show the migrations plan.
 </p>
 <a NAME="Project.__site" ID="Project.__site"></a>
 <h4>Project.__site</h4>
 <b>__site</b>(<i></i>)
 <p>
 Private method to get the name of the current site.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 name of the site
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__siteFilteredList" ID="Project.__siteFilteredList"></a>
 <h4>Project.__siteFilteredList</h4>
 <b>__siteFilteredList</b>(<i>filenames</i>)
 <p>
 Private method to filter a list of file names by site.
 </p>
 <dl>
 <dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of file names to be filtered
 </dd>
 </dl>
 <a NAME="Project.__sitePath" ID="Project.__sitePath"></a>
 <h4>Project.__sitePath</h4>
 <b>__sitePath</b>(<i></i>)
 <p>
 Private method to calculate the full path of the Django site.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 path of the site
 </dd>
 </dd>
 </dl>
 <a NAME="Project.__sqlCommand" ID="Project.__sqlCommand"></a>
 <h4>Project.__sqlCommand</h4>
 <b>__sqlCommand</b>(<i>title, command, requestApps=True</i>)
 <p>
 Private method to perform an SQL creation function.
 </p>
 <dl>
 <dt><i>title</i> (str)</dt>
 <dd>
 dialog title
 </dd>
 </dl>
 <a NAME="Project.__squashMigrations" ID="Project.__squashMigrations"></a>
 <h4>Project.__squashMigrations</h4>
 <b>__squashMigrations</b>(<i></i>)
 <p>
 Private slot to squash migrations.
 </p>
 <a NAME="Project.__startGlobalApplication" ID="Project.__startGlobalApplication"></a>
 <h4>Project.__startGlobalApplication</h4>
 <b>__startGlobalApplication</b>(<i></i>)
 <p>
 Private slot to start a new global Django application.
 </p>
 <a NAME="Project.__startLocalApplication" ID="Project.__startLocalApplication"></a>
 <h4>Project.__startLocalApplication</h4>
 <b>__startLocalApplication</b>(<i></i>)
 <p>
 Private slot to start a new local Django application.
 </p>
 <a NAME="Project.__startProject" ID="Project.__startProject"></a>
 <h4>Project.__startProject</h4>
 <b>__startProject</b>(<i></i>)
 <p>
 Private slot to start a new Django project.
 </p>
 <a NAME="Project.__testServerProcFinished" ID="Project.__testServerProcFinished"></a>
 <h4>Project.__testServerProcFinished</h4>
 <b>__testServerProcFinished</b>(<i></i>)
 <p>
 Private slot connected to the finished signal of the test server.
 </p>
 <a NAME="Project.__unapplyMigrations" ID="Project.__unapplyMigrations"></a>
 <h4>Project.__unapplyMigrations</h4>
 <b>__unapplyMigrations</b>(<i></i>)
 <p>
 Private slot to revert all migrations of an application.
 </p>
 <a NAME="Project.applyMigrations" ID="Project.applyMigrations"></a>
 <h4>Project.applyMigrations</h4>
 <b>applyMigrations</b>(<i>app=None, migration=None</i>)
 <p>
 Public slot to apply migrations.
 </p>
 <dl>
 <dt><i>app</i> (str)</dt>
 <dd>
 name of an application to apply migrations for
 </dd>
 </dl>
 <a NAME="Project.compileCatalogs" ID="Project.compileCatalogs"></a>
 <h4>Project.compileCatalogs</h4>
 <b>compileCatalogs</b>(<i>filenames</i>)
 <p>
 Public method to compile the message catalogs.
 </p>
 <dl>
 <dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of filenames (not used)
 </dd>
 </dl>
 <a NAME="Project.compileSelectedCatalogs" ID="Project.compileSelectedCatalogs"></a>
 <h4>Project.compileSelectedCatalogs</h4>
 <b>compileSelectedCatalogs</b>(<i>filenames</i>)
 <p>
 Public method to update the message catalogs.
 </p>
 <dl>
 <dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of filenames
 </dd>
 </dl>
 <a NAME="Project.currentDatabase" ID="Project.currentDatabase"></a>
 <h4>Project.currentDatabase</h4>
 <b>currentDatabase</b>(<i></i>)
 <p>
 Public method to get the database name to be used.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 database name
 </dd>
 </dd>
 </dl>
 <a NAME="Project.getDjangoVersion" ID="Project.getDjangoVersion"></a>
 <h4>Project.getDjangoVersion</h4>
 <b>getDjangoVersion</b>(<i></i>)
 <p>
 Public method to get the Django version as a tuple.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 Django version
 </dd>
 </dd>
 </dl>
 <a NAME="Project.getDjangoVersionString" ID="Project.getDjangoVersionString"></a>
 <h4>Project.getDjangoVersionString</h4>
 <b>getDjangoVersionString</b>(<i></i>)
 <p>
 Public method to get the Django version as a string.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 Django version
 </dd>
 </dd>
 </dl>
 <a NAME="Project.getMenu" ID="Project.getMenu"></a>
 <h4>Project.getMenu</h4>
 <b>getMenu</b>(<i>name</i>)
 <p>
 Public method to get a reference to the requested menu.
 </p>
 <dl>
 <dt><i>name</i> (str)</dt>
 <dd>
 name of the menu
 </dd>
 </dl>
 <a NAME="Project.getMenuNames" ID="Project.getMenuNames"></a>
 <h4>Project.getMenuNames</h4>
 <b>getMenuNames</b>(<i></i>)
 <p>
 Public method to get the names of all menus.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 menu names
 </dd>
 </dd>
 </dl>
 <a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a>
 <h4>Project.getProjectPath</h4>
 <b>getProjectPath</b>(<i></i>)
 <p>
 Public method to get the path of the eric7 project.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 path of the eric7 project
 </dd>
 </dd>
 </dl>
 <a NAME="Project.getRecentApplications" ID="Project.getRecentApplications"></a>
 <h4>Project.getRecentApplications</h4>
 <b>getRecentApplications</b>(<i></i>)
 <p>
 Public method to get the list of recent applications.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 list of recent applications entries
 </dd>
 </dd>
 </dl>
 <a NAME="Project.getRecentDatabaseNames" ID="Project.getRecentDatabaseNames"></a>
 <h4>Project.getRecentDatabaseNames</h4>
 <b>getRecentDatabaseNames</b>(<i></i>)
 <p>
 Public method to get the list of recently used database names.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 list of recently used database names
 </dd>
 </dd>
 </dl>
 <a NAME="Project.getRecentTestData" ID="Project.getRecentTestData"></a>
 <h4>Project.getRecentTestData</h4>
 <b>getRecentTestData</b>(<i>key</i>)
 <p>
 Public method to get the list of recent test data.
 </p>
 <dl>
 <dt><i>key</i> (str)</dt>
 <dd>
 key (name) of the test data to get
 </dd>
 </dl>
 <a NAME="Project.initActions" ID="Project.initActions"></a>
 <h4>Project.initActions</h4>
 <b>initActions</b>(<i></i>)
 <p>
 Public method to define the Django actions.
 </p>
 <a NAME="Project.initMenu" ID="Project.initMenu"></a>
 <h4>Project.initMenu</h4>
 <b>initMenu</b>(<i></i>)
 <p>
 Public method to initialize the Django menu.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 the menu generated
 </dd>
 </dd>
 </dl>
 <a NAME="Project.makeMigrations" ID="Project.makeMigrations"></a>
 <h4>Project.makeMigrations</h4>
 <b>makeMigrations</b>(<i>apps, migration=None, dryRun=False, empty=False, merge=False</i>)
 <p>
 Public method to generate migrations.
 </p>
 <dl>
 <dt><i>apps</i> (list of str)</dt>
 <dd>
 list of application names to generate migrations for
 </dd>
 </dl>
 <a NAME="Project.newForm" ID="Project.newForm"></a>
 <h4>Project.newForm</h4>
 <b>newForm</b>(<i>path</i>)
 <p>
 Public method to create a new form.
 </p>
 <dl>
 <dt><i>path</i> (str)</dt>
 <dd>
 full directory path for the new form file
 </dd>
 </dl>
 <a NAME="Project.newProjectCreated" ID="Project.newProjectCreated"></a>
 <h4>Project.newProjectCreated</h4>
 <b>newProjectCreated</b>(<i></i>)
 <p>
 Public slot to finish up the newly generated project.
 </p>
 <a NAME="Project.openPOEditor" ID="Project.openPOEditor"></a>
 <h4>Project.openPOEditor</h4>
 <b>openPOEditor</b>(<i>poFile</i>)
 <p>
 Public method to edit the given file in an external .po editor.
 </p>
 <dl>
 <dt><i>poFile</i> (str)</dt>
 <dd>
 name of the .po file
 </dd>
 </dl>
 <a NAME="Project.projectClosed" ID="Project.projectClosed"></a>
 <h4>Project.projectClosed</h4>
 <b>projectClosed</b>(<i></i>)
 <p>
 Public method to handle the closing of a project.
 </p>
 <a NAME="Project.projectClosedHooks" ID="Project.projectClosedHooks"></a>
 <h4>Project.projectClosedHooks</h4>
 <b>projectClosedHooks</b>(<i></i>)
 <p>
 Public method to remove our hook methods.
 </p>
 <a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a>
 <h4>Project.projectOpenedHooks</h4>
 <b>projectOpenedHooks</b>(<i></i>)
 <p>
 Public method to add our hook methods.
 </p>
 <a NAME="Project.registerOpenHook" ID="Project.registerOpenHook"></a>
 <h4>Project.registerOpenHook</h4>
 <b>registerOpenHook</b>(<i></i>)
 <p>
 Public method to register the open hook to open a translations file
 in a translations editor.
 </p>
 <a NAME="Project.setMostRecentApplication" ID="Project.setMostRecentApplication"></a>
 <h4>Project.setMostRecentApplication</h4>
 <b>setMostRecentApplication</b>(<i>applStr</i>)
 <p>
 Public method to set the most recently used applications entry.
 </p>
 <dl>
 <dt><i>applStr</i> (str)</dt>
 <dd>
 applications entry
 </dd>
 </dl>
 <a NAME="Project.setMostRecentDatabaseNames" ID="Project.setMostRecentDatabaseNames"></a>
 <h4>Project.setMostRecentDatabaseNames</h4>
 <b>setMostRecentDatabaseNames</b>(<i>dbName</i>)
 <p>
 Public method to set the most recently used database names.
 </p>
 <dl>
 <dt><i>dbName</i> (str)</dt>
 <dd>
 database name
 </dd>
 </dl>
 <a NAME="Project.setMostRecentTestData" ID="Project.setMostRecentTestData"></a>
 <h4>Project.setMostRecentTestData</h4>
 <b>setMostRecentTestData</b>(<i>key, data</i>)
 <p>
 Public method to set the most recently used test data entry.
 </p>
 <dl>
 <dt><i>key</i> (str)</dt>
 <dd>
 key (name) of the test data to set
 </dd>
 </dl>
 <a NAME="Project.startProjectOrApplication" ID="Project.startProjectOrApplication"></a>
 <h4>Project.startProjectOrApplication</h4>
 <b>startProjectOrApplication</b>(<i></i>)
 <p>
 Public slot to start a new Django project or application.
 </p>
 <a NAME="Project.supportedPythonVariants" ID="Project.supportedPythonVariants"></a>
 <h4>Project.supportedPythonVariants</h4>
 <b>supportedPythonVariants</b>(<i></i>)
 <p>
 Public method to get the supported Python variants.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 list of supported Python variants
 </dd>
 </dd>
 </dl>
 <a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a>
 <h4>Project.updateCatalogs</h4>
 <b>updateCatalogs</b>(<i>filenames</i>)
 <p>
 Public method to update the message catalogs.
 </p>
 <dl>
 <dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of filenames (not used)
 </dd>
 </dl>
 <a NAME="Project.updateCatalogsWithObsolete" ID="Project.updateCatalogsWithObsolete"></a>
 <h4>Project.updateCatalogsWithObsolete</h4>
 <b>updateCatalogsWithObsolete</b>(<i>filenames</i>)
 <p>
 Public method to update the message catalogs keeping obsolete messages.
 </p>
 <dl>
 <dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of filenames (not used)
 </dd>
 </dl>
 <a NAME="Project.updateSelectedCatalogs" ID="Project.updateSelectedCatalogs"></a>
 <h4>Project.updateSelectedCatalogs</h4>
 <b>updateSelectedCatalogs</b>(<i>filenames</i>)
 <p>
 Public method to update the message catalogs.
 </p>
 <dl>
 <dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of file names
 </dd>
 </dl>
 <a NAME="Project.updateSelectedCatalogsWithObsolete" ID="Project.updateSelectedCatalogsWithObsolete"></a>
 <h4>Project.updateSelectedCatalogsWithObsolete</h4>
 <b>updateSelectedCatalogsWithObsolete</b>(<i>filenames</i>)
 <p>
 Public method to update the message catalogs keeping obsolete messages.
 </p>
 <dl>
 <dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of filenames
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="QProcess" ID="QProcess"></a>
 <h2>QProcess</h2>
 <p>
 Class transforming the call arguments in case of gnome-terminal.
 </p>
 <h3>Derived from</h3>
 QProcessPyQt
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
 <tr>
 <td><a href="#QProcess.start">start</a></td>
 <td>Public method to start the given program (cmd) in a new process, if none is already running, passing the command line arguments in args.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr>
 <td><a href="#QProcess.startDetached">startDetached</a></td>
 <td>Public static method to start the given program (cmd) in a new process, if none is already running, passing the command line arguments in args.</td>
 </tr>
 </table>
 <a NAME="QProcess.start" ID="QProcess.start"></a>
 <h4>QProcess.start</h4>
 <b>start</b>(<i>cmd, args=None, mode=QIODeviceBase.OpenModeFlag.ReadWrite</i>)
 <p>
 Public method to start the given program (cmd) in a new process, if
 none is already running, passing the command line arguments in args.
 </p>
 <dl>
 <dt><i>cmd</i> (str)</dt>
 <dd>
 start the given program cmd
 </dd>
 </dl>
 <a NAME="QProcess.startDetached" ID="QProcess.startDetached"></a>
 <h4>QProcess.startDetached (static)</h4>
 <b>startDetached</b>(<i>args=None, path=""</i>)
 <p>
 Public static method to start the given program (cmd) in a new process,
 if none is already running, passing the command line arguments in args.
 </p>
 <dl>
 <dt><i>cmd</i> (str)</dt>
 <dd>
 start the given program cmd

Mercurial Repositories > Django Project / file comparison

comparison: ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.Project.html

ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.Project.html