Merge pull request #32 from cknd/line_wrap_docs

Configurable line wrap

Author: cknd

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Added
 - Option to disable verbose formatting for given types of exceptions (generating a standard python-like traceback instead)
+- Line wrap for printed variables can be adjusted or turned off
 
 ## Changed
 - Disabled verbose formatting for KeyboardInterrupts by default. Call `format(..., suppressed_exceptions=None`) to enforce verbose printing even on a keyboard interrupt.

demo_complex.py

@@ -6,4 +6,7 @@
         Hovercraft().eels()
     except:
         # raise
-        stackprinter.show(style='darkbg2', reverse=False, suppressed_paths=[r"lib/python.*/site-packages/numpy"])
+        stackprinter.show(style='darkbg2',
+                          line_wrap=40,
+                          reverse=False,
+                          suppressed_paths=[r"lib/python.*/site-packages/numpy"])

stackprinter/__init__.py

@@ -106,6 +106,10 @@ def format(thing=None, **kwargs):
         Maximum number of characters to be used for each variable value.
         Default: 500
 
+    line_wrap: int (default 60)
+        Limit how many columns are available to print each variable
+        (excluding its name). Set to 0 or False to disable wrapping.
+
     suppressed_paths: list of regex patterns
         Set less verbose formatting for frames whose code lives in certain paths
         (e.g. library code). Files whose path matches any of the given regex

stackprinter/formatting.py

@@ -39,7 +39,7 @@ 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, reverse=False, suppressed_paths=None):
+                 truncate_vals=500, line_wrap=60, reverse=False, suppressed_paths=None):
     """
     Render a list of frames (or FrameInfo tuples)
 
@@ -59,13 +59,15 @@ def format_stack(frames, style='plaintext', source_lines=5,
                                       show_signature=show_signature,
                                       show_vals=show_vals,
                                       truncate_vals=truncate_vals,
+                                      line_wrap=line_wrap,
                                       suppressed_paths=suppressed_paths)
 
     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)
 
     frame_msgs = []

stackprinter/frame_formatting.py

@@ -22,7 +22,8 @@ class FrameFormatter():
     val_tpl = ' ' * var_indent + "%s = %s\n"
 
     def __init__(self, source_lines=5, source_lines_after=1,
-                 show_signature=True, show_vals='like_source', truncate_vals=500,
+                 show_signature=True, show_vals='like_source',
+                 truncate_vals=500, line_wrap: int = 60,
                  suppressed_paths=None):
         """
         Formatter for single frames.
@@ -55,6 +56,10 @@ def __init__(self, source_lines=5, source_lines_after=1,
         truncate_vals: int (default 500)
             Maximum number of characters to be used for each variable value
 
+        line_wrap: int (default 60)
+            insert linebreaks after this nr of characters, use 0 to never insert
+            a linebreak
+
         suppressed_paths: list of regex patterns
             Set less verbose formatting for frames whose code lives in certain paths
             (e.g. library code). Files whose path matches any of the given regex
@@ -82,7 +87,8 @@ def __init__(self, source_lines=5, source_lines_after=1,
         self.show_signature = show_signature
         self.show_vals = show_vals
         self.truncate_vals = truncate_vals
-        self.suppressed_paths = suppressed_paths  # already compile regexes and make a `match` callable?
+        self.line_wrap = line_wrap
+        self.suppressed_paths = suppressed_paths
 
     def __call__(self, frame, lineno=None):
         """
@@ -174,7 +180,8 @@ def _format_assignments(self, assignments):
         for name, value in assignments.items():
             val_str = format_value(value,
                                    indent=len(name) + self.var_indent + 3,
-                                   truncation=self.truncate_vals)
+                                   truncation=self.truncate_vals,
+                                   wrap=self.line_wrap)
             assign_str = self.val_tpl % (name, val_str)
             msgs.append(assign_str)
         if len(msgs) > 0:
@@ -329,7 +336,8 @@ def _format_assignments(self, assignments, colormap):
         for name, value in assignments.items():
             val_str = format_value(value,
                                    indent=len(name) + self.var_indent + 3,
-                                   truncation=self.truncate_vals)
+                                   truncation=self.truncate_vals,
+                                   wrap=self.line_wrap)
             assign_str = self.val_tpl % (name, val_str)
             hue, sat, val, bold = colormap.get(name, self.colors['var_invisible'])
             clr_str = get_ansi_tpl(hue, sat, val, bold) % assign_str

stackprinter/prettyprinting.py

@@ -34,7 +34,7 @@ def format_value(value, indent=0, truncation=None, wrap=60,
         cut after this nr of characters
 
     wrap: int
-        insert linebreaks after this nr of characters
+        insert linebreaks after this nr of characters, use 0 to never add a linebreak
 
     max_depth: int
         max repeated calls to this function when formatting container types
@@ -241,6 +241,8 @@ def truncate(string, n):
 
 
 def wrap_lines(string, max_width=80):
+    if not max_width or max_width <= 0:
+        return string
 
     def wrap(lines):
         for l in lines: