Add option to hide variables by name

Author: cknd

README.md

@@ -56,7 +56,7 @@ File demo.py, line 6, in <lambda>
 
 TypeError: unsupported operand type(s) for +: 'int' and 'str'
 ```
-I sometimes use this locally instead of a real debugger, but mostly it helps me sleep when my code runs somewhere where the only debug tool is a log file (though it's not a fully-grown [error monitoring system](https://sentry.io/welcome/)).
+I rarely use this locally instead of a real debugger, but it helps me sleep when my code runs somewhere where the only debug tool is a log file (though it's not a fully-grown [error monitoring system](https://sentry.io/welcome/)).
 
 By default, it tries to be somewhat polite about screen space (showing only a handful of source lines & the function header, and only the variables _in those lines_, and only (?) 500 characters per variable). You can [configure](https://github.com/cknd/stackprinter/blob/master/stackprinter/__init__.py#L28-L137) exactly how verbose things should be.
 
@@ -106,7 +106,19 @@ except:
     logger.exception('The front fell off.')  # Logs a rich traceback along with the given message
 ```
 
-For all the config options [see the docstring of `format()`](https://github.com/cknd/stackprinter/blob/master/stackprinter/__init__.py#L28-L137).
+For all the config options [see the docstring of `format()`](https://github.com/cknd/stackprinter/blob/master/stackprinter/__init__.py#L28-L149).
+The same config kwargs are accepted by `format()`, `show()` and `set_excepthook()`. They allow you to tweak the formatting, hide certain variables by name, skip variables in calls within certain files, and some other stuff.
+
+```python
+try:
+    something()
+except RuntimeError as exc:
+    stackprinter.show(exc, suppressed_vars=[r".*secret.*"],
+                           suppressed_paths=[r"lib/python.*/site-packages/boringstuff"],
+                           truncate_vals=9001)
+```
+
+
 
 ## Printing the current call stack
 To see your own thread's current call stack, call `show` or `format` anywhere outside of exception handling.

demo.py

@@ -9,7 +9,8 @@ def dangerous_function(blub):
     somelist = [[1,2], [3,4]]
     anotherlist = [['5', 6]]
     spam = numpy.zeros((3,3))
+    supersecret = "you haven't seen this"
     dangerous_function(somelist + anotherlist)
 except:
-    stackprinter.show(style='plaintext', source_lines=4)
+    stackprinter.show(style='plaintext', source_lines=4, suppressed_vars=[r".*secret.*"])
 

demo_complex.py

@@ -9,4 +9,5 @@
         stackprinter.show(style='darkbg2',
                           line_wrap=40,
                           reverse=False,
-                          suppressed_paths=[r"lib/python.*/site-packages/numpy"])
+                          suppressed_paths=[r"lib/python.*/site-packages/numpy"],
+                          suppressed_vars=[r".*secret.*"])

stackprinter/__init__.py

@@ -26,7 +26,7 @@ def show_or_format(thing=None, *args, **kwargs):
 
 @_guess_thing
 def format(thing=None, **kwargs):
-    """
+    r"""
     Render the traceback of an exception or a frame's call stack
 
 
@@ -128,6 +128,16 @@ def format(thing=None, **kwargs):
         By default, this list is `[KeyboardInterrupt]`. Set to `[]`
         to force verbose formatting even on a keyboard interrupt.
 
+    suppressed_vars: list of regex patterns
+        Don't show the content of variables whose name matches any of the given
+        patterns.
+        Internally, this doesn't just filter the output, but stackprinter won't
+        even try to access these values at all. So this can also be used as a
+        workaround for rare issues around dynamic attribute lookups.
+
+        Example:
+        `suppressed_vars=[r".*password.*",  r"certainobject\.certainproperty"]`
+
     reverse: bool
         List the innermost frame first.
 

stackprinter/extraction.py

@@ -2,6 +2,7 @@
 import inspect
 from collections import OrderedDict, namedtuple
 from stackprinter.source_inspection import annotate
+from stackprinter.utils import match
 
 NON_FUNCTION_SCOPES =  ['<module>', '<lambda>', '<listcomp>']
 
@@ -16,7 +17,7 @@ def __str__(self):
                 (self.filename, self.lineno, self.function))
 
 
-def get_info(tb_or_frame, lineno=None):
+def get_info(tb_or_frame, lineno=None, suppressed_vars=[]):
     """
     Get a frame representation that's easy to format
 
@@ -101,7 +102,7 @@ def get_info(tb_or_frame, lineno=None):
         head_lns = []
 
     names = name2lines.keys()
-    assignments = get_vars(names, frame.f_locals, frame.f_globals)
+    assignments = get_vars(names, frame.f_locals, frame.f_globals, suppressed_vars)
 
     finfo =  FrameInfo(filename, function, lineno, source_map, head_lns,
                        line2names, name2lines, assignments)
@@ -139,15 +140,18 @@ def get_source(frame):
     return lines, startline
 
 
-def get_vars(names, loc, glob):
+def get_vars(names, loc, glob, suppressed_vars):
     assignments = []
     for name in names:
-        try:
-            val = lookup(name, loc, glob)
-        except LookupError:
-            pass
+        if match(name, suppressed_vars):
+            assignments.append((name, CensoredVariable()))
         else:
-            assignments.append((name, val))
+            try:
+                val = lookup(name, loc, glob)
+            except LookupError:
+                pass
+            else:
+                assignments.append((name, val))
     return OrderedDict(assignments)
 
 
@@ -174,6 +178,10 @@ def lookup(name, scopeA, scopeB):
     return val
 
 
+class CensoredVariable():
+    def __repr__(self):
+        return "*****"
+
 class UnresolvedAttribute():
     """
     Container value for failed dot attribute lookups

