spns #40790: on Debian distributions, use dpkg-query instead of apt to check system...

[tools/sat.git] / src / debug.py

diff --git a/src/debug.py b/src/debug.py
index 8c24d5d90ee066f12be58ba6a89469c6f414b574..330fb6df37c33468237c5c49f03f4e04528161b4 100755 (executable)
--- a/src/debug.py
+++ b/src/debug.py
@@ -54,20 +54,35 @@ Show pretty print debug representation from instances of SAT classes
 import os
 import sys
 import traceback
-import StringIO as SIO
 import pprint as PP
+import inspect
+import src
 
-_debug = [False] #support push/pop for temporary activate debug outputs
+# Compatibility python 2/3 for unicode
+try:
+    _test = unicode
+except:
+    unicode = str
+
+# Compatibility python 2/3 for StringIO
+try:
+    from StringIO import StringIO
+except ImportError:
+    from io import StringIO
 
-_user = os.environ['USER']
-# wambeke is christian at home
-_developers = ["christian", "wambeke", "crouzet"] # crouzet, kloss ...
+_debug = [False] #support push/pop for temporary activate debug outputs
 
 
 def isDeveloper():
-    """if you are a developer, sometimes you want verbose traces etc."""
-    res = _user in _developers
-    return res
+    """
+    if you are a developer, sometimes you want verbose traces unconditionally
+    export SAT_DEVELOPER_MODE=1 before launch sat command to do that
+    """
+    res = os.getenv("SAT_DEVELOPER_MODE", "0")
+    if res in "YES yes 1 Y y".split():
+        return True
+    else:
+        return False
 
 def indent(text, amount=2, ch=' '):
     """indent multi lines message"""
@@ -84,9 +99,13 @@ def isTypeConfig(var):
     # print "NOT isTypeConfig %s" % typ
     return False
     
-def write(title, var="", force=None, fmt="\n#### DEBUG: %s:\n%s\n"):
+def write(title, var="", force=None, fmt="  %s:\n%s\n####\n"):
     """write sys.stderr a message if _debug[-1]==True or optionaly force=True"""
     if _debug[-1] or force:
+      callerframerecord = inspect.stack()[1] # get info of the caller
+      frame = callerframerecord[0]
+      info = inspect.getframeinfo(frame)
+      sys.stderr.write("\n#### DEBUG - %s:%s (%s) ####\n" % (info.filename, info.lineno, info.function))
       tvar = type(var)
       typ = str(tvar)
       if isTypeConfig(var):
@@ -107,8 +126,13 @@ def tofix(title, var="", force=None):
     write sys.stderr a message if _debug[-1]==True or optionaly force=True
     use this only if no logger accessible for classic logger.warning(message)
     """
-    fmt = "\n#### TOFIX: %s:\n%s\n"
-    write(title, var, force, fmt)
+    if _debug[-1] or isDeveloper():
+        callerframerecord = inspect.stack()[1] # get info of the caller
+        frame = callerframerecord[0]
+        info = inspect.getframeinfo(frame)
+        fmt = "#### TOFIX - " + str(info.filename) + ":" + str(info.lineno) +\
+              " (" + str(info.function) + ") ####\n   %s:\n%s\n"
+        write(title, var, force, fmt)
 
 def push_debug(aBool):
     """set debug outputs activated, or not"""
@@ -127,21 +151,16 @@ def format_exception(msg, limit=None, trace=None):
   """
   Format a stack trace and the exception information.
   as traceback.format_exception(), without color
-  with traceback only if (_debug) or (DBG._user in DBG._developers)
+  with traceback only if (_debug) or (DBG.isDeveloper())
   """
   etype, value, tb = sys.exc_info()
-  if _debug[-1] or isDeveloper():
-    res = msg
-    if tb:
-      res += "\nTraceback (most recent call last):\n"
-      res += "".join(traceback.format_tb(tb, limit))  # [:-1])
-    res += "\n"
-    res += "\n".join(traceback.format_exception_only(etype, value))
-    return res
-  else:
-    res = msg
-    res += "".join(traceback.format_exception_only(etype, value))
-    return res
+  res = msg
+  if tb:
+    res += "\nTraceback (most recent call last):\n"
+    res += "".join(traceback.format_tb(tb, limit))  # [:-1])
+  res += "\n"
+  res += "\n".join(traceback.format_exception_only(etype, value))
+  return res
 
 def format_color_exception(msg, limit=None, trace=None):
   """
@@ -168,7 +187,7 @@ def format_color_exception(msg, limit=None, trace=None):
 # utilitaires divers pour debug
 ###############################################
 
-class OutStream(SIO.StringIO):
+class OutStream(StringIO):
     """
     utility class for pyconf.Config output iostream
     """
@@ -178,9 +197,9 @@ class OutStream(SIO.StringIO):
       keep value before lost as self.value
       """
       self.value = self.getvalue()
-      SIO.StringIO.close(self)
+      StringIO.close(self)
     
-class InStream(SIO.StringIO):
+class InStream(StringIO):
     """utility class for pyconf.Config input iostream"""
     pass
 
@@ -246,7 +265,7 @@ def _saveConfigRecursiveDbg(config, aStream, indent, path, nb):
         #evaluate = value.resolve(config)
         aStream.write("<header>%s%s<reset> : %s <yellow>--> '%s'<reset>\n" % (indstr, path, config, str(config)))
       except Exception as e:  
-        aStream.write("<header>%s%s<reset> : <red>!!! ERROR: %s !!!<reset>\n" % (indstr, path, e.message))     
+        aStream.write("<header>%s%s<reset> : <red>!!! ERROR: %s !!!<reset>\n" % (indstr, path, str(e)))     
       return
     '''
     
@@ -275,14 +294,14 @@ def _saveConfigRecursiveDbg(config, aStream, indent, path, nb):
           evaluate = value.evaluate(config)
           aStream.write("%s%s.%s : %s --> '%s'\n" % (indstr, path, key, str(value), evaluate))
         except Exception as e:      
-          aStream.write("%s%s.%s : !!! ERROR: %s !!!\n" % (indstr, path, key, e.message))     
+          aStream.write("%s%s.%s : !!! ERROR: %s !!!\n" % (indstr, path, key, str(e)))     
         continue
       if "Reference" in strType:
         try:
           evaluate = value.resolve(config)
           aStream.write("%s%s.%s : %s --> '%s'\n" % (indstr, path, key, str(value), evaluate))
         except Exception as e:  
-          aStream.write("%s%s.%s : !!! ERROR: %s !!!\n" % (indstr, path, key, e.message))     
+          aStream.write("%s%s.%s : !!! ERROR: %s !!!\n" % (indstr, path, key, str(e)))     
         continue
       if type(value) in [str, bool, int, type(None), unicode]:
         aStream.write("%s%s.%s : '%s'\n" % (indstr, path, key, str(value)))
@@ -290,4 +309,4 @@ def _saveConfigRecursiveDbg(config, aStream, indent, path, nb):
       try:
         aStream.write("!!! TODO fix that %s %s%s.%s : %s\n" % (type(value), indstr, path, key, str(value)))
       except Exception as e:      
-        aStream.write("%s%s.%s : !!! %s\n" % (indstr, path, key, e.message))
+        aStream.write("%s%s.%s : !!! %s\n" % (indstr, path, key, str(e)))