Merge branch 'main' into 1627-silence-settable

Author: tleonhardt

CHANGELOG.md

@@ -81,9 +81,8 @@ prompt is displayed.
     - `cmd2` no longer sets a default title for a subparsers group. If you desire a title, you will
       need to pass one in like this `parser.add_subparsers(title="subcommands")`. This is standard
       `argparse` behavior.
-    - Added `HelpFormatterRenderable` protocol and `HelpContent` type alias to support context-aware
-      help content in `argparse`.
-    - `TextGroup` now implements `HelpFormatterRenderable`.
+    - `TextGroup` now implements `HelpFormatterRenderable` (see Enhancements section below for more
+      details).
         - Removed `formatter_creator` parameter from `TextGroup.__init__()`.
         - Removed `Cmd2ArgumentParser.create_text_group()` method.
     - `argparse` and `Rich` integration refactoring:
@@ -145,6 +144,8 @@ prompt is displayed.
       full type hints and IDE autocompletion for `self._cmd` without needing to override and cast
       the property.
     - Added `traceback_kwargs` attribute to allow customization of Rich-based tracebacks.
+    - Added `HelpFormatterRenderable` protocol and `HelpContent` type alias to support context-aware
+      help content in `argparse`.
     - The `print()` function available in a `pyscript` writes to `self.stdout` and respects the
       `allow_style` setting. It also supports printing `Rich` objects.
     - Added `Cmd2ArgumentParser.output_to()` context manager to temporarily set the output stream

cmd2/cmd2.py

@@ -1240,20 +1240,20 @@ def always_prefix_settables(self) -> bool:
         return self._always_prefix_settables
 
     @always_prefix_settables.setter
-    def always_prefix_settables(self, new_value: bool) -> None:
+    def always_prefix_settables(self, value: bool) -> None:
         """Set whether CommandSet settable values should always be prefixed.
 
-        :param new_value: True if CommandSet settable values should always be prefixed. False if not.
+        :param value: True if CommandSet settable values should always be prefixed. False if not.
         :raises ValueError: If a registered CommandSet does not have a defined prefix
         """
-        if not self._always_prefix_settables and new_value:
+        if not self._always_prefix_settables and value:
             for cmd_set in self._installed_command_sets:
                 if not cmd_set.settable_prefix:
                     raise ValueError(
                         f"Cannot force settable prefixes. CommandSet {cmd_set.__class__.__name__} does "
                         f"not have a settable prefix defined."
                     )
-        self._always_prefix_settables = new_value
+        self._always_prefix_settables = value
 
     @property
     def settables(self) -> Mapping[str, Settable]:
@@ -1357,14 +1357,20 @@ def allow_style(self) -> ru.AllowStyle:
         return ru.ALLOW_STYLE
 
     @allow_style.setter
-    def allow_style(self, new_val: ru.AllowStyle) -> None:
+    def allow_style(self, value: ru.AllowStyle) -> None:
         """Setter property needed to support do_set when it updates allow_style."""
-        ru.ALLOW_STYLE = new_val
+        ru.ALLOW_STYLE = value
 
     @property
     def traceback_show_locals(self) -> bool:
         """Property needed to support do_set when it reads traceback_show_locals."""
-        return cast(bool, self.traceback_kwargs.get("show_locals", False))
+        if "show_locals" in self.traceback_kwargs:
+            return cast(bool, self.traceback_kwargs["show_locals"])
+
+        # If setting is not present, then return its default value.
+        traceback_sig = inspect.signature(Traceback.__init__)
+        show_locals = traceback_sig.parameters["show_locals"].default
+        return cast(bool, show_locals)
 
     @traceback_show_locals.setter
     def traceback_show_locals(self, value: bool) -> None:

mkdocs.yml

@@ -125,14 +125,15 @@ markdown_extensions:
 
 # Validation
 validation:
-  nav:
-    omitted_files: info
-    not_found: warn
-    absolute_links: info
-  links:
-    not_found: warn
-    absolute_links: ignore
-    unrecognized_links: info
+  invalid_link_anchors: true
+  invalid_links: true
+  shadowed_definitions: true
+  shadowed_footnotes: true
+  unresolved_footnotes: true
+  # bug with mkdocstrings autorefs: https://github.com/zensical/zensical/issues/600
+  unresolved_references: false
+  unused_definitions: true
+  unused_footnotes: true
 
 not_in_nav: |
   **/download/*.md

tests/test_cmd2.py

@@ -243,15 +243,22 @@ def test_set_allow_style(base_app, new_val, is_valid, expected) -> None:
 
 
 def test_set_traceback_show_locals(base_app: cmd2.Cmd) -> None:
-    # Use the set command to alter traceback_show_locals
+    """Test the set command for reading and setting traceback_show_locals."""
+    import inspect
+
+    from rich.traceback import Traceback
+
+    # Get Traceback's default value for "show_locals"
+    traceback_sig = inspect.signature(Traceback.__init__)
+    default_val = traceback_sig.parameters["show_locals"].default
 
     # Clear any existing value
     base_app.traceback_kwargs.pop("show_locals", None)
     assert "show_locals" not in base_app.traceback_kwargs
 
-    # Test that we receive a default value of False if not present
+    # Test that we receive the default value if not present
     orig_val = base_app.traceback_show_locals
-    assert orig_val is False
+    assert orig_val is default_val
     assert "show_locals" not in base_app.traceback_kwargs
 
     # Test setting it