Reapply "Fix NoConsoleScreenBufferError on Windows CI by robustly initializing PromptSession and ensuring consistent input/output usage"

This reverts commit f194db6.

Author: tleonhardt

cmd2/cmd2.py

@@ -63,7 +63,6 @@
     cast,
 )
 
-import prompt_toolkit as pt
 import rich.box
 from rich.console import Group, RenderableType
 from rich.highlighter import ReprHighlighter
@@ -144,9 +143,26 @@
 from prompt_toolkit.completion import Completer, DummyCompleter
 from prompt_toolkit.formatted_text import ANSI
 from prompt_toolkit.history import InMemoryHistory
+from prompt_toolkit.input import DummyInput
+from prompt_toolkit.output import DummyOutput
 from prompt_toolkit.patch_stdout import patch_stdout
 from prompt_toolkit.shortcuts import PromptSession, set_title
 
+try:
+    if sys.platform == "win32":
+        from prompt_toolkit.output.win32 import NoConsoleScreenBufferError  # type: ignore[attr-defined]
+    else:
+
+        class NoConsoleScreenBufferError(Exception):  # type: ignore[no-redef]
+            """Dummy exception to use when prompt_toolkit.output.win32.NoConsoleScreenBufferError is not available."""
+
+
+except ImportError:
+
+    class NoConsoleScreenBufferError(Exception):  # type: ignore[no-redef]
+        """Dummy exception to use when prompt_toolkit.output.win32.NoConsoleScreenBufferError is not available."""
+
+
 from .pt_utils import (
     Cmd2Completer,
     Cmd2History,
@@ -421,10 +437,22 @@ def __init__(
         # Initialize prompt-toolkit PromptSession
         self.history_adapter = Cmd2History(self)
         self.completer = Cmd2Completer(self)
-        self.session: PromptSession[str] = PromptSession(
-            history=self.history_adapter,
-            completer=self.completer,
-        )
+
+        try:
+            self.session: PromptSession[str] = PromptSession(
+                history=self.history_adapter,
+                completer=self.completer,
+            )
+        except (NoConsoleScreenBufferError, AttributeError, ValueError):
+            # Fallback to dummy input/output if PromptSession initialization fails.
+            # This can happen in some CI environments (like GitHub Actions on Windows)
+            # where isatty() is True but there is no real console.
+            self.session = PromptSession(
+                history=self.history_adapter,
+                completer=self.completer,
+                input=DummyInput(),
+                output=DummyOutput(),
+            )
 
         # Commands to exclude from the history command
         self.exclude_from_history = ['eof', 'history']
@@ -3226,12 +3254,16 @@ def get_prompt() -> Any:
                     history_to_use = InMemoryHistory()
                     for item in history:
                         history_to_use.append_string(item)
-                    from prompt_toolkit import prompt as pt_prompt
 
-                    return pt_prompt(
+                    temp_session1: PromptSession[str] = PromptSession(
+                        history=history_to_use,
+                        input=self.session.input,
+                        output=self.session.output,
+                    )
+
+                    return temp_session1.prompt(
                         prompt_to_use,
                         completer=completer_to_use,
-                        history=history_to_use,
                         bottom_toolbar=self._bottom_toolbar,
                     )
 
@@ -3244,13 +3276,26 @@ def get_prompt() -> Any:
         # Otherwise read from self.stdin
         elif self.stdin.isatty():
             # on a tty, print the prompt first, then read the line
-            line = pt.prompt(prompt, bottom_toolbar=self._bottom_toolbar)
+            temp_session2: PromptSession[str] = PromptSession(
+                input=self.session.input,
+                output=self.session.output,
+            )
+            line = temp_session2.prompt(
+                prompt,
+                bottom_toolbar=self._bottom_toolbar,
+            )
             if len(line) == 0:
                 raise EOFError
             return line.rstrip('\n')
         else:
             # not a tty, just read the line
-            line = pt.prompt(bottom_toolbar=self._bottom_toolbar)
+            temp_session3: PromptSession[str] = PromptSession(
+                input=self.session.input,
+                output=self.session.output,
+            )
+            line = temp_session3.prompt(
+                bottom_toolbar=self._bottom_toolbar,
+            )
             if len(line) == 0:
                 raise EOFError
             line = line.rstrip('\n')

tests/test_cmd2.py

@@ -1918,11 +1918,10 @@ def test_read_input_rawinput_true(capsys, monkeypatch) -> None:
     app = cmd2.Cmd()
     app.use_rawinput = True
 
-    # Mock prompt_toolkit.prompt (used when isatty=False)
+    # Mock PromptSession.prompt (used when isatty=False)
     # and app.session.prompt (used when use_rawinput=True and isatty=True)
     with (
-        mock.patch('prompt_toolkit.prompt', return_value=input_str),
-        mock.patch.object(app.session, 'prompt', return_value=input_str),
+        mock.patch('cmd2.cmd2.PromptSession.prompt', return_value=input_str),
     ):
         # isatty is True
         with mock.patch('sys.stdin.isatty', mock.MagicMock(name='isatty', return_value=True)):
@@ -2000,22 +1999,22 @@ def mock_pt_prompt(message='', **kwargs):
 
     # isatty True
     app = make_app(isatty=True)
-    with mock.patch('prompt_toolkit.prompt', side_effect=mock_pt_prompt):
+    with mock.patch('cmd2.cmd2.PromptSession.prompt', side_effect=mock_pt_prompt):
         line = app.read_input(prompt_str)
     out, _err = capsys.readouterr()
     assert line == input_str
     assert out == prompt_str
 
     # isatty True, empty input
     app = make_app(isatty=True, empty_input=True)
-    with mock.patch('prompt_toolkit.prompt', return_value=''), pytest.raises(EOFError):
+    with mock.patch('cmd2.cmd2.PromptSession.prompt', return_value=''), pytest.raises(EOFError):
         app.read_input(prompt_str)
     out, _err = capsys.readouterr()
 
     # isatty is False, echo is True
     app = make_app(isatty=False)
     app.echo = True
-    with mock.patch('prompt_toolkit.prompt', return_value=input_str):
+    with mock.patch('cmd2.cmd2.PromptSession.prompt', return_value=input_str):
         line = app.read_input(prompt_str)
     out, _err = capsys.readouterr()
     assert line == input_str
@@ -2024,15 +2023,15 @@ def mock_pt_prompt(message='', **kwargs):
     # isatty is False, echo is False
     app = make_app(isatty=False)
     app.echo = False
-    with mock.patch('prompt_toolkit.prompt', return_value=input_str):
+    with mock.patch('cmd2.cmd2.PromptSession.prompt', return_value=input_str):
         line = app.read_input(prompt_str)
     out, _err = capsys.readouterr()
     assert line == input_str
     assert not out
 
     # isatty is False, empty input
     app = make_app(isatty=False, empty_input=True)
-    with mock.patch('prompt_toolkit.prompt', return_value=''), pytest.raises(EOFError):
+    with mock.patch('cmd2.cmd2.PromptSession.prompt', return_value=''), pytest.raises(EOFError):
         app.read_input(prompt_str)
     out, _err = capsys.readouterr()