always use multiline output

Author: samuelcolvin

devtools/debug.py

@@ -57,10 +57,11 @@ def __init__(self, *, filename: str, lineno: int, frame: str, arguments: List[De
 
     def __str__(self) -> str:
         template = '{s.filename}:{s.lineno} {s.frame}'
-        if len(self.arguments) == 1:
-            return (template + ': {a}').format(s=self, a=self.arguments[0])
-        else:
-            return (template + '\n  {a}').format(s=self, a='\n  '.join(str(a) for a in self.arguments))
+        # turns out single line output is ugly
+        # if len(self.arguments) == 1:
+        #     return (template + ': {a}').format(s=self, a=self.arguments[0])
+        # else:
+        return (template + '\n  {a}').format(s=self, a='\n  '.join(str(a) for a in self.arguments))
 
     def __repr__(self) -> str:
         arguments = ' '.join(str(a) for a in self.arguments)
@@ -75,7 +76,9 @@ class Debug:
         ast.DictComp, ast.ListComp, ast.SetComp, ast.GeneratorExp
     )
 
-    def __init__(self, *, warnings: Optional[bool]=None, frame_context_length: int=50):
+    def __init__(self, *,
+                 warnings: Optional[bool]=None,
+                 frame_context_length: int=50):
         if warnings is None:
             self._warnings = env_true('PY_DEVTOOLS_WARNINGS', 'TRUE')
         else:

tests/test_expr_render.py

@@ -16,7 +16,8 @@ def test_simple():
     s = re.sub(':\d{2,}', ':<line no>', str(v))
     # print(s)
     assert (
-        'tests/test_expr_render.py:<line no> test_simple: len(a) = 3 (int)'
+        'tests/test_expr_render.py:<line no> test_simple\n'
+        '  len(a) = 3 (int)'
     ) == s
 
 
@@ -59,7 +60,8 @@ def test_newline():
     s = re.sub(':\d{2,}', ':<line no>', str(v))
     # print(s)
     assert (
-        'tests/test_expr_render.py:<line no> test_newline: foobar(1, 2, 3) = 6 (int)'
+        'tests/test_expr_render.py:<line no> test_newline\n'
+        '  foobar(1, 2, 3) = 6 (int)'
     ) == s
 
 
@@ -70,7 +72,8 @@ def test_trailing_bracket():
     s = re.sub(':\d{2,}', ':<line no>', str(v))
     # print(s)
     assert (
-        'tests/test_expr_render.py:<line no> test_trailing_bracket: foobar(1, 2, 3) = 6 (int)'
+        'tests/test_expr_render.py:<line no> test_trailing_bracket\n'
+        '  foobar(1, 2, 3) = 6 (int)'
     ) == s
 
 
@@ -83,7 +86,8 @@ def test_multiline():
     s = re.sub(':\d{2,}', ':<line no>', str(v))
     # print(s)
     assert (
-        'tests/test_expr_render.py:<line no> test_multiline: foobar(1, 2, 3) = 6 (int)'
+        'tests/test_expr_render.py:<line no> test_multiline\n'
+        '  foobar(1, 2, 3) = 6 (int)'
     ) == s
 
 
@@ -94,7 +98,8 @@ def test_multiline_trailing_bracket():
     s = re.sub(':\d{2,}', ':<line no>', str(v))
     # print(s)
     assert (
-        'tests/test_expr_render.py:<line no> test_multiline_trailing_bracket: foobar(1, 2, 3 ) = 6 (int)'
+        'tests/test_expr_render.py:<line no> test_multiline_trailing_bracket\n'
+        '  foobar(1, 2, 3 ) = 6 (int)'
     ) == s
 
 
@@ -139,7 +144,7 @@ def test_multiple_trailing_lines():
     )
     s = re.sub(':\d{2,}', ':<line no>', str(v))
     assert (
-        'tests/test_expr_render.py:<line no> test_multiple_trailing_lines: foobar( 1, 2, 3 ) = 6 (int)'
+        'tests/test_expr_render.py:<line no> test_multiple_trailing_lines\n  foobar( 1, 2, 3 ) = 6 (int)'
     ) == s
 
 
@@ -165,7 +170,7 @@ def test_syntax_warning():
     assert '-1\n"' in str(warning.message)
     s = re.sub(':\d{2,}', ':<line no>', str(v))
     assert (
-        'tests/test_expr_render.py:<line no> test_syntax_warning: 1 (int)'
+        'tests/test_expr_render.py:<line no> test_syntax_warning\n  1 (int)'
     ) == s
 
 
@@ -184,5 +189,5 @@ def test_no_syntax_warning():
                 )
             )
         )
-        assert 'test_no_syntax_warning: 1 (int)' in str(v)
+        assert 'test_no_syntax_warning\n  1 (int)' in str(v)
     assert len(warning_checker) == 0

tests/test_main.py

@@ -55,7 +55,8 @@ def test_func(v):
     assert p.returncode == 0, (p.stderr, p.stdout)
     assert p.stdout.replace(str(f), '/path/to/test.py') == (
         'running debug...\n'
-        '/path/to/test.py:8 <module>: foobar = "hello world" (str) len=11\n'
+        '/path/to/test.py:8 <module>\n'
+        '  foobar = "hello world" (str) len=11\n'
         '/path/to/test.py:4 test_func\n'
         '  "in test func" (str) len=12\n'
         '  v = 42 (int)\n'
@@ -68,7 +69,7 @@ def test_odd_path(mocker):
     mocked_relative_to = mocker.patch('pathlib.Path.relative_to')
     mocked_relative_to.side_effect = ValueError()
     v = debug.format('test')
-    assert re.search('/.*?/test_main.py:\d{2,} test_odd_path: "test" \(str\) len=4', str(v)), v
+    assert re.search('/.*?/test_main.py:\d{2,} test_odd_path\n  "test" \(str\) len=4', str(v)), v
 
 
 def test_small_call_frame():
@@ -151,23 +152,23 @@ class Bar:
 
     b = Bar()
     v = debug.format(b.y.x)
-    assert 'test_attributes: b.y.x = 1 (int)' in str(v)
+    assert 'test_attributes\n  b.y.x = 1 (int)' in str(v)
 
 
 def test_eval():
     with pytest.warns(RuntimeWarning):
         v = eval('debug.format(1)')
 
-    assert str(v) == '<string>:1 <module>: 1 (int)'
+    assert str(v) == '<string>:1 <module>\n  1 (int)'
 
 
 def test_warnings_disabled():
     debug_ = Debug(warnings=False)
     with pytest.warns(None) as warnings:
         v1 = eval('debug_.format(1)')
-        assert str(v1) == '<string>:1 <module>: 1 (int)'
+        assert str(v1) == '<string>:1 <module>\n  1 (int)'
         v2 = debug_.format(1)
-        assert 'test_warnings_disabled: 1 (int)' in str(v2)
+        assert 'test_warnings_disabled\n  1 (int)' in str(v2)
     assert len(warnings) == 0