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

branch
eric7
changeset 172
ea7980ded4f3
parent 169
b8f263e05c39
child 176
1395e0583f4e
--- a/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.Project.html	Sat May 29 15:03:26 2021 +0200
+++ b/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.Project.html	Sat May 29 18:33:03 2021 +0200
@@ -422,7 +422,7 @@
 </tr>
 <tr>
 <td><a href="#Project.__unapplyMigrations">__unapplyMigrations</a></td>
-<td>Private slot to un-apply all migrations of an application.</td>
+<td>Private slot to revert all migrations of an application.</td>
 </tr>
 <tr>
 <td><a href="#Project.applyMigrations">applyMigrations</a></td>
@@ -458,7 +458,7 @@
 </tr>
 <tr>
 <td><a href="#Project.getProjectPath">getProjectPath</a></td>
-<td>Public method to get the path of the eric6 project.</td>
+<td>Public method to get the path of the eric7 project.</td>
 </tr>
 <tr>
 <td><a href="#Project.getRecentApplications">getRecentApplications</a></td>
@@ -632,25 +632,29 @@
 </p>
 <dl>
 
-<dt><i>applName</i></dt>
+<dt><i>applName</i> (str)</dt>
 <dd>
-name of the new application (string)
+name of the new application
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
 the directory where the application should be created
-            (string)
 </dd>
-<dt><i>isGlobal</i></dt>
+<dt><i>isGlobal</i> (bool)</dt>
 <dd>
 flag indicating a standalone Django application
-            (boolean)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a successful creation (boolean)
+flag indicating a successful creation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Project.__createCacheTables" ID="Project.__createCacheTables"></a>
@@ -669,20 +673,25 @@
 </p>
 <dl>
 
-<dt><i>projectName</i></dt>
+<dt><i>projectName</i> (str)</dt>
 <dd>
-name of the new project (string)
+name of the new project
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
 the directory where the project should be created
-            (string)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a successful creation (boolean)
+flag indicating a successful creation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Project.__createSuperUser" ID="Project.__createSuperUser"></a>
@@ -728,7 +737,7 @@
 
 <dt><i>backwards</i> (bool)</dt>
 <dd>
-flag indicating to generate the SQL code to unapply
+flag indicating to generate the SQL code to revert
             a migration
 </dd>
 </dl>
@@ -771,7 +780,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of sites (list of strings)
+list of sites
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Project.__getApplications" ID="Project.__getApplications"></a>
@@ -784,7 +799,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of application names (list of strings)
+list of application names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Project.__getDebugEnvironment" ID="Project.__getDebugEnvironment"></a>
@@ -796,16 +817,22 @@
 </p>
 <dl>
 
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
 Python variant to get the debugger environment
-            for (string, one of '' or 'Python3')
+            for (one of '' or 'Python3')
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-path of the debugger environment (string)
+path of the debugger environment
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Project.__getDjangoAdminCommand" ID="Project.__getDjangoAdminCommand"></a>
@@ -817,16 +844,22 @@
 </p>
 <dl>
 
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
 Python variant to get the django-admin.py
-            command for (string, one of '' or 'Python3')
+            command for (one of '' or 'Python3')
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-full django-admin.py command (string)
+full django-admin.py command
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Project.__getExecutablePaths" ID="Project.__getExecutablePaths"></a>
@@ -839,9 +872,9 @@
 </p>
 <dl>
 
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
 <dd>
-filename of the executable (string)
+filename of the executable
 </dd>
 </dl>
 <dl>
@@ -852,6 +885,12 @@
             variable, or an empty list otherwise.
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
 <a NAME="Project.__getLocale" ID="Project.__getLocale"></a>
 <h4>Project.__getLocale</h4>
 <b>__getLocale</b>(<i>filename</i>)
@@ -861,15 +900,21 @@
 </p>
 <dl>
 
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-name of the file used for extraction (string)
+name of the file used for extraction
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-extracted locale (string) or None
+extracted locale or None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Project.__getMigrations" ID="Project.__getMigrations"></a>
@@ -902,7 +947,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-python command (string)
+python command
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a>
@@ -914,16 +965,22 @@
 </p>
 <dl>
 
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
 Python variant to get the virtual environment
