bpo-29070: Integration tests for pty module with patch from bpo-26228

Doc/library/pty.rst

@@ -2,8 +2,8 @@
 ========================================
 
 .. module:: pty
-   :platform: Linux
-   :synopsis: Pseudo-Terminal Handling for Linux.
+   :platform: Unix
+   :synopsis: Pseudo-Terminal Handling for Unix.
 
 .. moduleauthor:: Steen Lumholt
 .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
@@ -16,9 +16,9 @@ The :mod:`pty` module defines operations for handling the pseudo-terminal
 concept: starting another process and being able to write to and read from its
 controlling terminal programmatically.
 
-Because pseudo-terminal handling is highly platform dependent, there is code to
-do it only for Linux. (The Linux code is supposed to work on other platforms,
-but hasn't been tested yet.)
+Pseudo-terminal handling is highly platform dependent. This code is mainly
+tested on Linux, FreeBSD, and OS X (it is supposed to work on other POSIX
+platforms).
 
 The :mod:`pty` module defines the following functions:
 
@@ -41,9 +41,13 @@ The :mod:`pty` module defines the following functions:
 
 .. function:: spawn(argv[, master_read[, stdin_read]])
 
-   Spawn a process, and connect its controlling terminal with the current
-   process's standard io. This is often used to baffle programs which insist on
-   reading from the controlling terminal.
+   Spawn a child process, and connect its controlling terminal with the
+   current process's standard io. This is often used to baffle programs which
+   insist on reading from the controlling terminal.
+
+   A loop copies STDIN of the current process to the child and data received
+   from the child to STDOUT of the current process. It is not signaled to the
+   child if STDIN of the current process closes down.
 
    The functions *master_read* and *stdin_read* should be functions which read from
    a file descriptor. The defaults try to read 1024 bytes each time they are
@@ -91,3 +95,14 @@ pseudo-terminal to record all input and output of a terminal session in a
 
         script.write(('Script done on %s\n' % time.asctime()).encode())
         print('Script done, file is', filename)
+
+Caveats
+-------
+
+.. sectionauthor:: Cornelius Diekmann
+
+Be aware that processes started by :func:`spawn` do not receive any information
+about STDIN of their parent shutting down. For example, if run on a terminal on
+a Linux system, ``/bin/sh < /dev/null`` closes immediately. However,
+``./python -c 'import pty; pty.spawn("/bin/sh")' < /dev/null`` does not close
+because the spawned child shell is not notified that STDIN is closed.

Lib/pty.py

@@ -1,13 +1,14 @@
 """Pseudo terminal utilities."""
 
 # Bugs: No signal handling.  Doesn't set slave termios and window size.
-#       Only tested on Linux.
+#       Only tested on Linux, FreeBSD, and OS X.
 # See:  W. Richard Stevens. 1992.  Advanced Programming in the
 #       UNIX Environment.  Chapter 19.
 # Author: Steen Lumholt -- with additions by Guido.
 
 from select import select
 import os
+import sys
 import tty
 
 __all__ = ["openpty","fork","spawn"]
@@ -133,11 +134,16 @@ def _copy(master_fd, master_read=_read, stdin_read=_read):
             standard input -> pty master    (stdin_read)"""
     fds = [master_fd, STDIN_FILENO]
     while True:
+        # The expected path to leave this infinite loop is that the
+        # child exits and its slave_fd is destroyed. In this case,
+        # master_fd will become ready in select() and reading from
+        # master_fd either raises an OSError (Input/output error) on
+        # Linux or returns EOF on BSD.
         rfds, wfds, xfds = select(fds, [], [])
         if master_fd in rfds:
             data = master_read(master_fd)
             if not data:  # Reached EOF.
-                fds.remove(master_fd)
+                return
             else:
                 os.write(STDOUT_FILENO, data)
         if STDIN_FILENO in rfds:
@@ -153,7 +159,16 @@ def spawn(argv, master_read=_read, stdin_read=_read):
         argv = (argv,)
     pid, master_fd = fork()
     if pid == CHILD:
-        os.execlp(argv[0], *argv)
+        try:
+            #XXX issue17824 still open
+            os.execlp(argv[0], *argv)
+        except:
+            # If we wanted to be really clever, we would use
+            # the same method as subprocess() to pass the error
+            # back to the parent.  For now just dump stack trace.
+            sys.excepthook(*sys.exc_info())
+        finally:
+            os._exit(1)
     try:
         mode = tty.tcgetattr(STDIN_FILENO)
         tty.setraw(STDIN_FILENO)
@@ -163,6 +178,10 @@ def spawn(argv, master_read=_read, stdin_read=_read):
     try:
         _copy(master_fd, master_read, stdin_read)
     except OSError:
+        # Some OSes never return an EOF on pty, just raise
+        # an error instead.
+        pass
+    finally:
         if restore:
             tty.tcsetattr(STDIN_FILENO, tty.TCSAFLUSH, mode)