Fixed ValueError caused when passing Cmd.columnize() strings wider than display_width.

Author: kmvanbrunt

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.4.3 (TBD, 2023)
+* Bug Fixes
+  * Fixed ValueError caused when passing `Cmd.columnize()` strings wider than `display_width`.
+* Enhancements
+  * Renamed `utils.str_to_bool()` -> `utils.to_bool()`.
+  * Enhanced `utils.to_bool()` so that it accepts and converts `bool`, `int`, and `float` in addition to `str`.
+
 ## 2.4.2 (July 13, 2022)
 * Enhancements
   * Updated argparse decorator to remove annotations when the docstring is used for a command's help text.

cmd2/cmd2.py

@@ -3688,9 +3688,10 @@ def columnize(self, str_list: Optional[List[str]], display_width: int = 80) -> N
             if totwidth <= display_width:
                 break
         else:
+            # The output is wider than display_width. Print 1 column with each string on its own row.
             nrows = len(str_list)
             ncols = 1
-            colwidths = [0]
+            colwidths = [1]
         for row in range(nrows):
             texts = []
             for col in range(ncols):

tests/test_cmd2.py

@@ -1454,7 +1454,7 @@ def test_select_eof(select_app, monkeypatch):
     assert read_input_mock.call_count == 2
 
 
-def test_select_ctrl_c(outsim_app, monkeypatch, capsys):
+def test_select_ctrl_c(outsim_app, monkeypatch):
     # Ctrl-C during select prints ^C and raises a KeyboardInterrupt
     read_input_mock = mock.MagicMock(name='read_input', side_effect=KeyboardInterrupt)
     monkeypatch.setattr("cmd2.Cmd.read_input", read_input_mock)
@@ -2866,3 +2866,12 @@ def test_transcripts_at_init():
     transcript_files = ['foo', 'bar']
     app = cmd2.Cmd(allow_cli_args=False, transcript_files=transcript_files)
     assert app._transcript_files == transcript_files
+
+
+def test_columnize_too_wide(outsim_app):
+    """Test calling columnize with output that wider than display_width"""
+    str_list = ["way too wide", "much wider than the first"]
+    outsim_app.columnize(str_list, display_width=5)
+
+    expected = "\n".join(str_list) + "\n"
+    assert outsim_app.stdout.getvalue() == expected