Issue 141: add timestamps to stderr and stdout logs (#142)

* add timestamps to stderr and stdout logs

* send info about proxy to stderr

ChangeLog

@@ -1,3 +1,7 @@
+2023-03-07 Jan Kotanski <[email protected]>
+	* add timestamps to stderr and stdout logs (#142)
+	* tagged as 3.8.1
+
 2023-03-07 Jan Kotanski <[email protected]>
 	* send WARNING, ERROR, FATAL to stderr by default (#139)
 	* tagged as 3.8.0

nxswriter/Release.py

@@ -21,4 +21,4 @@
 
 
 #: package version
-__version__ = "3.8.0"
+__version__ = "3.8.1"

nxswriter/StreamSet.py

@@ -21,6 +21,7 @@
 
 import sys
 import weakref
+import datetime
 
 
 # (:obj:`bool`) write stream to stdout
@@ -81,7 +82,8 @@ def fatal(self, message, std=None):
             if self.log_fatal:
                 self.log_fatal.write(message + '\n')
             if std:
-                sys.stderr.write(message + '\n')
+                sys.stderr.write(
+                    "%s: FATAL: %s\n" % (datetime.datetime.now(), message))
                 sys.stderr.flush()
         except Exception:
             print(message)
@@ -101,7 +103,8 @@ def error(self, message, std=None):
             if self.log_error:
                 self.log_error.write(message + '\n')
             if std:
-                sys.stderr.write(message + '\n')
+                sys.stderr.write(
+                    "%s: ERROR: %s\n" % (datetime.datetime.now(), message))
                 sys.stderr.flush()
         except Exception:
             print(message)
@@ -121,7 +124,8 @@ def warn(self, message, std=None):
             if self.log_warn:
                 self.log_warn.write(message + '\n')
             if std:
-                sys.stderr.write(message + '\n')
+                sys.stderr.write(
+                    "%s: WARNING: %s\n" % (datetime.datetime.now(), message))
                 sys.stderr.flush()
         except Exception:
             print(message)
@@ -141,7 +145,8 @@ def info(self, message, std=None):
             if self.log_info:
                 self.log_info.write(message + '\n')
             elif std:
-                sys.stdout.write(message + '\n')
+                sys.stdout.write(
+                    "%s: INFO: %s\n" % (datetime.datetime.now(), message))
                 sys.stdout.flush()
         except Exception:
             print(message)
@@ -161,7 +166,8 @@ def debug(self, message, std=None):
             if self.log_debug:
                 self.log_debug.write(message + '\n')
             elif std:
-                sys.stdout.write(message + '\n')
+                sys.stdout.write(
+                    "%s: DEBUG: %s\n" % (datetime.datetime.now(), message))
                 sys.stdout.flush()
         except Exception:
             print(message)

nxswriter/TangoSource.py

@@ -250,14 +250,14 @@ def setup(self, xml):
                 self._streams.error(
                     "TangoSource::setup() - "
                     "Cannot connect to: %s \ndefined by %s"
-                    % (self.device, xml), std=False)
+                    % (self.device, xml))
 
         if not self.__proxy:
             if self._streams:
                 self._streams.error(
                     "TangoSource::setup() - "
                     "Cannot connect to: %s \ndefined by %s"
-                    % (self.device, xml), std=False)
+                    % (self.device, xml))
             # to make canfail works
             # raise DataSourceSetupError(
             #     "Cannot connect to: %s \ndefined by %s" % (self.device, xml))

test/StreamSet_test.py

@@ -139,7 +139,9 @@ def test_fatal(self):
             self.assertEqual(self.streams.log_info, None)
             self.assertEqual(self.streams.log_debug, None)
             self.assertEqual(self.mystdout.getvalue(), "")
-            self.assertEqual(self.mystderr.getvalue(), name + '\n')
+            self.assertEqual(
+                self.mystderr.getvalue().split(" ", 2)[-1],
+                "FATAL: " + name + '\n')
             sys.stdout = self.old_stdout
             sys.stderr = self.old_stderr
 
@@ -186,11 +188,15 @@ def test_fatal_log(self):
             self.assertEqual(self.streams.log_debug.getvalue(), "")
             self.assertEqual(self.mystdout.getvalue(), "")
             if i % 3 == 0:
-                self.assertEqual(self.mystderr.getvalue(), name + '\n')
+                self.assertEqual(
+                    self.mystderr.getvalue().split(" ", 2)[-1],
+                    "FATAL: " + name + '\n')
             elif i % 3 == 1:
                 self.assertEqual(self.mystderr.getvalue(), '')
             elif i % 3 == 2:
-                self.assertEqual(self.mystderr.getvalue(), name + '\n')
+                self.assertEqual(
+                    self.mystderr.getvalue().split(" ", 2)[-1],
+                    "FATAL: " + name + '\n')
             sys.stdout = self.old_stdout
             sys.stderr = self.old_stderr
 
@@ -211,7 +217,9 @@ def test_error(self):
             self.assertEqual(self.streams.log_info, None)
             self.assertEqual(self.streams.log_debug, None)
             self.assertEqual(self.mystdout.getvalue(), "")
-            self.assertEqual(self.mystderr.getvalue(), name + '\n')
+            self.assertEqual(
+                self.mystderr.getvalue().split(" ", 2)[-1],
+                "ERROR: " + name + '\n')
             sys.stdout = self.old_stdout
             sys.stderr = self.old_stderr
 
@@ -260,11 +268,15 @@ def test_error_log(self):
             self.assertEqual(self.streams.log_debug.getvalue(), "")
             self.assertEqual(self.mystdout.getvalue(), "")
             if i % 3 == 0:
-                self.assertEqual(self.mystderr.getvalue(), name + '\n')
+                self.assertEqual(
+                    self.mystderr.getvalue().split(" ", 2)[-1],
+                    "ERROR: " + name + '\n')
             elif i % 3 == 1:
                 self.assertEqual(self.mystderr.getvalue(), '')
             elif i % 3 == 2:
-                self.assertEqual(self.mystderr.getvalue(), name + '\n')
+                self.assertEqual(
+                    self.mystderr.getvalue().split(" ", 2)[-1],
+                    "ERROR: " + name + '\n')
             sys.stdout = self.old_stdout
             sys.stderr = self.old_stderr
 
@@ -285,7 +297,9 @@ def test_warn(self):
             self.assertEqual(self.streams.log_info, None)
             self.assertEqual(self.streams.log_debug, None)
             self.assertEqual(self.mystdout.getvalue(), "")
-            self.assertEqual(self.mystderr.getvalue(), name + '\n')
+            self.assertEqual(
+                self.mystderr.getvalue().split(" ", 2)[-1],
+                "WARNING: " + name + '\n')
             sys.stdout = self.old_stdout
             sys.stderr = self.old_stderr
 
@@ -332,11 +346,15 @@ def test_warn_log(self):
             self.assertEqual(self.streams.log_debug.getvalue(), "")
             self.assertEqual(self.mystdout.getvalue(), "")
             if i % 3 == 0:
-                self.assertEqual(self.mystderr.getvalue(), name + '\n')
+                self.assertEqual(
+                    self.mystderr.getvalue().split(" ", 2)[-1],
+                    "WARNING: " + name + '\n')
             elif i % 3 == 1:
                 self.assertEqual(self.mystderr.getvalue(), '')
             elif i % 3 == 2:
-                self.assertEqual(self.mystderr.getvalue(), name + '\n')
+                self.assertEqual(
+                    self.mystderr.getvalue().split(" ", 2)[-1],
+                    "WARNING: " + name + '\n')
             sys.stdout = self.old_stdout
             sys.stderr = self.old_stderr
 
@@ -353,7 +371,9 @@ def test_info(self):
             self.assertEqual(self.streams.log_warn, None)
             self.assertEqual(self.streams.log_info, None)
             self.assertEqual(self.streams.log_debug, None)
-            self.assertEqual(self.mystdout.getvalue(), name + '\n')
+            self.assertEqual(
+                self.mystdout.getvalue().split(" ", 2)[-1],
+                "INFO: " + name + '\n')
             self.assertEqual(self.mystderr.getvalue(), "")
             sys.stdout = self.old_stdout
             sys.stderr = self.old_stderr
@@ -422,7 +442,9 @@ def test_debug(self):
             self.assertEqual(self.streams.log_warn, None)
             self.assertEqual(self.streams.log_info, None)
             self.assertEqual(self.streams.log_debug, None)
-            self.assertEqual(self.mystdout.getvalue(), name + '\n')
+            self.assertEqual(
+                self.mystdout.getvalue().split(" ", 2)[-1],
+                "DEBUG: " + name + '\n')
             self.assertEqual(self.mystderr.getvalue(), "")
             sys.stdout = self.old_stdout
             sys.stderr = self.old_stderr