eric6/Plugins/PluginWizardEricPlugin.py

changeset 6942
2602857055c5
parent 6645
ad476851d7e0
child 7192
a22eee00b052
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/Plugins/PluginWizardEricPlugin.py	Sun Apr 14 15:09:21 2019 +0200
@@ -0,0 +1,192 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2014 - 2019 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing the eric plug-in wizard plug-in.
+"""
+
+from __future__ import unicode_literals
+try:
+    str = unicode       # __IGNORE_EXCEPTION__
+except NameError:
+    pass
+
+import os
+
+from PyQt5.QtCore import QObject
+from PyQt5.QtWidgets import QDialog
+
+from E5Gui.E5Application import e5App
+from E5Gui.E5Action import E5Action
+from E5Gui import E5MessageBox
+
+import UI.Info
+
+# Start-of-Header
+name = "eric plug-in Wizard Plug-in"
+author = "Detlev Offenbach <detlev@die-offenbachs.de>"
+autoactivate = True
+deactivateable = True
+version = UI.Info.VersionOnly
+className = "WizardEricPluginWizard"
+packageName = "__core__"
+shortDescription = "Wizard for the creation of an eric plug-in file."
+longDescription = \
+    """This plug-in implements a wizard to generate code for""" \
+    """ an eric plug-in main script file."""
+needsRestart = False
+pyqtApi = 2
+python2Compatible = True
+# End-of-Header
+
+error = ""
+
+
+class WizardEricPluginWizard(QObject):
+    """
+    Class implementing the eric plug-in wizard plug-in.
+    """
+    def __init__(self, ui):
+        """
+        Constructor
+        
+        @param ui reference to the user interface object (UI.UserInterface)
+        """
+        super(WizardEricPluginWizard, self).__init__(ui)
+        self.__ui = ui
+        self.__action = None
+    
+    def __initialize(self):
+        """
+        Private slot to (re)initialize the plug-in.
+        """
+        self.__act = None
+    
+    def activate(self):
+        """
+        Public method to activate this plug-in.
+        
+        @return tuple of None and activation status (boolean)
+        """
+        self.__initAction()
+        self.__initMenu()
+        
+        return None, True
+    
+    def deactivate(self):
+        """
+        Public method to deactivate this plug-in.
+        """
+        menu = self.__ui.getMenu("wizards")
+        if menu:
+            menu.removeAction(self.__action)
+        self.__ui.removeE5Actions([self.__action], 'wizards')
+    
+    def __initAction(self):
+        """
+        Private method to initialize the action.
+        """
+        self.__action = E5Action(
+            self.tr('eric Plug-in Wizard'),
+            self.tr('&eric Plug-in Wizard...'),
+            0, 0, self,
+            'wizards_eric_plugin')
+        self.__action.setStatusTip(self.tr('eric Plug-in Wizard'))
+        self.__action.setWhatsThis(self.tr(
+            """<b>eric Plug-in Wizard</b>"""
+            """<p>This wizard opens a dialog for entering all the parameters"""
+            """ needed to create the basic contents of an eric plug-in file."""
+            """ The generated code is inserted at the current cursor"""
+            """ position.</p>"""
+        ))
+        self.__action.triggered.connect(self.__handle)
+        
+        self.__ui.addE5Actions([self.__action], 'wizards')
+
+    def __initMenu(self):
+        """
+        Private method to add the actions to the right menu.
+        """
+        menu = self.__ui.getMenu("wizards")
+        if menu:
+            menu.addAction(self.__action)
+    
+    def __callForm(self, editor):
+        """
+        Private method to display a dialog and get the code.
+        
+        @param editor reference to the current editor
+        @return generated code (string), the plug-in package name (string)
+            and a flag indicating success (boolean)
+        """
+        from WizardPlugins.EricPluginWizard.PluginWizardDialog import \
+            PluginWizardDialog
+        dlg = PluginWizardDialog(None)
+        if dlg.exec_() == QDialog.Accepted:
+            return (dlg.getCode(), dlg.packageName(), True)
+        else:
+            return (None, "", False)
+        
+    def __handle(self):
+        """
+        Private method to handle the wizards action.
+        """
+        editor = e5App().getObject("ViewManager").activeWindow()
+        
+        if editor is None:
+            E5MessageBox.critical(
+                self.__ui,
+                self.tr('No current editor'),
+                self.tr('Please open or create a file first.'))
+        else:
+            code, packageName, ok = self.__callForm(editor)
+            if ok:
+                line, index = editor.getCursorPosition()
+                # It should be done on this way to allow undo
+                editor.beginUndoAction()
+                editor.insertAt(code, line, index)
+                editor.endUndoAction()
+                if not editor.getFileName():
+                    editor.setLanguage("dummy.py")
+                
+                if packageName:
+                    project = e5App().getObject("Project")
+                    packagePath = os.path.join(project.getProjectPath(),
+                                               packageName)
+                    if not os.path.exists(packagePath):
+                        try:
+                            os.mkdir(packagePath)
+                        except OSError as err:
+                            E5MessageBox.critical(
+                                self,
+                                self.tr("Create Package"),
+                                self.tr(
+                                    """<p>The package directory <b>{0}</b>"""
+                                    """ could not be created. Aborting..."""
+                                    """</p><p>Reason: {1}</p>""")
+                                .format(packagePath, str(err)))
+                            return
+                    packageFile = os.path.join(packagePath, "__init__.py")
+                    if not os.path.exists(packageFile):
+                        try:
+                            f = open(packageFile, "w", encoding="utf-8")
+                            f.close()
+                        except IOError as err:
+                            E5MessageBox.critical(
+                                self,
+                                self.tr("Create Package"),
+                                self.tr(
+                                    """<p>The package file <b>{0}</b> could"""
+                                    """ not be created. Aborting...</p>"""
+                                    """<p>Reason: {1}</p>""")
+                                .format(packageFile, str(err)))
+                            return
+                    project.appendFile(packageFile)
+                    project.saveProject()
+                    e5App().getObject("ViewManager").openSourceFile(
+                        packageFile)
+
+#
+# eflag: noqa = M801

eric ide

mercurial