Changeset e4335ae in sasview

Timestamp:

Jul 19, 2018 6:12:03 AM (6 years ago)

Author:

Piotr Rozyczko <piotr.rozyczko@…>

Branches:

ESS_GUI, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc

Children:

c0de493

Parents:

02e7d3a

git-author:

Torin Cooper-Bennun <40573959+tcbennun@…> (07/19/18 06:12:03)

git-committer:

Piotr Rozyczko <piotr.rozyczko@…> (07/19/18 06:12:03)

Message:

SASVIEW-957 logging changes (#158)

• rework XStream to continue to write to stdout/stderr alongside redirection; make logging level setting consistent; make log configuration more consistent

• rm XStream; QT signal in QtHandler? logging handler; only logs in Log Explorer (no stdout/stderr)

• no need to change handler level

• use QTextBrowser.append to facilitate auto-scrolling in the Log Explorer

• modify logger unit test to reflect changes (passes)

Location:

src/sas

Files:

• logger_config.py (modified) (4 diffs)
• logging.ini (modified) (1 diff)
• qtgui/MainWindow/GuiManager.py (modified) (3 diffs)
• qtgui/MainWindow/MainWindow.py (modified) (1 diff)
• qtgui/Perspectives/Fitting/FittingWidget.py (modified) (1 diff)
• qtgui/Utilities/LocalConfig.py (modified) (1 diff)
• qtgui/Utilities/SasviewLogger.py (modified) (2 diffs)
• qtgui/Utilities/UnitTesting/SasviewLoggerTest.py (modified) (5 diffs)

src/sas/logger_config.py

@@ -7 +7 @@
 
 import pkg_resources
-
 
 '''
@@ -29 +28 @@
             logging.captureWarnings(True)
             logger = logging.getLogger(self.name)
+
         return logger
 
@@ -38 +38 @@
         self._update_all_logs_to_debug(logger)
         logging.captureWarnings(True)
+
         return logger
 
@@ -49 +50 @@
         '''
         for handler in logger.handlers or logger.parent.handlers:
-            #handler.setLevel(logging.DEBUG)
-            handler.setLevel(logging.WARNING)
+            handler.setLevel(logging.DEBUG)
         for name, _ in logging.Logger.manager.loggerDict.items():
-            #logging.getLogger(name).setLevel(logging.DEBUG)
-            logging.getLogger(name).setLevel(logging.WARNING)
+            logging.getLogger(name).setLevel(logging.DEBUG)
 
     def _find_config_file(self, filename="logging.ini"):

src/sas/logging.ini

@@ -12 +12 @@
 #format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
 #format=%(asctime)s - %(levelname)s : %(name)s:%(pathname)s:%(lineno)4d: %(message)s
-format=%(asctime)s - %(levelname)s : %(name)s:%(lineno)4d: %(message)s
+#format=%(asctime)s - %(levelname)s : %(name)s:%(lineno)4d: %(message)s
+format=%(asctime)s - %(levelname)s: %(message)s
 datefmt=%H:%M:%S
 

src/sas/qtgui/MainWindow/GuiManager.py

@@ -13 +13 @@
 # General SAS imports
 from sas.qtgui.Utilities.ConnectionProxy import ConnectionProxy
-from sas.qtgui.Utilities.SasviewLogger import XStream
+from sas.qtgui.Utilities.SasviewLogger import setup_qt_logging
 
 import sas.qtgui.Utilities.LocalConfig as LocalConfig
@@ -86 +86 @@
 
         # Fork off logging messages to the Log Window
-        XStream.stdout().messageWritten.connect(self.listWidget.insertPlainText)
-        XStream.stderr().messageWritten.connect(self.listWidget.insertPlainText)
+        handler = setup_qt_logging()
+        handler.messageWritten.connect(self.appendLog)
 
         # Log the start of the session
@@ -269 +269 @@
         """
         self.statusLabel.setText(text)
+
+    def appendLog(self, msg):
+        """Appends a message to the list widget in the Log Explorer. Use this
+        instead of listWidget.insertPlainText() to facilitate auto-scrolling"""
+        self.listWidget.append(msg.strip())
 
     def createGuiData(self, item, p_file=None):

src/sas/qtgui/MainWindow/MainWindow.py

@@ -10 +10 @@
 from sas.qtgui.UI import main_resources_rc
 from .UI.MainWindowUI import Ui_MainWindow
-
-# Initialize logging
-import sas.qtgui.Utilities.SasviewLogger
 
 class MainSasViewWindow(QMainWindow, Ui_MainWindow):

src/sas/qtgui/Perspectives/Fitting/FittingWidget.py

@@ -106 +106 @@
         # Globals
         self.initializeGlobals()
-
-        # Set up desired logging level
-        logging.disable(LocalConfig.DISABLE_LOGGING)
 
         # data index for the batch set

src/sas/qtgui/Utilities/LocalConfig.py

@@ -136 +136 @@
 USING_TWISTED = True
 
-# Logging levels to disable, if any
-DISABLE_LOGGING = logging.DEBUG
-
 # Time out for updating sasview
 UPDATE_TIMEOUT = 2
 
 # Logging levels to disable, if any
-DISABLE_LOGGING = logging.DEBUG
+DISABLE_LOGGING = logging.NOTSET
 
 def printEVT(message):

src/sas/qtgui/Utilities/SasviewLogger.py

@@ -6 +6 @@
 
 
-class XStream(QObject):
-    _stdout = None
-    _stderr = None
+class QtHandler(QObject, logging.Handler):
+    """
+    Version of logging handler "emitting" the message to custom stdout()
+    """
     messageWritten = pyqtSignal(str)
 
-    def flush(self):
-        pass
-
-    def fileno(self):
-        return -1
-
-    def write(self, msg):
-        if(not self.signalsBlocked()):
-            self.messageWritten.emit(str(msg))
-
-    @staticmethod
-    def stdout():
-        if(not XStream._stdout):
-            XStream._stdout = XStream()
-            sys.stdout = XStream._stdout
-        return XStream._stdout
-
-    @staticmethod
-    def stderr():
-        if(not XStream._stderr):
-            XStream._stderr = XStream()
-            sys.stderr = XStream._stderr
-        return XStream._stderr
-
-class QtHandler(logging.Handler):
-    """
-    Version of logging handler
-    "emitting" the message to custom stdout()
-    """
     def __init__(self):
+        QObject.__init__(self)
         logging.Handler.__init__(self)
 
@@ -46 +19 @@
         record = self.format(record)
         if record:
-            XStream.stdout().write('%s\n'%record)
+            self.messageWritten.emit('%s\n'%record)
 
 
-# Define the default logger
-logger = logging.getLogger()
+def setup_qt_logging():
+    # Define the default logger
+    logger = logging.getLogger()
 
-# Add the file handler
-logging.basicConfig(level=logging.INFO,
-                    format='%(asctime)s %(levelname)s %(message)s',
-                    filename=os.path.join(os.path.expanduser("~"),
-                                          'sasview.log'))
-# Add the qt-signal logger
-handler = QtHandler()
-handler.setFormatter(logging.Formatter("%(levelname)s: %(message)s"))
-logger.addHandler(handler)
+    # Add the qt-signal logger
+    handler = QtHandler()
+    handler.setFormatter(logging.Formatter(
+        fmt="%(asctime)s - %(levelname)s: %(message)s",
+        datefmt="%H:%M:%S"
+    ))
+    logger.addHandler(handler)
+
+    return handler

src/sas/qtgui/Utilities/UnitTesting/SasviewLoggerTest.py

@@ -11 +11 @@
 
 # Local
-from sas.qtgui.Utilities.SasviewLogger import XStream
 from sas.qtgui.Utilities.SasviewLogger import QtHandler
 
@@ -23 +22 @@
         """
         self.logger = logging.getLogger(__name__)
-        handler = QtHandler()
-        handler.setFormatter(logging.Formatter("%(levelname)s: %(message)s"))
-        self.logger.addHandler(handler)
+        self.handler = QtHandler()
+        self.handler.setFormatter(logging.Formatter("%(levelname)s: %(message)s"))
+        self.logger.addHandler(self.handler)
         self.logger.setLevel(logging.DEBUG)
 
@@ -35 +34 @@
         Test redirection of all levels of logging
         """
-        # Attach the listeners
-        XStream.stderr().messageWritten.connect( self.outHandlerGui.insertPlainText )
-        XStream.stdout().messageWritten.connect( self.outHandlerGui.insertPlainText )
+        # Attach the listener
+        self.handler.messageWritten.connect(self.outHandlerGui.insertPlainText)
 
         # Send the signals
@@ -44 +42 @@
         self.logger.warning('warning message')
         self.logger.error('error message')
-        sys.stdout.write('with stdout')
-        sys.stderr.write('with stderr')
 
         out=self.outHandlerGui.toPlainText()
@@ -54 +50 @@
         self.assertIn('WARNING: warning message', out)
         self.assertIn('ERROR: error message', out)
-        self.assertIn('with stdout', out)
-        self.assertIn('with stderr', out)
 
 if __name__ == "__main__":