Skip to content

fix(cli): gracefully handle non-TTY stdin in raw_input_char #641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Deeven-Seru wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(cli): gracefully handle non-TTY stdin in raw_input_char #641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d6e79ad
fix(cli): gracefully handle non-TTY stdin in raw_input_char
Deeven-Seru Jul 27, 2026
3996232
style: format bin/apport-cli with black
Deeven-Seru Jul 27, 2026
722bebd
fix(cli): resolve linter errors and add unit tests for raw_input_char…
Deeven-Seru Jul 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions bin/apport-cli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,15 @@ class CLIDialog:
sys.stdout.flush()

file = sys.stdin.fileno()

if not os.isatty(file):
if multi_char:
response = str(sys.stdin.readline()).strip()
else:
response = str(sys.stdin.read(1))
sys.stdout.write("\n")
return response

saved_attributes = termios.tcgetattr(file)
attributes = termios.tcgetattr(file)
attributes[3] = attributes[3] & ~(termios.ICANON)
Expand Down
26 changes: 26 additions & 0 deletions tests/integration/test_ui_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,29 @@ def test_save_report_in_temp_directory(self, stdout_mock: io.StringIO) -> None:
run_mock.return_value = 4
self.app.ui_present_report_details()
self.assertIn(_("Problem report file:"), stdout_mock.getvalue())

@unittest.mock.patch("os.isatty")
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_raw_input_char_non_tty(self, mock_stdout, mock_isatty):
mock_isatty.return_value = False
mock_stdin = unittest.mock.MagicMock()
mock_stdin.fileno.return_value = 0
mock_stdin.read.return_value = "y"
with unittest.mock.patch("sys.stdin", mock_stdin):
response = apport_cli.CLIDialog.raw_input_char("Prompt?")
self.assertEqual(response, "y")
self.assertEqual(mock_stdout.getvalue(), "Prompt? \n")
mock_stdin.read.assert_called_with(1)

@unittest.mock.patch("os.isatty")
@unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
def test_raw_input_char_non_tty_multi(self, mock_stdout, mock_isatty):
mock_isatty.return_value = False
mock_stdin = unittest.mock.MagicMock()
mock_stdin.fileno.return_value = 0
mock_stdin.readline.return_value = "yes\n"
with unittest.mock.patch("sys.stdin", mock_stdin):
response = apport_cli.CLIDialog.raw_input_char("Prompt?", multi_char=True)
self.assertEqual(response, "yes")
self.assertEqual(mock_stdout.getvalue(), "Prompt? \n")
mock_stdin.readline.assert_called_with()
Loading