-            for (string, one of '' or 'Python3')
+            for (one of '' or 'Python3')
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-path of the virtual environment (string)
+path of the virtual environment
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Project.__initAuthorizationActions" ID="Project.__initAuthorizationActions"></a>
@@ -1117,17 +1174,22 @@
 </p>
 <dl>
 
-<dt><i>consoleCmd</i></dt>
+<dt><i>consoleCmd</i> (str)</dt>
 <dd>
-console command (string)
+console command
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 tuple of two entries giving an indication, if the console
-            is spawning (boolean) and the (possibly) cleaned console command
-            (string)
+            is spawning and the (possibly) cleaned console command
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="Project.__isSuitableForVariant" ID="Project.__isSuitableForVariant"></a>
@@ -1205,15 +1267,21 @@
 </p>
 <dl>
 
-<dt><i>filenames</i></dt>
+<dt><i>filenames</i> (list of str)</dt>
 <dd>
-list of file names to normalize (list of strings)
+list of file names to normalize
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-normalized file names (list of strings)
+normalized file names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Project.__performCheck" ID="Project.__performCheck"></a>
@@ -1232,9 +1300,9 @@
 </p>
 <dl>
 
-<dt><i>code</i></dt>
+<dt><i>code</i> (str)</dt>
 <dd>
-language code of the new language (string)
+language code of the new language
 </dd>
 </dl>
 <a NAME="Project.__runBrowser" ID="Project.__runBrowser"></a>
@@ -1359,9 +1427,9 @@
 </p>
 <dl>
 
-<dt><i>site</i></dt>
+<dt><i>site</i> (str)</dt>
 <dd>
-name of the site (string)
+name of the site
 </dd>
 </dl>
 <a NAME="Project.__showHelpIndex" ID="Project.__showHelpIndex"></a>
@@ -1395,7 +1463,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-name of the site (string)
+name of the site
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <dl>
@@ -1414,15 +1488,21 @@
 </p>
 <dl>
 
-<dt><i>filenames</i></dt>
+<dt><i>filenames</i> (list of str)</dt>
 <dd>
-list of file names to be filtered (list of strings)
+list of file names to be filtered
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-file names belonging to the current site (list of strings)
+file names belonging to the current site
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Project.__sitePath" ID="Project.__sitePath"></a>
@@ -1435,7 +1515,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-path of the site (string)
+path of the site
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <dl>
@@ -1454,18 +1540,18 @@
 </p>
 <dl>
 
-<dt><i>title</i></dt>
+<dt><i>title</i> (str)</dt>
 <dd>
-dialog title (string)
+dialog title
 </dd>
-<dt><i>command</i></dt>
+<dt><i>command</i> (str)</dt>
 <dd>
-Django sql... command (string)
+Django sql... command
 </dd>
-<dt><i>requestApps</i></dt>
+<dt><i>requestApps</i> (bool)</dt>
 <dd>
 flag indicating to request a list of applications
-            to work on (boolean)
+            to work on
 </dd>
 </dl>
 <a NAME="Project.__squashMigrations" ID="Project.__squashMigrations"></a>
@@ -1508,7 +1594,7 @@
 <b>__unapplyMigrations</b>(<i></i>)
 
 <p>
-        Private slot to un-apply all migrations of an application.
+        Private slot to revert all migrations of an application.
 </p>
 <a NAME="Project.applyMigrations" ID="Project.applyMigrations"></a>
 <h4>Project.applyMigrations</h4>
@@ -1537,7 +1623,7 @@
 </p>
 <dl>
 
-<dt><i>filenames</i></dt>
+<dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of filenames (not used)
 </dd>
@@ -1551,7 +1637,7 @@
 </p>
 <dl>
 
-<dt><i>filenames</i></dt>
+<dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of filenames
 </dd>
@@ -1604,7 +1690,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-Django version (string)
+Django version
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Project.getMenu" ID="Project.getMenu"></a>
@@ -1616,16 +1708,22 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the menu (string)
+name of the menu
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the menu (QMenu) or None, if no
-            menu with the given name exists
+reference to the menu or None, if no menu with the given
+            name exists
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QMenu
 </dd>
 </dl>
 <a NAME="Project.getMenuNames" ID="Project.getMenuNames"></a>
