From 1058cda38f1b409c4d52eef236f4915df592a112 Mon Sep 17 00:00:00 2001 From: R David Murray Date: Sun, 29 Mar 2015 15:15:40 -0400 Subject: [PATCH] #23792: Ignore KeyboardInterrupt when the pydoc pager is active. Previously, if you hit ctl-c while the pager was active, the python that launched the subprocess for the pager would see the KeyboardInterrupt in the __exit__ method of the subprocess context manager where it was waiting for the subprocess to complete, ending the wait. This would leave the pager running, while the interactive interpreter, after handling the exception by printing it, would go back to trying to post a prompt...but the pager would generally have the terminal in raw mode, and in any case would be still trying to read from stdin. On some systems, even exiting python at that point would not restore the terminal mode. The problem with raw mode could also happen if ctl-C was hit when pydoc was called from the shell command line and the pager was active. Instead, we now wait on the subprocess in a loop, ignoring KeyboardInterrupt just like the pager does, until the pager actually exits. (Note: this was a regression relative to python2...in python2 the pager is called via system, and system does not return until the pager exits.) --- Lib/pydoc.py | 13 ++++++++++--- Misc/NEWS | 4 ++++ 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/Lib/pydoc.py b/Lib/pydoc.py index 8bbebc9be3a..cf9e0f021ce 100755 --- a/Lib/pydoc.py +++ b/Lib/pydoc.py @@ -1452,11 +1452,18 @@ def pipepager(text, cmd): import subprocess proc = subprocess.Popen(cmd, shell=True, stdin=subprocess.PIPE) try: - with proc: - with io.TextIOWrapper(proc.stdin, errors='backslashreplace') as pipe: - pipe.write(text) + with io.TextIOWrapper(proc.stdin, errors='backslashreplace') as pipe: + pipe.write(text) except OSError: pass # Ignore broken pipes caused by quitting the pager program. + while True: + try: + proc.wait() + break + except KeyboardInterrupt: + # Ignore ctl-c like the pager itself does. Otherwise the pager is + # left running and the terminal is in raw mode and unusable. + pass def tempfilepager(text, cmd): """Page through text by invoking a program on a temporary file.""" diff --git a/Misc/NEWS b/Misc/NEWS index c6b5e1ccbff..9852102f903 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -21,6 +21,10 @@ Core and Builtins Library ------- +- Issue #23792: Ignore KeyboardInterrupt when the pydoc pager is active. + This mimics the behavior of the standard unix pagers, and prevents + pipepager from shutting down while the pager itself is still running. + - Issue #23742: ntpath.expandvars() no longer loses unbalanced single quotes. - Issue #21802: The reader in BufferedRWPair now is closed even when closing