test(pt_utils): achieve 100% coverage for pt_utils.py

Added unit tests for completion hints, hint tables, custom delimiter logic, and CompletionItem metadata handling in pt_utils.py. Achieved 100% code coverage (excluding TYPE_CHECKING blocks) and modernized existing tests to use real Document objects.

Author: tleonhardt

tests/test_pt_utils.py

@@ -1,12 +1,13 @@
 """Unit tests for cmd2/pt_utils.py"""
 
-from typing import cast
+from typing import Any, cast
 from unittest.mock import Mock
 
 import pytest
 from prompt_toolkit.document import Document
 
 from cmd2 import pt_utils, utils
+from cmd2.argparse_custom import CompletionItem
 from cmd2.history import HistoryItem
 from cmd2.parsing import Statement
 
@@ -20,6 +21,8 @@ def __init__(self):
         self.history = []
         self.formatted_completions = ''
         self.completion_hint = ''
+        self.statement_parser = Mock()
+        self.statement_parser.terminators = [';']
 
 
 @pytest.fixture
@@ -30,16 +33,13 @@ def mock_cmd_app():
 class TestCmd2Completer:
     def test_get_completions_basic(self, mock_cmd_app):
         """Test basic completion without display matches."""
-        completer = pt_utils.Cmd2Completer(cast(any, mock_cmd_app))
+        completer = pt_utils.Cmd2Completer(cast(Any, mock_cmd_app))
 
         # Setup document
         text = "foo"
         line = "command foo"
         cursor_position = len(line)
-        document = Mock(spec=Document)
-        document.get_word_before_cursor.return_value = text
-        document.text = line
-        document.cursor_position = cursor_position
+        document = Document(line, cursor_position=cursor_position)
 
         # Setup matches
         mock_cmd_app.completion_matches = ["foobar", "food"]
@@ -65,15 +65,11 @@ def test_get_completions_basic(self, mock_cmd_app):
 
     def test_get_completions_with_display_matches(self, mock_cmd_app):
         """Test completion with display matches."""
-        completer = pt_utils.Cmd2Completer(cast(any, mock_cmd_app))
+        completer = pt_utils.Cmd2Completer(cast(Any, mock_cmd_app))
 
         # Setup document
-        text = "f"
         line = "f"
-        document = Mock(spec=Document)
-        document.get_word_before_cursor.return_value = text
-        document.text = line
-        document.cursor_position = 1
+        document = Document(line, cursor_position=1)
 
         # Setup matches
         mock_cmd_app.completion_matches = ["foo", "bar"]
@@ -92,12 +88,9 @@ def test_get_completions_with_display_matches(self, mock_cmd_app):
 
     def test_get_completions_mismatched_display_matches(self, mock_cmd_app):
         """Test completion when display_matches length doesn't match completion_matches."""
-        completer = pt_utils.Cmd2Completer(cast(any, mock_cmd_app))
+        completer = pt_utils.Cmd2Completer(cast(Any, mock_cmd_app))
 
-        document = Mock(spec=Document)
-        document.get_word_before_cursor.return_value = ""
-        document.text = ""
-        document.cursor_position = 0
+        document = Document("", cursor_position=0)
 
         mock_cmd_app.completion_matches = ["foo", "bar"]
         mock_cmd_app.display_matches = ["Foo Display"]  # Length mismatch
@@ -111,12 +104,9 @@ def test_get_completions_mismatched_display_matches(self, mock_cmd_app):
 
     def test_get_completions_empty(self, mock_cmd_app):
         """Test completion with no matches."""
-        completer = pt_utils.Cmd2Completer(cast(any, mock_cmd_app))
+        completer = pt_utils.Cmd2Completer(cast(Any, mock_cmd_app))
 
-        document = Mock(spec=Document)
-        document.get_word_before_cursor.return_value = ""
-        document.text = ""
-        document.cursor_position = 0
+        document = Document("", cursor_position=0)
 
         mock_cmd_app.completion_matches = []
 
@@ -128,12 +118,9 @@ def test_init_with_custom_settings(self, mock_cmd_app):
         """Test initializing with custom settings."""
         mock_parser = Mock()
         custom_settings = utils.CustomCompletionSettings(parser=mock_parser)
-        completer = pt_utils.Cmd2Completer(cast(any, mock_cmd_app), custom_settings=custom_settings)
+        completer = pt_utils.Cmd2Completer(cast(Any, mock_cmd_app), custom_settings=custom_settings)
 
-        document = Mock(spec=Document)
-        document.get_word_before_cursor.return_value = ""
-        document.text = ""
-        document.cursor_position = 0
+        document = Document("", cursor_position=0)
 
         mock_cmd_app.completion_matches = []
 
