Made traceback_width a Settable.

Author: kmvanbrunt

cmd2/cmd2.py

@@ -1332,7 +1332,21 @@ def allow_style_type(value: str) -> ru.AllowStyle:
         )
         self.add_settable(Settable("debug", bool, "Show full traceback on exception", self))
         self.add_settable(Settable("echo", bool, "Echo command issued into output", self))
-        self.add_settable(Settable("editor", str, "Program used by 'edit'", self))
+
+        editor_description = Text.assemble(
+            "Program used by ",
+            ("'edit'", Style(bold=True)),
+            " command",
+        )
+        self.add_settable(
+            Settable(
+                "editor",
+                str,
+                ru.rich_text_to_string(editor_description),
+                self,
+            )
+        )
+
         self.add_settable(
             Settable(
                 "max_completion_table_items",
@@ -1354,6 +1368,20 @@ def allow_style_type(value: str) -> ru.AllowStyle:
         self.add_settable(Settable("timing", bool, "Report execution times", self))
         self.add_settable(Settable("traceback_show_locals", bool, "Display local variables in tracebacks", self))
 
+        traceback_width_description = Text.assemble(
+            "Maximum display width for tracebacks. Set to ",
+            ("None", Style(bold=True)),
+            " (case-insensitive) to fill entire terminal width.",
+        )
+        self.add_settable(
+            Settable(
+                "traceback_width",
+                utils.optional_int,
+                ru.rich_text_to_string(traceback_width_description),
+                self,
+            )
+        )
+
     @property
     def allow_style(self) -> ru.AllowStyle:
         """Property needed to support do_set when it reads allow_style."""
@@ -1380,6 +1408,22 @@ def traceback_show_locals(self, value: bool) -> None:
         """Setter property needed to support do_set when it updates traceback_show_locals."""
         self.traceback_kwargs["show_locals"] = value
 
+    @property
+    def traceback_width(self) -> int | None:
+        """Property needed to support do_set when it reads traceback_width."""
+        if "width" in self.traceback_kwargs:
+            return cast(int | None, self.traceback_kwargs["width"])
+
+        # If setting is not present, then return its default value.
+        traceback_sig = inspect.signature(Traceback.__init__)
+        width = traceback_sig.parameters["width"].default
+        return cast(int | None, width)
+
+    @traceback_width.setter
+    def traceback_width(self, value: int | None) -> None:
+        """Setter property needed to support do_set when it updates traceback_width."""
+        self.traceback_kwargs["width"] = value
+
     @property
     def visible_prompt(self) -> str:
         """Read-only property to get the visible prompt with any ANSI style sequences stripped.

cmd2/pt_utils.py

@@ -175,7 +175,7 @@ def get_completions(self, document: Document, _complete_event: object) -> Iterab
             print_formatted_text(pt_filter_style("\n" + capture.get()))
 
         if not completions:
-            # # Print hint if present
+            # Print hint if present
             if completions.hint:
                 print_formatted_text(pt_filter_style(completions.hint))
             return

cmd2/utils.py

@@ -64,6 +64,23 @@ def to_bool(val: Any) -> bool:
     return bool(val)
 
 
+def optional_int(val: Any) -> int | None:
+    """Convert a value to an integer or None if it's "None" (case-insensitive).
+
+    :param val: value being converted
+    :return: int or None
+    :raises ValueError: if the value is not "None" and cannot be converted to an integer
+    """
+    if val is None:
+        return None
+    if isinstance(val, str) and val.lower() == "none":
+        return None
+    try:
+        return int(val)
+    except (ValueError, TypeError):
+        raise ValueError("must be an integer or None (case-insensitive)") from None
+
+
 class Settable:
     """Used to configure an attribute to be settable via the set command in the CLI."""
 

tests/test_cmd2.py

@@ -267,6 +267,51 @@ def test_set_traceback_show_locals(base_app: cmd2.Cmd) -> None:
     assert base_app.traceback_show_locals is new_val
     assert base_app.traceback_kwargs["show_locals"] is new_val
 
+    # Test invalid input
+    _out, err = run_cmd(base_app, "set traceback_show_locals invalid")
+    assert base_app.last_result is False
+    assert "must be True or False (case-insensitive)" in err[0]
+
+
+def test_set_traceback_width(base_app: cmd2.Cmd) -> None:
+    """Test the set command for reading and setting traceback_width."""
+
+    import inspect
+
+    from rich.traceback import Traceback
+
+    # Get Traceback's default value for "width"
+    traceback_sig = inspect.signature(Traceback.__init__)
+    default_val = traceback_sig.parameters["width"].default
+
+    # Clear any existing value
+    base_app.traceback_kwargs.pop("width", None)
+    assert "width" not in base_app.traceback_kwargs
+
+    # Test that we receive the default value if not present
+    orig_val = base_app.traceback_width
+    assert orig_val == default_val
+    assert "width" not in base_app.traceback_kwargs
+
+    # Test setting it to an integer (handling case where orig_val is None)
+    new_val = (orig_val or 0) + 100
+    run_cmd(base_app, f"set traceback_width {new_val}")
+    assert base_app.traceback_width == new_val
+    assert base_app.traceback_kwargs["width"] == new_val
+
+    # Test setting to "None" (case-insensitive)
+    run_cmd(base_app, "set traceback_width None")
+    assert base_app.traceback_width is None
+    assert base_app.traceback_kwargs["width"] is None  # type: ignore[unreachable]
+
+    run_cmd(base_app, "set traceback_width none")
+    assert base_app.traceback_width is None
+
+    # Test invalid input
+    _out, err = run_cmd(base_app, "set traceback_width invalid")
+    assert base_app.last_result is False
+    assert "must be an integer or None" in err[0]
+
 
 def test_set_with_choices(base_app) -> None:
     """Test choices validation of Settables"""

tests/test_utils.py

@@ -285,6 +285,28 @@ def test_to_bool_float() -> None:
     assert not cu.to_bool(0)
 
 
+def test_optional_int_none() -> None:
+    assert cu.optional_int(None) is None
+    assert cu.optional_int("none") is None
+    assert cu.optional_int("None") is None
+    assert cu.optional_int("nOnE") is None
+
+
+def test_optional_int_int() -> None:
+    assert cu.optional_int(5) == 5
+    assert cu.optional_int("5") == 5
+    assert cu.optional_int("-10") == -10
+
+
+def test_optional_int_invalid() -> None:
+    with pytest.raises(ValueError, match="must be an integer or None"):
+        cu.optional_int("abc")
+    with pytest.raises(ValueError, match="must be an integer or None"):
+        cu.optional_int("3.14")
+    with pytest.raises(ValueError, match="must be an integer or None"):
+        cu.optional_int([])
+
+
 def test_find_editor_specified() -> None:
     expected_editor = os.path.join("fake_dir", "editor")
     with mock.patch.dict(os.environ, {"EDITOR": expected_editor}):