Flask Project: comparison ProjectFlask/Project.py

-:3f5c05eb2d5f
+:dd3f6bfb85f7
 """
 Module implementing the Flask project support.
 """
 import os
+import re
 from PyQt5.QtCore import (
 pyqtSlot, QObject, QProcess, QProcessEnvironment, QTimer
 )
 from PyQt5.QtWidgets import QMenu, QDialog
 import UI.PixmapCache
 import Utilities
 from .FlaskCommandDialog import FlaskCommandDialog
+from .PyBabelCommandDialog import PyBabelCommandDialog
+# TODO: move PyBabel related code to a separate package (FlaskBabelExtension)
+# TODO: move database related code to a separate package (FlaskMigrateExtension)
 class Project(QObject):
 """
 Class implementing the Flask project support.
 """
 def __init__(self, plugin, iconSuffix, parent=None):
 self.__flaskVersions = {
 "python": "",
 "flask": "",
 "werkzeug": "",
+}
+self.__capabilities = {
+"pybabel": False,
+"migrate": False,
 }
 def initActions(self):
 """
 Public method to define the Flask actions.
 ))
 self.initDatabaseAct.triggered.connect(self.__initDatabase)
 self.actions.append(self.initDatabaseAct)
 ##################################
-## database action below        ##
+## pybabel action below         ##
 ##################################
 self.pybabelConfigAct = E5Action(
 self.tr('Configure PyBabel'),
 self.tr('Configure Py&Babel'),
 self.__menus = {}   # clear menus references
 menu = QMenu(self.tr('&Flask'), self.__ui)
 menu.setTearOffEnabled(True)
-menu.addSection("flask run")
 menu.addAction(self.runServerAct)
 menu.addAction(self.runDevServerAct)
 menu.addAction(self.askForServerOptionsAct)
-menu.addSection("flask shell")
+menu.addSeparator()
 menu.addAction(self.runPythonShellAct)
-menu.addSection("flask routes")
+menu.addSeparator()
 menu.addAction(self.showRoutesAct)
-menu.addSection("flask init-db")
+menu.addSeparator()
 menu.addAction(self.initDatabaseAct)
-menu.addSection(self.tr("Translations"))
+menu.addSeparator()
 menu.addAction(self.pybabelConfigAct)
-menu.addSection(self.tr("Various"))
+menu.addSeparator()
 menu.addAction(self.documentationAct)
 menu.addSeparator()
 menu.addAction(self.aboutFlaskAct)
 self.__menus["main"] = menu
 def projectOpenedHooks(self):
 """
 Public method to add our hook methods.
 """
 if self.__e5project.getProjectType() == "Flask":
+# TODO: add some methods for standard templates
 ##            self.__formsBrowser = (
 ##                e5App().getObject("ProjectBrowser")
 ##                .getProjectBrowser("forms"))
 ##            self.__formsBrowser.addHookMethodAndMenuEntry(
 ##                "newForm", self.newForm, self.tr("New template..."))
 ##
-if self.flaskBabelAvailable():
+self.__determineCapabilities()
+if self.__capabilities["pybabel"]:
 self.__e5project.projectLanguageAddedByCode.connect(
 self.__projectLanguageAdded)
 self.__translationsBrowser = (
 e5App().getObject("ProjectBrowser")
 .getProjectBrowser("translations"))
 self.tr("Compile Selected Catalogs"))
 self.__translationsBrowser.addHookMethodAndMenuEntry(
 "generateAll", self.updateCatalogs,
 self.tr("Update All Catalogs"))
 self.__translationsBrowser.addHookMethodAndMenuEntry(
+"generateAllWithObsolete", self.updateCatalogsObsolete,
+self.tr("Update All Catalogs (with obsolete)"))
+self.__translationsBrowser.addHookMethodAndMenuEntry(
 "generateSelected", self.updateSelectedCatalogs,
 self.tr("Update Selected Catalogs"))
+self.__translationsBrowser.addHookMethodAndMenuEntry(
+"generateSelectedWithObsolete",
+self.updateSelectedCatalogsObsolete,
+self.tr("Update Selected Catalogs (with obsolete)"))
 self.__hooksInstalled = True
 self.registerOpenHook()
 ##            self.__formsBrowser.removeHookMethod("newForm")
 ##            self.__formsBrowser = None
 ##
 self.__e5project.projectLanguageAddedByCode.disconnect(
 self.__projectLanguageAdded)
-self.__translationsBrowser.removeHookMethod("extractMessages")
+self.__translationsBrowser.removeHookMethod(
-self.__translationsBrowser.removeHookMethod("releaseAll")
+"extractMessages")
-self.__translationsBrowser.removeHookMethod("releaseSelected")
+self.__translationsBrowser.removeHookMethod(
-self.__translationsBrowser.removeHookMethod("generateAll")
+"releaseAll")
-self.__translationsBrowser.removeHookMethod("generateSelected")
+self.__translationsBrowser.removeHookMethod(
-self.__translationsBrowser.removeHookMethod("open")
+"releaseSelected")
+self.__translationsBrowser.removeHookMethod(
+"generateAll")
+self.__translationsBrowser.removeHookMethod(
+"generateAllWithObsolete")
+self.__translationsBrowser.removeHookMethod(
+"generateSelected")
+self.__translationsBrowser.removeHookMethod(
+"generateSelectedWithObsolete")
+self.__translationsBrowser.removeHookMethod(
+"open")
 self.__translationsBrowser = None
 self.__hooksInstalled = False
 ##################################################################
 self.__projectData[category][key] = value
 self.__e5project.setData(
 "PROJECTTYPESPECIFICDATA", category, self.__projectData[category])
-##################################################################
+def __determineCapabilities(self):
-## slots below implement documentation functions
+"""
+Private method to determine capabilities provided by supported
+extensions.
+"""
+# 1. support for flask-babel (i.e. pybabel)
+self.__capabilities["pybabel"] = self.flaskBabelAvailable()
+self.pybabelConfigAct.setEnabled(self.__capabilities["pybabel"])
+# 2. support for flask-migrate
+# TODO: add support for flask-migrate
+##################################################################
+## slot below implements project specific flask configuration
+##################################################################
+@pyqtSlot()
+def __configureFlaskForProject(self):
+"""
+Private slot to configure the project specific flask parameters.
+"""
+# TODO: implement the flask project config dialog
+# 1. check boxes to override flask-babel and flask-migrate
+# 2. support for project specific virtual environment
+##################################################################
+## slot below implements documentation function
 ##################################################################
 def __showDocumentation(self):
 """
 Private slot to show the helpviewer with the Flask documentation.
 dlg = RoutesDialog(self)
 if dlg.showRoutes():
 dlg.show()
 self.__routesDialog = dlg