@@ -142,6 +129,65 @@ def test_init_with_custom_settings(self, mock_cmd_app):
         mock_cmd_app.complete.assert_called_once()
         assert mock_cmd_app.complete.call_args[1]['custom_settings'] == custom_settings
 
+    def test_get_completions_with_hints(self, mock_cmd_app, monkeypatch):
+        """Test that hints and formatted completions are printed even with no matches."""
+        mock_print = Mock()
+        monkeypatch.setattr(pt_utils, "print_formatted_text", mock_print)
+
+        completer = pt_utils.Cmd2Completer(cast(Any, mock_cmd_app))
+        document = Document("test", cursor_position=4)
+
+        mock_cmd_app.formatted_completions = "Table Data"
+        mock_cmd_app.completion_hint = "Hint Text"
+        mock_cmd_app.completion_matches = []
+
+        list(completer.get_completions(document, None))
+
+        assert mock_print.call_count == 2
+        assert mock_cmd_app.formatted_completions == ""
+        assert mock_cmd_app.completion_hint == ""
+
+    def test_get_completions_completion_item_meta(self, mock_cmd_app):
+        """Test that CompletionItem descriptive data is used as display_meta."""
+        completer = pt_utils.Cmd2Completer(cast(Any, mock_cmd_app))
+        document = Document("foo", cursor_position=3)
+
+        # item1 with desc, item2 without desc
+        item1 = CompletionItem("foobar", ["My Description"])
+        item2 = CompletionItem("food", [])
+        mock_cmd_app.completion_matches = [item1, item2]
+
+        completions = list(completer.get_completions(document, None))
+
+        assert len(completions) == 2
+        assert completions[0].text == "foobar"
+        # display_meta is converted to FormattedText
+        assert completions[0].display_meta == [('', 'My Description')]
+        assert completions[1].display_meta == [('', '')]
+
+    def test_get_completions_no_statement_parser(self, mock_cmd_app):
+        """Test initialization and completion without statement_parser."""
+        del mock_cmd_app.statement_parser
+        completer = pt_utils.Cmd2Completer(cast(Any, mock_cmd_app))
+
+        document = Document("foo bar", cursor_position=7)
+        list(completer.get_completions(document, None))
+
+        # Should still work with default delimiters
+        mock_cmd_app.complete.assert_called_once()
+
+    def test_get_completions_custom_delimiters(self, mock_cmd_app):
+        """Test that custom delimiters (terminators) are respected."""
+        mock_cmd_app.statement_parser.terminators = ['#']
+        completer = pt_utils.Cmd2Completer(cast(Any, mock_cmd_app))
+
+        # '#' should act as a word boundary
+        document = Document("cmd#arg", cursor_position=7)
+        list(completer.get_completions(document, None))
+
+        # text should be "arg", begidx=4, endidx=7
+        mock_cmd_app.complete.assert_called_with("arg", 0, line="cmd#arg", begidx=4, endidx=7, custom_settings=None)
+
 
 class TestCmd2History:
     def make_history_item(self, text):
@@ -153,7 +199,7 @@ def make_history_item(self, text):
 
     def test_load_history_strings(self, mock_cmd_app):
         """Test loading history strings yields all items in forward order."""
-        history = pt_utils.Cmd2History(cast(any, mock_cmd_app))
+        history = pt_utils.Cmd2History(cast(Any, mock_cmd_app))
 
         # Setup history items
         # History in cmd2 is oldest to newest
@@ -172,7 +218,7 @@ def test_load_history_strings(self, mock_cmd_app):
 
     def test_load_history_strings_empty(self, mock_cmd_app):
         """Test loading history strings with empty history."""
-        history = pt_utils.Cmd2History(cast(any, mock_cmd_app))
+        history = pt_utils.Cmd2History(cast(Any, mock_cmd_app))
 
         mock_cmd_app.history = []
 
@@ -182,7 +228,7 @@ def test_load_history_strings_empty(self, mock_cmd_app):
 
     def test_get_strings(self, mock_cmd_app):
         """Test get_strings returns deduped strings and does not cache."""
-        history = pt_utils.Cmd2History(cast(any, mock_cmd_app))
+        history = pt_utils.Cmd2History(cast(Any, mock_cmd_app))
 
         items = [
             self.make_history_item("cmd1"),
@@ -203,7 +249,7 @@ def test_get_strings(self, mock_cmd_app):
 
     def test_store_string(self, mock_cmd_app):
         """Test store_string does nothing."""
-        history = pt_utils.Cmd2History(cast(any, mock_cmd_app))
+        history = pt_utils.Cmd2History(cast(Any, mock_cmd_app))
 
         # Just ensure it doesn't raise error or modify cmd2 history
         history.store_string("new command")