Sun, 29 Nov 2020 16:05:10 +0100
Updated source docu.
--- a/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelConfigDialog.html Sun Nov 29 16:04:25 2020 +0100 +++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelConfigDialog.html Sun Nov 29 16:05:10 2020 +0100 @@ -23,7 +23,7 @@ <h1>Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelConfigDialog</h1> <p> -Module implementing a dialog to edit the PyBabel configuration. +Module implementing a dialog to edit the flask-babel configuration. </p> <h3>Global Attributes</h3> @@ -36,7 +36,7 @@ <tr> <td><a href="#PyBabelConfigDialog">PyBabelConfigDialog</a></td> -<td>Class implementing a dialog to edit the PyBabel configuration.</td> +<td>Class implementing a dialog to edit the flask-babel configuration.</td> </tr> </table> <h3>Functions</h3> @@ -50,7 +50,7 @@ <h2>PyBabelConfigDialog</h2> <p> - Class implementing a dialog to edit the PyBabel configuration. + Class implementing a dialog to edit the flask-babel configuration. </p> <h3>Derived from</h3> QDialog, Ui_PyBabelConfigDialog
--- a/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension.html Sun Nov 29 16:04:25 2020 +0100 +++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension.html Sun Nov 29 16:05:10 2020 +0100 @@ -36,7 +36,7 @@ <tr> <td><a href="#PyBabelProject">PyBabelProject</a></td> -<td>Class implementing the Flask project support.</td> +<td>Class implementing the flask-babel project support.</td> </tr> </table> <h3>Functions</h3> @@ -50,7 +50,7 @@ <h2>PyBabelProject</h2> <p> - Class implementing the Flask project support. + Class implementing the flask-babel project support. </p> <h3>Derived from</h3> QObject @@ -73,6 +73,14 @@ <td>Constructor</td> </tr> <tr> +<td><a href="#PyBabelProject.__checkAvailability">__checkAvailability</a></td> +<td>Private slot to check the availability of the 'flask-babel' extension.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.__configurePyBabel">__configurePyBabel</a></td> +<td>Private slot to show a dialog to edit the pybabel configuration.</td> +</tr> +<tr> <td><a href="#PyBabelProject.__createBabelCfg">__createBabelCfg</a></td> <td>Private method to create a template pybabel configuration file.</td> </tr> @@ -81,10 +89,18 @@ <td>Private method to ensure, that PyBabel has been configured.</td> </tr> <tr> +<td><a href="#PyBabelProject.__flaskBabelAvailable">__flaskBabelAvailable</a></td> +<td>Private method to check, if the 'flask-babel' package is available.</td> +</tr> +<tr> <td><a href="#PyBabelProject.__getLocale">__getLocale</a></td> <td>Private method to extract the locale out of a file name.</td> </tr> <tr> +<td><a href="#PyBabelProject.__installFlaskBabel">__installFlaskBabel</a></td> +<td>Private slot to install the flask-babel extension into the configured environment.</td> +</tr> +<tr> <td><a href="#PyBabelProject.__projectLanguageAdded">__projectLanguageAdded</a></td> <td>Private slot handling the addition of a new language.</td> </tr> @@ -97,10 +113,6 @@ <td>Public method to update the message catalogs.</td> </tr> <tr> -<td><a href="#PyBabelProject.configurePyBabel">configurePyBabel</a></td> -<td>Public slot to show a dialog to edit the pybabel configuration.</td> -</tr> -<tr> <td><a href="#PyBabelProject.determineCapability">determineCapability</a></td> <td>Public method to determine the availability of flask-babel.</td> </tr> @@ -109,12 +121,16 @@ <td>Public method to extract the messages catalog template file.</td> </tr> <tr> -<td><a href="#PyBabelProject.flaskBabelAvailable">flaskBabelAvailable</a></td> -<td>Public method to check, if the 'flask-babel' package is available.</td> +<td><a href="#PyBabelProject.getBabelCommand">getBabelCommand</a></td> +<td>Public method to build the Babel command.</td> </tr> <tr> -<td><a href="#PyBabelProject.getBabelCommand">getBabelCommand</a></td> -<td>Public method to build the Babel command.</td> +<td><a href="#PyBabelProject.initActions">initActions</a></td> +<td>Public method to define the flask-babel actions.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.initMenu">initMenu</a></td> +<td>Public method to initialize the flask-babel menu.</td> </tr> <tr> <td><a href="#PyBabelProject.openPOEditor">openPOEditor</a></td> @@ -177,6 +193,20 @@ parent </dd> </dl> +<a NAME="PyBabelProject.__checkAvailability" ID="PyBabelProject.__checkAvailability"></a> +<h4>PyBabelProject.__checkAvailability</h4> +<b>__checkAvailability</b>(<i></i>) + +<p> + Private slot to check the availability of the 'flask-babel' extension. +</p> +<a NAME="PyBabelProject.__configurePyBabel" ID="PyBabelProject.__configurePyBabel"></a> +<h4>PyBabelProject.__configurePyBabel</h4> +<b>__configurePyBabel</b>(<i></i>) + +<p> + Private slot to show a dialog to edit the pybabel configuration. +</p> <a NAME="PyBabelProject.__createBabelCfg" ID="PyBabelProject.__createBabelCfg"></a> <h4>PyBabelProject.__createBabelCfg</h4> <b>__createBabelCfg</b>(<i>configFile</i>) @@ -222,6 +252,25 @@ bool </dd> </dl> +<a NAME="PyBabelProject.__flaskBabelAvailable" ID="PyBabelProject.__flaskBabelAvailable"></a> +<h4>PyBabelProject.__flaskBabelAvailable</h4> +<b>__flaskBabelAvailable</b>(<i></i>) + +<p> + Private method to check, if the 'flask-babel' package is available. +</p> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating the availability of 'flask-babel' +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="PyBabelProject.__getLocale" ID="PyBabelProject.__getLocale"></a> <h4>PyBabelProject.__getLocale</h4> <b>__getLocale</b>(<i>filename</i>) @@ -248,6 +297,14 @@ str or None </dd> </dl> +<a NAME="PyBabelProject.__installFlaskBabel" ID="PyBabelProject.__installFlaskBabel"></a> +<h4>PyBabelProject.__installFlaskBabel</h4> +<b>__installFlaskBabel</b>(<i></i>) + +<p> + Private slot to install the flask-babel extension into the configured + environment. +</p> <a NAME="PyBabelProject.__projectLanguageAdded" ID="PyBabelProject.__projectLanguageAdded"></a> <h4>PyBabelProject.__projectLanguageAdded</h4> <b>__projectLanguageAdded</b>(<i>code</i>) @@ -290,13 +347,6 @@ list of file names </dd> </dl> -<a NAME="PyBabelProject.configurePyBabel" ID="PyBabelProject.configurePyBabel"></a> -<h4>PyBabelProject.configurePyBabel</h4> -<b>configurePyBabel</b>(<i></i>) - -<p> - Public slot to show a dialog to edit the pybabel configuration. -</p> <a NAME="PyBabelProject.determineCapability" ID="PyBabelProject.determineCapability"></a> <h4>PyBabelProject.determineCapability</h4> <b>determineCapability</b>(<i></i>) @@ -311,25 +361,6 @@ <p> Public method to extract the messages catalog template file. </p> -<a NAME="PyBabelProject.flaskBabelAvailable" ID="PyBabelProject.flaskBabelAvailable"></a> -<h4>PyBabelProject.flaskBabelAvailable</h4> -<b>flaskBabelAvailable</b>(<i></i>) - -<p> - Public method to check, if the 'flask-babel' package is available. -</p> -<dl> -<dt>Returns:</dt> -<dd> -flag indicating the availability of 'flask-babel' -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> <a NAME="PyBabelProject.getBabelCommand" ID="PyBabelProject.getBabelCommand"></a> <h4>PyBabelProject.getBabelCommand</h4> <b>getBabelCommand</b>(<i></i>) @@ -349,6 +380,32 @@ str </dd> </dl> +<a NAME="PyBabelProject.initActions" ID="PyBabelProject.initActions"></a> +<h4>PyBabelProject.initActions</h4> +<b>initActions</b>(<i></i>) + +<p> + Public method to define the flask-babel actions. +</p> +<a NAME="PyBabelProject.initMenu" ID="PyBabelProject.initMenu"></a> +<h4>PyBabelProject.initMenu</h4> +<b>initMenu</b>(<i></i>) + +<p> + Public method to initialize the flask-babel menu. +</p> +<dl> +<dt>Returns:</dt> +<dd> +the menu generated +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu +</dd> +</dl> <a NAME="PyBabelProject.openPOEditor" ID="PyBabelProject.openPOEditor"></a> <h4>PyBabelProject.openPOEditor</h4> <b>openPOEditor</b>(<i>poFile</i>)
--- a/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskCommandDialog.html Sun Nov 29 16:04:25 2020 +0100 +++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskCommandDialog.html Sun Nov 29 16:05:10 2020 +0100 @@ -89,6 +89,10 @@ <td>Protected method handling the close event of the dialog.</td> </tr> <tr> +<td><a href="#FlaskCommandDialog.normalExit">normalExit</a></td> +<td>Public method to test, if the process ended without errors.</td> +</tr> +<tr> <td><a href="#FlaskCommandDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot handling presses of the button box buttons.</td> </tr> @@ -179,6 +183,25 @@ reference to the close event object </dd> </dl> +<a NAME="FlaskCommandDialog.normalExit" ID="FlaskCommandDialog.normalExit"></a> +<h4>FlaskCommandDialog.normalExit</h4> +<b>normalExit</b>(<i></i>) + +<p> + Public method to test, if the process ended without errors. +</p> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating a normal process exit +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="FlaskCommandDialog.on_buttonBox_clicked" ID="FlaskCommandDialog.on_buttonBox_clicked"></a> <h4>FlaskCommandDialog.on_buttonBox_clicked</h4> <b>on_buttonBox_clicked</b>(<i>button</i>)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.FlaskMigrateDetector.html Sun Nov 29 16:05:10 2020 +0100 @@ -0,0 +1,44 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.FlaskMigrateDetector</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.FlaskMigrateDetector</h1> + +<p> +Module to check for the presence of 'flask-migrate' by importing it. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateConfigDialog.html Sun Nov 29 16:05:10 2020 +0100 @@ -0,0 +1,125 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateConfigDialog</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateConfigDialog</h1> + +<p> +Module implementing a dialog to edit the flask-migrate configuration. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#MigrateConfigDialog">MigrateConfigDialog</a></td> +<td>Class implementing a dialog to edit the flask-migrate configuration.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="MigrateConfigDialog" ID="MigrateConfigDialog"></a> +<h2>MigrateConfigDialog</h2> + +<p> + Class implementing a dialog to edit the flask-migrate configuration. +</p> +<h3>Derived from</h3> +QDialog, Ui_MigrateConfigDialog +<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="#MigrateConfigDialog.__init__">MigrateConfigDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#MigrateConfigDialog.getConfiguration">getConfiguration</a></td> +<td>Public method to get the entered configuration data.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="MigrateConfigDialog.__init__" ID="MigrateConfigDialog.__init__"></a> +<h4>MigrateConfigDialog (Constructor)</h4> +<b>MigrateConfigDialog</b>(<i>configuration, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>configuration</i> (dict)</dt> +<dd> +current pybabel configuration +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="MigrateConfigDialog.getConfiguration" ID="MigrateConfigDialog.getConfiguration"></a> +<h4>MigrateConfigDialog.getConfiguration</h4> +<b>getConfiguration</b>(<i></i>) + +<p> + Public method to get the entered configuration data. +</p> +<dl> +<dt>Returns:</dt> +<dd> +pybabel configuration +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateProjectExtension.html Sun Nov 29 16:05:10 2020 +0100 @@ -0,0 +1,341 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateProjectExtension</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateProjectExtension</h1> + +<p> +Module implementing the project support for flask-migrate. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#MigrateProject">MigrateProject</a></td> +<td>Class implementing the flask-migrate project support.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="MigrateProject" ID="MigrateProject"></a> +<h2>MigrateProject</h2> + +<p> + Class implementing the flask-migrate project support. +</p> +<h3>Derived from</h3> +QObject +<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="#MigrateProject.__init__">MigrateProject</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#MigrateProject.__checkAvailability">__checkAvailability</a></td> +<td>Private slot to check the availability of the 'flask-babel' extension.</td> +</tr> +<tr> +<td><a href="#MigrateProject.__configureMigrate">__configureMigrate</a></td> +<td>Private slot to show a dialog to edit the migrate configuration.</td> +</tr> +<tr> +<td><a href="#MigrateProject.__createMigration">__createMigration</a></td> +<td>Private slot to create a new database migration.</td> +</tr> +<tr> +<td><a href="#MigrateProject.__ensureMigrateConfigured">__ensureMigrateConfigured</a></td> +<td>Private method to ensure, that flask-migrate has been configured.</td> +</tr> +<tr> +<td><a href="#MigrateProject.__flaskMigrateAvailable">__flaskMigrateAvailable</a></td> +<td>Private method to check, if the 'flask-babel' package is available.</td> +</tr> +<tr> +<td><a href="#MigrateProject.__initMigrations">__initMigrations</a></td> +<td>Private slot to initialize the database migration system.</td> +</tr> +<tr> +<td><a href="#MigrateProject.__installFlaskMigrate">__installFlaskMigrate</a></td> +<td>Private slot to install the flask-migrate extension into the configured environment.</td> +</tr> +<tr> +<td><a href="#MigrateProject.__migrationsDirectory">__migrationsDirectory</a></td> +<td>Private method to calculate the path of the configured migrations directory.</td> +</tr> +<tr> +<td><a href="#MigrateProject.__showMigrationsHistory">__showMigrationsHistory</a></td> +<td>Private slot to show the full migrations history.</td> +</tr> +<tr> +<td><a href="#MigrateProject.__showMigrationsSummary">__showMigrationsSummary</a></td> +<td>Private slot to show a migrations history summary.</td> +</tr> +<tr> +<td><a href="#MigrateProject.determineCapability">determineCapability</a></td> +<td>Public method to determine the availability of flask-migrate.</td> +</tr> +<tr> +<td><a href="#MigrateProject.downgradeDatabase">downgradeDatabase</a></td> +<td>Public slot to downgrade the database to the previous version.</td> +</tr> +<tr> +<td><a href="#MigrateProject.initActions">initActions</a></td> +<td>Public method to define the flask-migrate actions.</td> +</tr> +<tr> +<td><a href="#MigrateProject.initMenu">initMenu</a></td> +<td>Public method to initialize the flask-migrate menu.</td> +</tr> +<tr> +<td><a href="#MigrateProject.projectClosed">projectClosed</a></td> +<td>Public method to handle the closing of a project.</td> +</tr> +<tr> +<td><a href="#MigrateProject.upgradeDatabase">upgradeDatabase</a></td> +<td>Public slot to upgrade the database to the current migration.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="MigrateProject.__init__" ID="MigrateProject.__init__"></a> +<h4>MigrateProject (Constructor)</h4> +<b>MigrateProject</b>(<i>plugin, project, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>plugin</i> (ProjectFlaskPlugin)</dt> +<dd> +reference to the plugin object +</dd> +<dt><i>project</i> (Project)</dt> +<dd> +reference to the project object +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent +</dd> +</dl> +<a NAME="MigrateProject.__checkAvailability" ID="MigrateProject.__checkAvailability"></a> +<h4>MigrateProject.__checkAvailability</h4> +<b>__checkAvailability</b>(<i></i>) + +<p> + Private slot to check the availability of the 'flask-babel' extension. +</p> +<a NAME="MigrateProject.__configureMigrate" ID="MigrateProject.__configureMigrate"></a> +<h4>MigrateProject.__configureMigrate</h4> +<b>__configureMigrate</b>(<i></i>) + +<p> + Private slot to show a dialog to edit the migrate configuration. +</p> +<a NAME="MigrateProject.__createMigration" ID="MigrateProject.__createMigration"></a> +<h4>MigrateProject.__createMigration</h4> +<b>__createMigration</b>(<i></i>) + +<p> + Private slot to create a new database migration. +</p> +<a NAME="MigrateProject.__ensureMigrateConfigured" ID="MigrateProject.__ensureMigrateConfigured"></a> +<h4>MigrateProject.__ensureMigrateConfigured</h4> +<b>__ensureMigrateConfigured</b>(<i></i>) + +<p> + Private method to ensure, that flask-migrate has been configured. +</p> +<a NAME="MigrateProject.__flaskMigrateAvailable" ID="MigrateProject.__flaskMigrateAvailable"></a> +<h4>MigrateProject.__flaskMigrateAvailable</h4> +<b>__flaskMigrateAvailable</b>(<i></i>) + +<p> + Private method to check, if the 'flask-babel' package is available. +</p> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating the availability of 'flask-babel' +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="MigrateProject.__initMigrations" ID="MigrateProject.__initMigrations"></a> +<h4>MigrateProject.__initMigrations</h4> +<b>__initMigrations</b>(<i></i>) + +<p> + Private slot to initialize the database migration system. +</p> +<a NAME="MigrateProject.__installFlaskMigrate" ID="MigrateProject.__installFlaskMigrate"></a> +<h4>MigrateProject.__installFlaskMigrate</h4> +<b>__installFlaskMigrate</b>(<i></i>) + +<p> + Private slot to install the flask-migrate extension into the configured + environment. +</p> +<a NAME="MigrateProject.__migrationsDirectory" ID="MigrateProject.__migrationsDirectory"></a> +<h4>MigrateProject.__migrationsDirectory</h4> +<b>__migrationsDirectory</b>(<i>abspath=False</i>) + +<p> + Private method to calculate the path of the configured migrations + directory. +</p> +<dl> + +<dt><i>abspath</i> (bool)</dt> +<dd> +flag indicating to return an absolute path +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +path of the migrations directory +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="MigrateProject.__showMigrationsHistory" ID="MigrateProject.__showMigrationsHistory"></a> +<h4>MigrateProject.__showMigrationsHistory</h4> +<b>__showMigrationsHistory</b>(<i></i>) + +<p> + Private slot to show the full migrations history. +</p> +<a NAME="MigrateProject.__showMigrationsSummary" ID="MigrateProject.__showMigrationsSummary"></a> +<h4>MigrateProject.__showMigrationsSummary</h4> +<b>__showMigrationsSummary</b>(<i></i>) + +<p> + Private slot to show a migrations history summary. +</p> +<a NAME="MigrateProject.determineCapability" ID="MigrateProject.determineCapability"></a> +<h4>MigrateProject.determineCapability</h4> +<b>determineCapability</b>(<i></i>) + +<p> + Public method to determine the availability of flask-migrate. +</p> +<a NAME="MigrateProject.downgradeDatabase" ID="MigrateProject.downgradeDatabase"></a> +<h4>MigrateProject.downgradeDatabase</h4> +<b>downgradeDatabase</b>(<i>revision=None</i>) + +<p> + Public slot to downgrade the database to the previous version. +</p> +<dl> + +<dt><i>revision</i> (str)</dt> +<dd> +migration revision to downgrade to +</dd> +</dl> +<a NAME="MigrateProject.initActions" ID="MigrateProject.initActions"></a> +<h4>MigrateProject.initActions</h4> +<b>initActions</b>(<i></i>) + +<p> + Public method to define the flask-migrate actions. +</p> +<a NAME="MigrateProject.initMenu" ID="MigrateProject.initMenu"></a> +<h4>MigrateProject.initMenu</h4> +<b>initMenu</b>(<i></i>) + +<p> + Public method to initialize the flask-migrate menu. +</p> +<dl> +<dt>Returns:</dt> +<dd> +the menu generated +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu +</dd> +</dl> +<a NAME="MigrateProject.projectClosed" ID="MigrateProject.projectClosed"></a> +<h4>MigrateProject.projectClosed</h4> +<b>projectClosed</b>(<i></i>) + +<p> + Public method to handle the closing of a project. +</p> +<a NAME="MigrateProject.upgradeDatabase" ID="MigrateProject.upgradeDatabase"></a> +<h4>MigrateProject.upgradeDatabase</h4> +<b>upgradeDatabase</b>(<i>revision=None</i>) + +<p> + Public slot to upgrade the database to the current migration. +</p> +<dl> + +<dt><i>revision</i> (str)</dt> +<dd> +migration revision to upgrade to +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateSummaryDialog.html Sun Nov 29 16:05:10 2020 +0100 @@ -0,0 +1,202 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateSummaryDialog</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateSummaryDialog</h1> + +<p> +Module implementing a dialog showing a summary of all created.migrations. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#MigrateSummaryDialog">MigrateSummaryDialog</a></td> +<td>Class implementing a dialog showing a summary of all created.migrations.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="MigrateSummaryDialog" ID="MigrateSummaryDialog"></a> +<h2>MigrateSummaryDialog</h2> + +<p> + Class implementing a dialog showing a summary of all created.migrations. +</p> +<h3>Derived from</h3> +QDialog, Ui_MigrateSummaryDialog +<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="#MigrateSummaryDialog.__init__">MigrateSummaryDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#MigrateSummaryDialog.__cancelProcess">__cancelProcess</a></td> +<td>Private slot to terminate the current process.</td> +</tr> +<tr> +<td><a href="#MigrateSummaryDialog.__processOutput">__processOutput</a></td> +<td>Private method to process the flask output and populate the summary list.</td> +</tr> +<tr> +<td><a href="#MigrateSummaryDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot handling a button press of the button box.</td> +</tr> +<tr> +<td><a href="#MigrateSummaryDialog.on_downgradeButton_clicked">on_downgradeButton_clicked</a></td> +<td>Private slot to downgrade to the selected revision.</td> +</tr> +<tr> +<td><a href="#MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged">on_summaryWidget_itemSelectionChanged</a></td> +<td>Private slot to handle the selection of an entry.</td> +</tr> +<tr> +<td><a href="#MigrateSummaryDialog.on_upgradeButton_clicked">on_upgradeButton_clicked</a></td> +<td>Private slot to upgrade to the selected revision.</td> +</tr> +<tr> +<td><a href="#MigrateSummaryDialog.showSummary">showSummary</a></td> +<td>Public method to show the migrations summary.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="MigrateSummaryDialog.__init__" ID="MigrateSummaryDialog.__init__"></a> +<h4>MigrateSummaryDialog (Constructor)</h4> +<b>MigrateSummaryDialog</b>(<i>project, migrateProject, migrations="", parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>project</i> (Project)</dt> +<dd> +reference to the project object +</dd> +<dt><i>migrateProject</i> (MigrateProject)</dt> +<dd> +reference to the migrate project extension +</dd> +<dt><i>migrations</i> (str)</dt> +<dd> +directory path containing the migrations +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="MigrateSummaryDialog.__cancelProcess" ID="MigrateSummaryDialog.__cancelProcess"></a> +<h4>MigrateSummaryDialog.__cancelProcess</h4> +<b>__cancelProcess</b>(<i></i>) + +<p> + Private slot to terminate the current process. +</p> +<a NAME="MigrateSummaryDialog.__processOutput" ID="MigrateSummaryDialog.__processOutput"></a> +<h4>MigrateSummaryDialog.__processOutput</h4> +<b>__processOutput</b>(<i>output</i>) + +<p> + Private method to process the flask output and populate the summary + list. +</p> +<dl> + +<dt><i>output</i> (str)</dt> +<dd> +output of the flask process +</dd> +</dl> +<a NAME="MigrateSummaryDialog.on_buttonBox_clicked" ID="MigrateSummaryDialog.on_buttonBox_clicked"></a> +<h4>MigrateSummaryDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) + +<p> + Private slot handling a button press of the button box. +</p> +<dl> + +<dt><i>button</i> (QAbstractButton)</dt> +<dd> +reference to the pressed button +</dd> +</dl> +<a NAME="MigrateSummaryDialog.on_downgradeButton_clicked" ID="MigrateSummaryDialog.on_downgradeButton_clicked"></a> +<h4>MigrateSummaryDialog.on_downgradeButton_clicked</h4> +<b>on_downgradeButton_clicked</b>(<i></i>) + +<p> + Private slot to downgrade to the selected revision. +</p> +<a NAME="MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged" ID="MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged"></a> +<h4>MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged</h4> +<b>on_summaryWidget_itemSelectionChanged</b>(<i></i>) + +<p> + Private slot to handle the selection of an entry. +</p> +<a NAME="MigrateSummaryDialog.on_upgradeButton_clicked" ID="MigrateSummaryDialog.on_upgradeButton_clicked"></a> +<h4>MigrateSummaryDialog.on_upgradeButton_clicked</h4> +<b>on_upgradeButton_clicked</b>(<i></i>) + +<p> + Private slot to upgrade to the selected revision. +</p> +<a NAME="MigrateSummaryDialog.showSummary" ID="MigrateSummaryDialog.showSummary"></a> +<h4>MigrateSummaryDialog.showSummary</h4> +<b>showSummary</b>(<i></i>) + +<p> + Public method to show the migrations summary. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- a/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.Project.html Sun Nov 29 16:04:25 2020 +0100 +++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.Project.html Sun Nov 29 16:05:10 2020 +0100 @@ -85,14 +85,6 @@ <td>Private slot to show some info about Flask.</td> </tr> <tr> -<td><a href="#Project.__getVirtualEnvironment">__getVirtualEnvironment</a></td> -<td>Private method to get the path of the virtual environment.</td> -</tr> -<tr> -<td><a href="#Project.__initDatabase">__initDatabase</a></td> -<td>Private slot showing the result of the database creation.</td> -</tr> -<tr> <td><a href="#Project.__isSuitableForVariant">__isSuitableForVariant</a></td> <td>Private method to test, if a detected command file is suitable for the given Python variant.</td> </tr> @@ -153,6 +145,14 @@ <td>Public method to get the names of all menus.</td> </tr> <tr> +<td><a href="#Project.getVirtualEnvironment">getVirtualEnvironment</a></td> +<td>Public method to get the path of the virtual environment.</td> +</tr> +<tr> +<td><a href="#Project.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td> +<td>Public method to get the path of the Python interpreter to be used with the current project.</td> +</tr> +<tr> <td><a href="#Project.hasCapability">hasCapability</a></td> <td>Public method to check, if a capability is available.</td> </tr> @@ -247,32 +247,6 @@ <p> Private slot to show some info about Flask. </p> -<a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a> -<h4>Project.__getVirtualEnvironment</h4> -<b>__getVirtualEnvironment</b>(<i></i>) - -<p> - Private method to get the path of the virtual environment. -</p> -<dl> -<dt>Returns:</dt> -<dd> -path of the virtual environment -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl> -<a NAME="Project.__initDatabase" ID="Project.__initDatabase"></a> -<h4>Project.__initDatabase</h4> -<b>__initDatabase</b>(<i></i>) - -<p> - Private slot showing the result of the database creation. -</p> <a NAME="Project.__isSuitableForVariant" ID="Project.__isSuitableForVariant"></a> <h4>Project.__isSuitableForVariant</h4> <b>__isSuitableForVariant</b>(<i>variant, line0</i>) @@ -521,6 +495,45 @@ list of str </dd> </dl> +<a NAME="Project.getVirtualEnvironment" ID="Project.getVirtualEnvironment"></a> +<h4>Project.getVirtualEnvironment</h4> +<b>getVirtualEnvironment</b>(<i></i>) + +<p> + Public method to get the path of the virtual environment. +</p> +<dl> +<dt>Returns:</dt> +<dd> +path of the virtual environment +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="Project.getVirtualenvInterpreter" ID="Project.getVirtualenvInterpreter"></a> +<h4>Project.getVirtualenvInterpreter</h4> +<b>getVirtualenvInterpreter</b>(<i></i>) + +<p> + Public method to get the path of the Python interpreter to be used + with the current project. +</p> +<dl> +<dt>Returns:</dt> +<dd> +path of the Python interpreter +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="Project.hasCapability" ID="Project.hasCapability"></a> <h4>Project.hasCapability</h4> <b>hasCapability</b>(<i>key</i>)
--- a/ProjectFlask/Documentation/source/index-Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.html Sun Nov 29 16:04:25 2020 +0100 +++ b/ProjectFlask/Documentation/source/index-Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.html Sun Nov 29 16:05:10 2020 +0100 @@ -39,7 +39,7 @@ </tr> <tr> <td><a href="Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelConfigDialog.html">PyBabelConfigDialog</a></td> -<td>Module implementing a dialog to edit the PyBabel configuration.</td> +<td>Module implementing a dialog to edit the flask-babel configuration.</td> </tr> <tr> <td><a href="Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension.html">PyBabelProjectExtension</a></td>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/source/index-Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.html Sun Nov 29 16:05:10 2020 +0100 @@ -0,0 +1,49 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<h1>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension</h1> + +<p> +Package containing support for the flask-migrate extension. +</p> + + +<h3>Modules</h3> +<table> + +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.FlaskMigrateDetector.html">FlaskMigrateDetector</a></td> +<td>Module to check for the presence of 'flask-migrate' by importing it.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateConfigDialog.html">MigrateConfigDialog</a></td> +<td>Module implementing a dialog to edit the flask-migrate configuration.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateProjectExtension.html">MigrateProjectExtension</a></td> +<td>Module implementing the project support for flask-migrate.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateSummaryDialog.html">MigrateSummaryDialog</a></td> +<td>Module implementing a dialog showing a summary of all created.migrations.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- a/ProjectFlask/Documentation/source/index-Plugin_Project_Flask.ProjectFlask.html Sun Nov 29 16:04:25 2020 +0100 +++ b/ProjectFlask/Documentation/source/index-Plugin_Project_Flask.ProjectFlask.html Sun Nov 29 16:05:10 2020 +0100 @@ -36,6 +36,10 @@ <td><a href="index-Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.html">FlaskBabelExtension</a></td> <td>Package containing support for the flask-babel extension.</td> </tr> +<tr> +<td><a href="index-Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.html">FlaskMigrateExtension</a></td> +<td>Package containing support for the flask-migrate extension.</td> +</tr> </table> <h3>Modules</h3>