fix bug in dedent

Author: Ken Kundert

inform/inform.py

@@ -818,10 +818,10 @@ def dedent(text, strip_nl=None, *, bolm=None, wrap=False):
 
     strip_nl = None:
         strip_nl is used to strip off a single leading or trailing newline.
-        strip_nl may be None, 'l', 't', or 'b' representing neither,
-        leading, trailing, or both. True may also be passed, which is equivalent to 'b'.
-        Can also use 's' (start) as synonym for 'l' and 'e' (end) as
-        synonym for 't'.
+        strip_nl may be None, 'l', 't', or 'b' representing neither, leading,
+        trailing, or both. True may also be passed, which is equivalent to 'b'.
+        Can also use 's' (start) as synonym for 'l' and 'e' (end) or 'r' (right)
+        as synonym for 't'.
 
     wrap (bool or int):
         If true the string is wrapped using a width of 70. If an integer value
@@ -879,11 +879,11 @@ def dedent(text, strip_nl=None, *, bolm=None, wrap=False):
             dedented = '\n' + ' '*len(bolm) + dedented[l:]
 
     # remove leading newline if desired
-    if strip_nl in ['s', 'b', 'l', 'True'] and dedented[0] == '\n':
+    if strip_nl in ['s', 'b', 'l', True] and dedented[:1] == '\n':
         dedented = dedented[1:]
 
     # remove trailing newline if desired
-    if strip_nl in ['e', 'b', 't', 'True'] and dedented[-1] == '\n':
+    if strip_nl in ['e', 'b', 't', 'r', True] and dedented[-1:] == '\n':
         dedented = dedented[:-1]
 
     # wrap text to desired width

tests/test_inform.py

