Improvements to debugging while chasing #915

Author: nedbat

coverage/debug.py

@@ -25,6 +25,7 @@
 # debugging the configuration mechanisms you usually use to control debugging!
 # This is a list of forced debugging options.
 FORCED_DEBUG = []
+FORCED_DEBUG_FILE = None
 
 
 class DebugControl(object):
@@ -189,11 +190,14 @@ def add_pid_and_tid(text):
 
 class SimpleReprMixin(object):
     """A mixin implementing a simple __repr__."""
+    simple_repr_ignore = ['simple_repr_ignore', '$coverage.object_id']
+
     def __repr__(self):
         show_attrs = (
             (k, v) for k, v in self.__dict__.items()
             if getattr(v, "show_repr_attr", True)
             and not callable(v)
+            and k not in self.simple_repr_ignore
         )
         return "<{klass} @0x{id:x} {attrs}>".format(
             klass=self.__class__.__name__,
@@ -301,7 +305,7 @@ def get_one(cls, fileobj=None, show_process=True, filters=(), interim=False):
         the_one, is_interim = sys.modules.get(cls.SYS_MOD_NAME, (None, True))
         if the_one is None or is_interim:
             if fileobj is None:
-                debug_file_name = os.environ.get("COVERAGE_DEBUG_FILE")
+                debug_file_name = os.environ.get("COVERAGE_DEBUG_FILE", FORCED_DEBUG_FILE)
                 if debug_file_name:
                     fileobj = open(debug_file_name, "a")
                 else:
@@ -328,14 +332,18 @@ def log(msg, stack=False):                                  # pragma: debugging
         dump_stack_frames(out=out, skip=1)
 
 
-def decorate_methods(decorator, butnot=()):                 # pragma: debugging
-    """A class decorator to apply a decorator to public methods."""
+def decorate_methods(decorator, butnot=(), private=False):  # pragma: debugging
+    """A class decorator to apply a decorator to methods."""
     def _decorator(cls):
         for name, meth in inspect.getmembers(cls, inspect.isroutine):
-            public = name == '__init__' or not name.startswith("_")
-            decorate_it = public and name not in butnot
-            if decorate_it:
-                setattr(cls, name, decorator(meth))
+            if name not in cls.__dict__:
+                continue
+            if name != "__init__":
+                if not private and name.startswith("_"):
+                    continue
+            if name in butnot:
+                continue
+            setattr(cls, name, decorator(meth))
         return cls
     return _decorator
 
@@ -355,7 +363,7 @@ def _wrapper(*args, **kwargs):
 CALLS = itertools.count()
 OBJ_ID_ATTR = "$coverage.object_id"
 
-def show_calls(show_args=True, show_stack=False):           # pragma: debugging
+def show_calls(show_args=True, show_stack=False, show_return=False):    # pragma: debugging
     """A method decorator to debug-log each call to the function."""
     def _decorator(func):
         @functools.wraps(func)
@@ -377,9 +385,14 @@ def _wrapper(self, *args, **kwargs):
             if show_stack:
                 extra += " @ "
                 extra += "; ".join(_clean_stack_line(l) for l in short_stack().splitlines())
-            msg = "{} {:04d} {}{}\n".format(oid, next(CALLS), func.__name__, extra)
+            callid = next(CALLS)
+            msg = "{} {:04d} {}{}\n".format(oid, callid, func.__name__, extra)
             DebugOutputFile.get_one(interim=True).write(msg)
-            return func(self, *args, **kwargs)
+            ret = func(self, *args, **kwargs)
+            if show_return:
+                msg = "{} {:04d} {} return {!r}\n".format(oid, callid, func.__name__, ret)
+                DebugOutputFile.get_one(interim=True).write(msg)
+            return ret
         return _wrapper
     return _decorator
 

coverage/sqldata.py

@@ -192,7 +192,7 @@ def __init__(self, basename=None, suffix=None, no_disk=False, warn=None, debug=N
                 write any disk file.
             warn: a warning callback function, accepting a warning message
                 argument.
-            debug: a debug callback function.
+            debug: a `DebugControl` object (optional)
 
         """
         self._no_disk = no_disk
@@ -963,7 +963,7 @@ class SqliteDb(SimpleReprMixin):
     Use as a context manager, then you can use it like a
     :class:`python:sqlite3.Connection` object::
 
-        with SqliteDb(filename, debug=True) as db:
+        with SqliteDb(filename, debug_control) as db:
             db.execute("insert into schema (version) values (?)", (SCHEMA_VERSION,))
 
     """
@@ -1025,8 +1025,13 @@ def __enter__(self):
     def __exit__(self, exc_type, exc_value, traceback):
         self.nest -= 1
         if self.nest == 0:
-            self.con.__exit__(exc_type, exc_value, traceback)
-            self.close()
+            try:
+                self.con.__exit__(exc_type, exc_value, traceback)
+                self.close()
+            except Exception as exc:
+                if self.debug:
+                    self.debug.write("EXCEPTION from __exit__: {}".format(exc))
+                raise
 
     def execute(self, sql, parameters=()):
         """Same as :meth:`python:sqlite3.Connection.execute`."""
@@ -1049,6 +1054,8 @@ def execute(self, sql, parameters=()):
                         )
             except Exception:
                 pass
+            if self.debug:
+                self.debug.write("EXCEPTION from execute: {}".format(msg))
             raise CoverageException("Couldn't use data file {!r}: {}".format(self.filename, msg))
 
     def executemany(self, sql, data):