fix rendering errors (#31)

* kwargs, fix #28

* support for commented code

* fix tests for py3.5

* catch more errors, fix #21

* fix tests

* fix timer tests

Author: samuelcolvin

devtools/debug.py

@@ -181,7 +181,14 @@ def _args_inspection_failed(self, args, kwargs):
 
     def _process_args(self, func_ast, code_lines, args, kwargs) -> Generator[DebugArgument, None, None]:  # noqa: C901
         arg_offsets = list(self._get_offsets(func_ast))
-        for arg, ast_node, i in zip(args, func_ast.args, range(1000)):
+        for i, arg in enumerate(args):
+            try:
+                ast_node = func_ast.args[i]
+            except IndexError:  # pragma: no cover
+                # happens when code has been commented out and there are fewer func_ast args than real args
+                yield self.output_class.arg_class(arg)
+                continue
+
             if isinstance(ast_node, ast.Name):
                 yield self.output_class.arg_class(arg, name=ast_node.id)
             elif isinstance(ast_node, self.complex_nodes):
@@ -231,7 +238,7 @@ def _parse_code(
         tail_index = call_frame.index
         try:
             func_ast = self._wrap_parse(code, filename)
-        except SyntaxError as e1:
+        except (SyntaxError, AttributeError) as e1:
             # if the trailing bracket(s) of the function is/are on a new line eg.
             # debug(
             #     foo, bar,
@@ -242,13 +249,13 @@ def _parse_code(
                 code = dedent(''.join(call_lines + extra_lines))
                 try:
                     func_ast = self._wrap_parse(code, filename)
-                except SyntaxError:
+                except (SyntaxError, AttributeError):
                     pass
                 else:
                     break
 
             if not func_ast:
-                return None, None, lineno, 'error passing code. Error: {}'.format(e1)
+                return None, None, lineno, 'error passing code, {0.__class__.__name__}: {0}'.format(e1)
 
         if not isinstance(func_ast, ast.Call):
             return None, None, lineno, 'error passing code, found {} not Call'.format(func_ast.__class__)
@@ -277,7 +284,7 @@ def _get_offsets(func_ast):
                 start_col -= 1
             yield start_line, start_col
         for kw in func_ast.keywords:
-            yield kw.value.lineno - 2, kw.value.col_offset - len(kw.arg) - 2
+            yield kw.value.lineno - 2, kw.value.col_offset - 2 - (len(kw.arg) if kw.arg else 0)
 
 
 debug = Debug()

devtools/version.py

@@ -2,4 +2,4 @@
 
 __all__ = ['VERSION']
 
-VERSION = StrictVersion('0.3.0')
+VERSION = StrictVersion('0.4.0')

tests/test_expr_render.py

@@ -182,8 +182,8 @@ def test_syntax_warning():
     )
     # check only the original code is included in the warning
     s = re.sub(r':\d{2,}', ':<line no>', str(v))
-    assert s.startswith('tests/test_expr_render.py:<line no> test_syntax_warning (error passing code. '
-                        'Error: unexpected EOF while')
+    assert s.startswith('tests/test_expr_render.py:<line no> test_syntax_warning (error passing code, '
+                        'SyntaxError: unexpected EOF')
 
 
 def test_no_syntax_warning():

tests/test_main.py

@@ -228,3 +228,14 @@ def test_breakpoint(mocker):
     mocked_set_trace = mocker.patch('pdb.Pdb.set_trace')
     debug.breakpoint()
     assert mocked_set_trace.called
+
+
+def test_starred_kwargs():
+    v = {'foo': 1, 'bar': 2}
+    v = debug.format(**v)
+    s = re.sub(r':\d{2,}', ':<line no>', v.str())
+    assert set(s.split('\n')) == {
+        'tests/test_main.py:<line no> test_starred_kwargs',
+        '    foo: 1 (int)',
+        '    bar: 2 (int)',
+    }

tests/test_timer.py

@@ -24,11 +24,11 @@ def test_multiple():
             sleep(i)
     t.summary()
     v = f.getvalue()
-    assert v == (
-        '0.001: 0.001s elapsed\n'
-        '0.002: 0.002s elapsed\n'
-        '0.003: 0.003s elapsed\n'
-        '3 times: mean=0.002s stdev=0.001s min=0.001s max=0.003s\n'
+    assert re.sub(r'0\.00\d', '0.00X', v) == (
+        '0.00X: 0.00Xs elapsed\n'
+        '0.00X: 0.00Xs elapsed\n'
+        '0.00X: 0.00Xs elapsed\n'
+        '3 times: mean=0.00Xs stdev=0.00Xs min=0.00Xs max=0.00Xs\n'
     )