@@ -1638,7 +1736,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-menu names (list of string)
+menu names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a>
@@ -1646,12 +1750,18 @@
 <b>getProjectPath</b>(<i></i>)
 
 <p>
-        Public method to get the path of the eric6 project.
+        Public method to get the path of the eric7 project.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
-path of the eric6 project (string)
+path of the eric7 project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Project.getRecentApplications" ID="Project.getRecentApplications"></a>
@@ -1777,9 +1887,9 @@
 </p>
 <dl>
 
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-full directory path for the new form file (string)
+full directory path for the new form file
 </dd>
 </dl>
 <a NAME="Project.newProjectCreated" ID="Project.newProjectCreated"></a>
@@ -1798,9 +1908,9 @@
 </p>
 <dl>
 
-<dt><i>poFile</i></dt>
+<dt><i>poFile</i> (str)</dt>
 <dd>
-name of the .po file (string)
+name of the .po file
 </dd>
 </dl>
 <a NAME="Project.projectClosed" ID="Project.projectClosed"></a>
@@ -1841,9 +1951,9 @@
 </p>
 <dl>
 
-<dt><i>applStr</i></dt>
+<dt><i>applStr</i> (str)</dt>
 <dd>
-applications entry (string)
+applications entry
 </dd>
 </dl>
 <a NAME="Project.setMostRecentDatabaseNames" ID="Project.setMostRecentDatabaseNames"></a>
@@ -1895,7 +2005,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of supported Python variants (list of strings)
+list of supported Python variants
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a>
@@ -1907,7 +2023,7 @@
 </p>
 <dl>
 
-<dt><i>filenames</i></dt>
+<dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of filenames (not used)
 </dd>
@@ -1921,7 +2037,7 @@
 </p>
 <dl>
 
-<dt><i>filenames</i></dt>
+<dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of filenames (not used)
 </dd>
@@ -1935,9 +2051,9 @@
 </p>
 <dl>
 
-<dt><i>filenames</i></dt>
+<dt><i>filenames</i> (list of str)</dt>
 <dd>
-list of file names (list of strings)
+list of file names
 </dd>
 </dl>
 <a NAME="Project.updateSelectedCatalogsWithObsolete" ID="Project.updateSelectedCatalogsWithObsolete"></a>
@@ -1949,7 +2065,7 @@
 </p>
 <dl>
 
-<dt><i>filenames</i></dt>
+<dt><i>filenames</i> (list of str)</dt>
 <dd>
 list of filenames
 </dd>
@@ -1996,7 +2112,7 @@
 
 <a NAME="QProcess.start" ID="QProcess.start"></a>
 <h4>QProcess.start</h4>
-<b>start</b>(<i>cmd, args=None, mode=QProcessPyQt.ReadWrite</i>)
+<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
@@ -2004,17 +2120,17 @@
 </p>
 <dl>
 
-<dt><i>cmd</i></dt>
+<dt><i>cmd</i> (str)</dt>
 <dd>
-start the given program cmd (string)
+start the given program cmd
 </dd>
-<dt><i>args=</i></dt>
+<dt><i>args</i> (list of str)</dt>
 <dd>
-list of parameters (list of strings)
+list of parameters
 </dd>
-<dt><i>mode=</i></dt>
+<dt><i>mode</i> (QIODeviceBase.OpenMode)</dt>
 <dd>
-access mode (QIODevice.OpenMode)
+access mode
 </dd>
 </dl>
 <a NAME="QProcess.startDetached" ID="QProcess.startDetached"></a>
@@ -2027,23 +2143,29 @@
 </p>
 <dl>
 
-<dt><i>cmd</i></dt>
+<dt><i>cmd</i> (str)</dt>
 <dd>
-start the given program cmd (string)
+start the given program cmd
 </dd>
-<dt><i>args=</i></dt>
+<dt><i>args</i> (list of str)</dt>
 <dd>
-list of parameters (list of strings)
+list of parameters
 </dd>
-<dt><i>path=</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-new working directory (string)
+new working directory
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of successful start and process id (boolean, integer)
+tuple of successful start and process id
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, int)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial