eric6/Plugins/DocumentationPlugins/Ericapi/EricapiExecDialog.py

changeset 6942
2602857055c5
parent 6645
ad476851d7e0
child 7192
a22eee00b052
diff -r f99d60d6b59b -r 2602857055c5 eric6/Plugins/DocumentationPlugins/Ericapi/EricapiExecDialog.py
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/Plugins/DocumentationPlugins/Ericapi/EricapiExecDialog.py	Sun Apr 14 15:09:21 2019 +0200
@@ -0,0 +1,167 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2003 - 2019 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a dialog to show the output of the ericapi process.
+"""
+
+from __future__ import unicode_literals
+try:
+    str = unicode
+except NameError:
+    pass
+
+import os.path
+
+from PyQt5.QtCore import QProcess, QTimer
+from PyQt5.QtWidgets import QDialog, QDialogButtonBox
+
+from E5Gui import E5MessageBox
+
+from .Ui_EricapiExecDialog import Ui_EricapiExecDialog
+
+import Preferences
+
+
+class EricapiExecDialog(QDialog, Ui_EricapiExecDialog):
+    """
+    Class implementing a dialog to show the output of the ericapi process.
+    
+    This class starts a QProcess and displays a dialog that
+    shows the output of the documentation command process.
+    """
+    def __init__(self, cmdname, parent=None):
+        """
+        Constructor
+        
+        @param cmdname name of the ericapi generator (string)
+        @param parent parent widget of this dialog (QWidget)
+        """
+        super(EricapiExecDialog, self).__init__(parent)
+        self.setModal(True)
+        self.setupUi(self)
+        
+        self.buttonBox.button(QDialogButtonBox.Close).setEnabled(False)
+        self.buttonBox.button(QDialogButtonBox.Cancel).setDefault(True)
+        
+        self.process = None
+        self.cmdname = cmdname
+        
+    def start(self, args, fn):
+        """
+        Public slot to start the ericapi command.
+        
+        @param args commandline arguments for ericapi program (list of strings)
+        @param fn filename or dirname to be processed by ericapi program
+            (string)
+        @return flag indicating the successful start of the process (boolean)
+        """
+        self.errorGroup.hide()
+        
+        self.filename = fn
+        if os.path.isdir(self.filename):
+            dname = os.path.abspath(self.filename)
+            fname = "."
+            if os.path.exists(os.path.join(dname, "__init__.py")):
+                fname = os.path.basename(dname)
+                dname = os.path.dirname(dname)
+        else:
+            dname = os.path.dirname(self.filename)
+            fname = os.path.basename(self.filename)
+        
+        self.contents.clear()
+        self.errors.clear()
+        
+        program = args[0]
+        del args[0]
+        args.append(fname)
+        
+        self.process = QProcess()
+        self.process.setWorkingDirectory(dname)
+        
+        self.process.readyReadStandardOutput.connect(self.__readStdout)
+        self.process.readyReadStandardError.connect(self.__readStderr)
+        self.process.finished.connect(self.__finish)
+            
+        self.setWindowTitle(
+            self.tr('{0} - {1}').format(self.cmdname, self.filename))
+        self.process.start(program, args)
+        procStarted = self.process.waitForStarted(5000)
+        if not procStarted:
+            E5MessageBox.critical(
+                self,
+                self.tr('Process Generation Error'),
+                self.tr(
+                    'The process {0} could not be started. '
+                    'Ensure, that it is in the search path.'
+                ).format(program))
+        return procStarted
+        
+    def on_buttonBox_clicked(self, button):
+        """
+        Private slot called by a button of the button box clicked.
+        
+        @param button button that was clicked (QAbstractButton)
+        """
+        if button == self.buttonBox.button(QDialogButtonBox.Close):
+            self.accept()
+        elif button == self.buttonBox.button(QDialogButtonBox.Cancel):
+            self.__finish()
+        
+    def __finish(self):
+        """
+        Private slot called when the process finished.
+        
+        It is called when the process finished or
+        the user pressed the button.
+        """
+        if self.process is not None and \
+           self.process.state() != QProcess.NotRunning:
+            self.process.terminate()
+            QTimer.singleShot(2000, self.process.kill)
+            self.process.waitForFinished(3000)
+        
+        self.buttonBox.button(QDialogButtonBox.Close).setEnabled(True)
+        self.buttonBox.button(QDialogButtonBox.Cancel).setEnabled(False)
+        self.buttonBox.button(QDialogButtonBox.Close).setDefault(True)
+        
+        self.process = None
+        
+        self.contents.insertPlainText(
+            self.tr('\n{0} finished.\n').format(self.cmdname))
+        self.contents.ensureCursorVisible()
+        
+    def __readStdout(self):
+        """
+        Private slot to handle the readyReadStandardOutput signal.
+        
+        It reads the output of the process, formats it and inserts it into
+        the contents pane.
+        """
+        self.process.setReadChannel(QProcess.StandardOutput)
+        
+        while self.process.canReadLine():
+            s = str(self.process.readLine(),
+                    Preferences.getSystem("IOEncoding"),
+                    'replace')
+            self.contents.insertPlainText(s)
+            self.contents.ensureCursorVisible()
+        
+    def __readStderr(self):
+        """
+        Private slot to handle the readyReadStandardError signal.
+        
+        It reads the error output of the process and inserts it into the
+        error pane.
+        """
+        self.process.setReadChannel(QProcess.StandardError)
+        
+        while self.process.canReadLine():
+            self.errorGroup.show()
+            s = str(self.process.readLine(),
+                    Preferences.getSystem("IOEncoding"),
+                    'replace')
+            self.errors.insertPlainText(s)
+            self.errors.ensureCursorVisible()

eric ide

mercurial