+# TODO: replace this by commands made by flask-migrate (flask db ...)
 @pyqtSlot()
 def __initDatabase(self):
 """
 Private slot showing the result of the database creation.
 """
 dlg = FlaskCommandDialog(self)
-if dlg.startFlaskCommand("init-db"):
+if dlg.startCommand("init-db"):
 dlg.exec()
 ##################################################################
 ## slots and methods below implement i18n and l10n support
 ##################################################################
 @pyqtSlot()
 def __configurePybabel(self):
 """
 Private slot to show a dialog to edit the pybabel configuration.
 """
-# TODO: implement this
 from .PyBabelConfigDialog import PyBabelConfigDialog
 config = self.getData("pybabel", "")
 dlg = PyBabelConfigDialog(config)
 if dlg.exec() == QDialog.Accepted:
 config = dlg.getConfiguration()
 self.setData("pybabel", "", config)
+self.__e5project.setTranslationPattern(os.path.join(
+config["translationsDirectory"], "%language%", "LC_MESSAGES",
+"{0}.po".format(config["domain"])
+))
+self.__e5project.setDirty(True)
 cfgFileName = self.__e5project.getAbsoluteUniversalPath(
 config["configFile"])
 if not os.path.exists(cfgFileName):
 self.__createBabelCfg(cfgFileName)
 def __createBabelCfg(self, configFile):
 """
 Private method to create a template pybabel configuration file.
+@param configFile name of the configuration file to be created
+@type str
 @return flag indicating successful configuration file creation
 @rtype bool
 """
 _, app = self.getApplication()
 if app.endswith(".py"):
 """ generated.</p><p>Reason: {0}</p>""")
 .format(str(err))
 )
 return False