@@ -861,97 +861,6 @@ def test_stripy():
             {expected}
         ''').strip().format(expected=expected)
 
-def test_tree():
-    with messenger() as (msg, stdout, stderr, logfile):
-        data = data = dict(
-            str = 'text',
-            mlstr = dedent("""
-                    line 1
-                    line 2
-                """).strip(),
-            alist = [1, 2, 3],
-            adict = {1: 'one', 2: 'two', 3: 'three', 'four': None}
-        )
-        result = tree(data, squeeze=True)
-        expected = dedent('''
-            str: text
-            mlstr: line 1
-                   line 2
-            alist
-            ├── 1
-            ├── 2
-            └── 3
-            adict
-            ├── 1: one
-            ├── 2: two
-            ├── 3: three
-            └── four
-        ''').strip()
-        assert result == expected
-
-        result = tree(data)
-        expected = dedent('''
-            str
-            └── text
-            mlstr
-            └── line 1
-                line 2
-            alist
-            ├── 1
-            ├── 2
-            └── 3
-            adict
-            ├── 1
-            │   └── one
-            ├── 2
-            │   └── two
-            ├── 3
-            │   └── three
-            └── four
-        ''').strip()
-        assert result == expected
-
-        result = tree(dict(root=data), squeeze=True)
-        expected = dedent('''
-            root
-            ├── str: text
-            ├── mlstr: line 1
-            │          line 2
-            ├── alist
-            │   ├── 1
-            │   ├── 2
-            │   └── 3
-            └── adict
-                ├── 1: one
-                ├── 2: two
-                ├── 3: three
-                └── four
-        ''').strip()
-        assert result == expected
-
-        result = tree(dict(root=data))
-        expected = dedent('''
-            root
-            ├── str
-            │   └── text
-            ├── mlstr
-            │   └── line 1
-            │       line 2
-            ├── alist
-            │   ├── 1
-            │   ├── 2
-            │   └── 3
-            └── adict
-                ├── 1
-                │   └── one
-                ├── 2
-                │   └── two
-                ├── 3
-                │   └── three
-                └── four
-        ''').strip()
-        assert result == expected
-
 def test_capsys_out(capsys):
     output('hello world')
     cap = capsys.readouterr()

tests/test_utilities.py

@@ -5,7 +5,7 @@
     cull, dedent, display, done, error, fatal, fmt, full_stop, indent, Inform,
     is_collection, is_iterable, is_mapping, is_str, join, get_prog_name,
     get_informer, narrate, os_error, output, plural, render, terminate,
-    title_case, truth, warn, ddd, ppp, sss, vvv, ProgressBar, parse_range,
+    title_case, tree, truth, warn, ddd, ppp, sss, vvv, ProgressBar, parse_range,
     format_range
 )
 from textwrap import dedent as tw_dedent
@@ -1810,9 +1810,26 @@ def test_oblong():
         assert render_bar(0.66, 25) == '████████████████▌'
 
 
-@parametrize('given', ['a', '\na', 'a\n', '\na\n', '\na\nb\n'])
+@parametrize('given', ['', 'a', '\na', 'a\n', '\na\n', '\na\nb\n'])
 def test_dedent_compatibility(given):
      assert dedent(given) == tw_dedent(given)
+     assert dedent(given, strip_nl='b') == tw_dedent(given).strip()
+     assert dedent(given, strip_nl='l') == tw_dedent(given).lstrip()
+     assert dedent(given, strip_nl='t') == tw_dedent(given).rstrip()
+     assert dedent(given, strip_nl='s') == tw_dedent(given).lstrip()
+     assert dedent(given, strip_nl='e') == tw_dedent(given).rstrip()
+     assert dedent(given, strip_nl='r') == tw_dedent(given).rstrip()
+     assert dedent(given, strip_nl=True) == tw_dedent(given).strip()
+     assert dedent(given, strip_nl=False) == tw_dedent(given)
+
+     given = '''
+         ◊   Diaspar
+             Lys
+     '''
+     assert dedent(given, bolm='◊', strip_nl='b') == "    Diaspar\n    Lys"
+
+     given = '\nDiaspar\nLys\n'
+     assert dedent(given, strip_nl='b', wrap=True) == "Diaspar Lys"
 
 
 def test_render_tuples():
@@ -1821,6 +1838,96 @@ def test_render_tuples():
      assert render((0,1)) == '(0, 1)'
      assert render((0,1,2)) == '(0, 1, 2)'
 
+def test_tree():
+    data = data = dict(
+        str = 'text',
+        mlstr = dedent("""
+                line 1
+                line 2
+            """).strip(),
+        alist = [1, 2, 3],
+        adict = {1: 'one', 2: 'two', 3: 'three', 'four': None}
+    )
+    result = tree(data, squeeze=True)
+    expected = dedent('''
+        str: text
+        mlstr: line 1
+               line 2
+        alist
+        ├── 1
+        ├── 2
+        └── 3
+        adict
+        ├── 1: one
+        ├── 2: two
+        ├── 3: three
+        └── four
+    ''').strip()
+    assert result == expected
+
+    result = tree(data)
+    expected = dedent('''
+        str
+        └── text
+        mlstr
+        └── line 1
+            line 2
+        alist
+        ├── 1
+        ├── 2
+        └── 3
+        adict
+        ├── 1
+        │   └── one
+        ├── 2
+        │   └── two
+        ├── 3
+        │   └── three
+        └── four
+    ''').strip()
+    assert result == expected
+
+    result = tree(dict(root=data), squeeze=True)
+    expected = dedent('''
+        root
+        ├── str: text
+        ├── mlstr: line 1
+        │          line 2
+        ├── alist
+        │   ├── 1
+        │   ├── 2
+        │   └── 3
+        └── adict
+            ├── 1: one
+            ├── 2: two
+            ├── 3: three
+            └── four
+    ''').strip()
+    assert result == expected
+
+    result = tree(dict(root=data))
+    expected = dedent('''
+        root
+        ├── str
+        │   └── text
+        ├── mlstr
+        │   └── line 1
+        │       line 2
+        ├── alist
+        │   ├── 1
+        │   ├── 2
+        │   └── 3
+        └── adict
+            ├── 1
+            │   └── one
+            ├── 2
+            │   └── two
+            ├── 3
+            │   └── three
+            └── four
+    ''').strip()
+    assert result == expected
+
 
 if __name__ == '__main__':
     # As a debugging aid allow the tests to be run on their own, outside pytest.