mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-10 00:43:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 18

bpo-26228: [doc] Adapt PTY documentation updates from GH-4167 (GH-27754)

Browse source 
Co-authored-by: Cornelius Diekmann <c.diekmann@googlemail.com>
This commit is contained in:
Łukasz Langa 2021-08-13 12:57:07 +02:00 • committed by GitHub
parent 230403a6a1
commit dd8eb303b9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Doc/library/pty.rst
View file

@ -2,8 +2,8 @@
======================================== ========================================
.. module:: pty .. module:: pty
:platform: Linux :platform: Unix
:synopsis: Pseudo-Terminal Handling for Linux. :synopsis: Pseudo-Terminal Handling for Unix.
.. moduleauthor:: Steen Lumholt .. moduleauthor:: Steen Lumholt
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. 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 concept: starting another process and being able to write to and read from its
controlling terminal programmatically. controlling terminal programmatically.
Because pseudo-terminal handling is highly platform dependent, there is code to Pseudo-terminal handling is highly platform dependent. This code is mainly
do it only for Linux. (The Linux code is supposed to work on other platforms, tested on Linux, FreeBSD, and macOS (it is supposed to work on other POSIX
but hasn't been tested yet.) platforms but it's not been thoroughly tested).
The :mod:`pty` module defines the following functions: The :mod:`pty` module defines the following functions:
@ -47,6 +47,10 @@ The :mod:`pty` module defines the following functions:
spawned behind the pty will eventually terminate, and when it does *spawn* spawned behind the pty will eventually terminate, and when it does *spawn*
will return. will return.
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* are passed a file descriptor The functions *master_read* and *stdin_read* are passed a file descriptor
which they should read from, and they should always return a byte string. In which they should read from, and they should always return a byte string. In
order to force spawn to return before the child process exits an order to force spawn to return before the child process exits an

2
Lib/pty.py
View file

@ -1,7 +1,7 @@
"""Pseudo terminal utilities.""" """Pseudo terminal utilities."""
# Bugs: No signal handling. Doesn't set slave termios and window size. # Bugs: No signal handling. Doesn't set slave termios and window size.
# Only tested on Linux. # Only tested on Linux, FreeBSD, and macOS.
# See: W. Richard Stevens. 1992. Advanced Programming in the # See: W. Richard Stevens. 1992. Advanced Programming in the
# UNIX Environment. Chapter 19. # UNIX Environment. Chapter 19.
# Author: Steen Lumholt -- with additions by Guido. # Author: Steen Lumholt -- with additions by Guido.

2
Misc/NEWS.d/next/Library/2019-02-26-09-31-59.bpo-26228.wyrHKc.rst
View file

@ -1 +1 @@
pty.spawn no longer hangs on FreeBSD, OS X, and Solaris. pty.spawn no longer hangs on FreeBSD, macOS, and Solaris.