-def __projectLanguageAdded(self, code):
+def __getLocale(self, filename):
-# TODO: implement this with pybabel ...
+"""
-pass
+Private method to extract the locale out of a file name.
+@param filename name of the file used for extraction
+@type str
+@return extracted locale
+@rtype str or None
+"""
+if self.__e5project.getTranslationPattern():
+filename = os.path.splitext(filename)[0] + ".po"
+# On Windows, path typically contains backslashes. This leads
+# to an invalid search pattern '...\(' because the opening bracket
+# will be escaped.
+pattern = self.__e5project.getTranslationPattern()
+pattern = os.path.normpath(pattern)
+pattern = pattern.replace("%language%", "(.*?)")
+pattern = pattern.replace('\\', '\\\\')
+match = re.search(pattern, filename)
+if match is not None:
+return match.group(1)
+return None
 def openPOEditor(self, poFile):
 """
 Public method to edit the given file in an external .po editor.
 """
 Public method to extract the messages catalog template file.
 """
 title = self.tr("Extract messages")
 if self.__ensurePybabelConfigured():
+workdir = self.getApplication()[0]
 potFile = self.__e5project.getAbsoluteUniversalPath(
 self.getData("pybabel", "catalogFile"))
 try:
 potFilePath = os.path.dirname(potFile)
 except EnvironmentError:
 pass
 args = [
 "-F",
-self.__e5project.getAbsoluteUniversalPath(
+os.path.relpath(
-self.getData("pybabel", "configFile"))
+self.__e5project.getAbsoluteUniversalPath(
+self.getData("pybabel", "configFile")),
+workdir
+)
 ]
 if self.getData("pybabel", "markersList"):
 for marker in self.getData("pybabel", "markersList"):
 args += ["-k", marker]
 args += [
 "-o",
-potFile,
+os.path.relpath(potFile, workdir),
 "."
 ]
-dlg = FlaskCommandDialog(self)
+dlg = PyBabelCommandDialog(
-res = dlg.startBabelCommand(
+self, title,
-"extract", args, title,
 msgSuccess=self.tr("\nMessages extracted successfully.")
 )
+res = dlg.startCommand("extract", args, workdir)
 if res:
 dlg.exec()
 self.__e5project.appendFile(potFile)
-# TODO: implement this with pybabel ...
-pass
+def __projectLanguageAdded(self, code):
+"""
-def compileCatalogs(self):
+Private slot handling the addition of a new language.
-# TODO: implement this with pybabel ...
-pass
+@param code language code of the new language
+@type str
-def compileSelectedCatalogs(self):
+"""
-# TODO: implement this with pybabel ...
+title = self.tr(
-pass
+"Initializing message catalog for '{0}'").format(code)
-def updateCatalogs(self):
+if self.__ensurePybabelConfigured():
-# TODO: implement this with pybabel ...
+workdir = self.getApplication()[0]
-pass
+langFile = self.__e5project.getAbsoluteUniversalPath(
+self.__e5project.getTranslationPattern().replace(
-def updateSelectedCatalogs(self):
+"%language%", code))
-# TODO: implement this with pybabel ...
+potFile = self.__e5project.getAbsoluteUniversalPath(
-pass
+self.getData("pybabel", "catalogFile"))
+args = [
+"--domain={0}".format(self.getData("pybabel", "domain")),
+"--input-file={0}".format(os.path.relpath(potFile, workdir)),
+"--output-file={0}".format(os.path.relpath(langFile, workdir)),
+"--locale={0}".format(code),
+]
+dlg = PyBabelCommandDialog(
+self, title,
+msgSuccess=self.tr(
+"\nMessage catalog initialized successfully.")
+)
+res = dlg.startCommand("init", args, workdir)
+if res:
+dlg.exec()
+self.__e5project.appendFile(langFile)
+def compileCatalogs(self, filenames):
+"""
+Public method to compile the message catalogs.
+@param filenames list of filenames (not used)
+@type list of str
+"""
+title = self.tr("Compiling message catalogs")
+if self.__ensurePybabelConfigured():
+workdir = self.getApplication()[0]
+translationsDirectory = self.__e5project.getAbsoluteUniversalPath(
+self.getData("pybabel", "translationsDirectory"))
+args = [
+"--domain={0}".format(self.getData("pybabel", "domain")),
+"--directory={0}".format(
+os.path.relpath(translationsDirectory, workdir)),
+"--use-fuzzy",
+"--statistics",
+]
+dlg = PyBabelCommandDialog(
+self, title,
+msgSuccess=self.tr("\nMessage catalogs compiled successfully.")
+)
+res = dlg.startCommand("compile", args, workdir)
+if res:
+dlg.exec()
+for entry in os.walk(translationsDirectory):
+for fileName in entry[2]:
+fullName = os.path.join(entry[0], fileName)
+if fullName.endswith('.mo'):
+self.__e5project.appendFile(fullName)
+def compileSelectedCatalogs(self, filenames):
+"""
+Public method to update the message catalogs.
+@param filenames list of file names
+@type list of str
+"""
+title = self.tr("Compiling message catalogs")
+locales = {self.__getLocale(f) for f in filenames}
+if len(locales) == 0:
+E5MessageBox.warning(
+self.__ui,
+title,
+self.tr('No locales detected. Aborting...'))
+return
+if self.__ensurePybabelConfigured():
+workdir = self.getApplication()[0]
+translationsDirectory = self.__e5project.getAbsoluteUniversalPath(
+self.getData("pybabel", "translationsDirectory"))
+argsList = []
+for loc in locales:
+argsList.append([
+"compile",
+"--domain={0}".format(self.getData("pybabel", "domain")),
+"--directory={0}".format(
+os.path.relpath(translationsDirectory, workdir)),
+"--use-fuzzy",
+"--statistics",
+"--locale={0}".format(loc),
+])
+dlg = PyBabelCommandDialog(
+self, title=title,
+msgSuccess=self.tr("\nMessage catalogs compiled successfully.")
+)
+res = dlg.startBatchCommand(argsList, workdir)
+if res:
+dlg.exec()
+for entry in os.walk(translationsDirectory):
+for fileName in entry[2]:
+fullName = os.path.join(entry[0], fileName)
+if fullName.endswith('.mo'):
+self.__e5project.appendFile(fullName)
+def updateCatalogs(self, filenames, withObsolete=False):
+"""
+Public method to update the message catalogs.
+@param filenames list of filenames (not used)
+@type list of str
+@param withObsolete flag indicating to keep obsolete translations
+@type bool
+"""
+title = self.tr("Updating message catalogs")
+if self.__ensurePybabelConfigured():
+workdir = self.getApplication()[0]
+translationsDirectory = self.__e5project.getAbsoluteUniversalPath(
+self.getData("pybabel", "translationsDirectory"))
+potFile = self.__e5project.getAbsoluteUniversalPath(
+self.getData("pybabel", "catalogFile"))
+args = [
+"--domain={0}".format(self.getData("pybabel", "domain")),
+"--input-file={0}".format(os.path.relpath(potFile, workdir)),
+"--output-dir={0}".format(
+os.path.relpath(translationsDirectory, workdir)),
+]
+if not withObsolete:
+args.append("--ignore-obsolete")
+dlg = PyBabelCommandDialog(
+self, title,
+msgSuccess=self.tr("\nMessage catalogs updated successfully.")
+)
+res = dlg.startCommand("update", args, workdir)
+if res:
+dlg.exec()
+def updateCatalogsObsolete(self, filenames):
+"""
+Public method to update the message catalogs keeping obsolete
+translations.
+@param filenames list of filenames (not used)
+@type list of str
+"""
+self.updateCatalogs(filenames, withObsolete=True)
+def updateSelectedCatalogs(self, filenames, withObsolete=False):
+"""
+Public method to update the selected message catalogs.
+@param filenames list of filenames
+@type list of str
+@param withObsolete flag indicating to keep obsolete translations
+@type bool
+"""
+title = self.tr("Updating message catalogs")
+locales = {self.__getLocale(f) for f in filenames}
+if len(locales) == 0:
+E5MessageBox.warning(
+self.__ui,
+title,
+self.tr('No locales detected. Aborting...'))
+return
+if self.__ensurePybabelConfigured():
+workdir = self.getApplication()[0]
+translationsDirectory = self.__e5project.getAbsoluteUniversalPath(
+self.getData("pybabel", "translationsDirectory"))
+potFile = self.__e5project.getAbsoluteUniversalPath(
+self.getData("pybabel", "catalogFile"))
+argsList = []
+for loc in locales:
+args = [
+"update",
+"--domain={0}".format(self.getData("pybabel", "domain")),
+"--input-file={0}".format(
+os.path.relpath(potFile, workdir)),
+"--output-dir={0}".format(
+os.path.relpath(translationsDirectory, workdir)),
+"--locale={0}".format(loc),
+]
+if not withObsolete:
+args.append("--ignore-obsolete")
+argsList.append(args)
+dlg = PyBabelCommandDialog(
+self, title=title,
+msgSuccess=self.tr("\nMessage catalogs updated successfully.")
+)
+res = dlg.startBatchCommand(argsList, workdir)
+if res:
+dlg.exec()
+def updateSelectedCatalogsObsolete(self, filenames):
+"""
+Public method to update the message catalogs keeping obsolete
+translations.
+@param filenames list of filenames (not used)
+@type list of str
+"""
+self.updateSelectedCatalogs(filenames, withObsolete=True)

Mercurial Repositories > Flask Project / file comparison

comparison: ProjectFlask/Project.py

ProjectFlask/Project.py