stackprinter/formatting.py

@@ -39,7 +39,8 @@ def format_summary(frames, style='plaintext', source_lines=1, reverse=False,
 
 def format_stack(frames, style='plaintext', source_lines=5,
                  show_signature=True, show_vals='like_source',
-                 truncate_vals=500, line_wrap=60, reverse=False, suppressed_paths=None):
+                 truncate_vals=500, line_wrap=60, reverse=False,
+                 suppressed_paths=None, suppressed_vars=[]):
     """
     Render a list of frames (or FrameInfo tuples)
 
@@ -60,20 +61,22 @@ def format_stack(frames, style='plaintext', source_lines=5,
                                       show_vals=show_vals,
                                       truncate_vals=truncate_vals,
                                       line_wrap=line_wrap,
-                                      suppressed_paths=suppressed_paths)
+                                      suppressed_paths=suppressed_paths,
+                                      suppressed_vars=suppressed_vars)
 
     verbose_formatter = get_formatter(style=style,
                                       source_lines=source_lines,
                                       show_signature=show_signature,
                                       show_vals=show_vals,
                                       truncate_vals=truncate_vals,
                                       line_wrap=line_wrap,
-                                      suppressed_paths=suppressed_paths)
+                                      suppressed_paths=suppressed_paths,
+                                      suppressed_vars=suppressed_vars)
 
     frame_msgs = []
     parent_is_boring = True
     for frame in frames:
-        fi = ex.get_info(frame)
+        fi = ex.get_info(frame, suppressed_vars=suppressed_vars)
         is_boring = match(fi.filename, suppressed_paths)
         if is_boring:
             if parent_is_boring:
@@ -111,7 +114,7 @@ def format_stack_from_frame(fr, add_summary=False, **kwargs):
 
 def format_exc_info(etype, evalue, tb, style='plaintext', add_summary='auto',
                     reverse=False, suppressed_exceptions=[KeyboardInterrupt],
-                    **kwargs):
+                    suppressed_vars=[], **kwargs):
     """
     Format an exception traceback, including the exception message
 
@@ -149,6 +152,7 @@ def format_exc_info(etype, evalue, tb, style='plaintext', add_summary='auto',
                                    style=style,
                                    add_summary=add_summary,
                                    reverse=reverse,
+                                   suppressed_vars=suppressed_vars,
                                    **kwargs)
 
             if style == 'plaintext':
@@ -161,7 +165,8 @@ def format_exc_info(etype, evalue, tb, style='plaintext', add_summary='auto',
         # Now, actually do some formatting:
         parts = []
         if tb:
-            frameinfos = [ex.get_info(tb_) for tb_ in _walk_traceback(tb)]
+            frameinfos = [ex.get_info(tb_, suppressed_vars=suppressed_vars)
+                          for tb_ in _walk_traceback(tb)]
             if (suppressed_exceptions and
                 issubclass(etype, tuple(suppressed_exceptions))):
                 summary = format_summary(frameinfos, style=style,

stackprinter/frame_formatting.py

@@ -24,7 +24,7 @@ class FrameFormatter():
     def __init__(self, source_lines=5, source_lines_after=1,
                  show_signature=True, show_vals='like_source',
                  truncate_vals=500, line_wrap: int = 60,
-                 suppressed_paths=None):
+                 suppressed_paths=None, suppressed_vars=None):
         """
         Formatter for single frames.
 
@@ -89,6 +89,7 @@ def __init__(self, source_lines=5, source_lines_after=1,
         self.truncate_vals = truncate_vals
         self.line_wrap = line_wrap
         self.suppressed_paths = suppressed_paths
+        self.suppressed_vars = suppressed_vars
 
     def __call__(self, frame, lineno=None):
         """
@@ -123,7 +124,7 @@ def __call__(self, frame, lineno=None):
                              "%s. Got %r" % (accepted_types, frame))
 
         try:
-            finfo = ex.get_info(frame, lineno)
+            finfo = ex.get_info(frame, lineno, self.suppressed_vars)
 
             return self._format_frame(finfo)
         except Exception as exc:

tests/source.py

@@ -68,7 +68,7 @@ def spam_spam_spam(val):
             bla.nonexistant_attribute
         except:
             pass
-
+        supersecret = "you haven't seen this"
         boing = np.\
                 random.rand(*bla.T.\
                         T.T)

tests/test_frame_inspection.py

@@ -5,11 +5,21 @@
 @pytest.fixture
 def frameinfo():
     somevalue = 'spam'
+
+    supersecretthings = "gaaaah"
+    class Blob():
+        pass
+    someobject = Blob()
+    someobject.secretattribute = "uarrgh"
+
     fr = sys._getframe()
-    return ex.get_info(fr)
+    hidden = [r".*secret.*", r"someobject\..*attribute"]
+    return ex.get_info(fr, suppressed_vars=hidden)
 
 def test_frameinfo(frameinfo):
     fi = frameinfo
     assert fi.filename.endswith('test_frame_inspection.py')
     assert fi.function == 'frameinfo'
     assert fi.assignments['somevalue'] == 'spam'
+    assert isinstance(fi.assignments['supersecretthings'], ex.CensoredVariable)
+    assert isinstance(fi.assignments['someobject.secretattribute'], ex.CensoredVariable)