GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — bpo-41818: Make additions to the tty module by 8vasu · Pull Request #23546 · python/cpython

bpo-41818: Make additions to the tty module #23546

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

Closed
8vasu wants to merge 4 commits into python:main from 8vasu:prepare_tty_for_pty

Uh oh!

There was an error while loading. Please reload this page.

Closed

bpo-41818: Make additions to the tty module #23546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a684142
Soumendra Ganguly: new additions to the tty library. Functions added:…
8vasu Dec 11, 2020
3673a79
Clear all POSIX.1-2017 local mode flags in tty.cfmakeraw().
8vasu Dec 15, 2020
f86a5f8
Remove news file.
8vasu May 6, 2022
8288297
📜🤖 Added by blurb_it.
blurb-it[bot] May 6, 2022
File filter
Filter by extension

Clear filters
Conversations
Failed to load comments.
Loading

Uh oh!

There was an error while loading. Please reload this page.

Jump to
Jump to file
Failed to load files.
Loading

Uh oh!

There was an error while loading. Please reload this page.

Diff view
Diff view

There are no files selected for viewing

25 changes: 23 additions & 2 deletions 25 Doc/library/tty.rst
Show comments
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,39 @@ Because it requires the :mod:`termios` module, it will work only on Unix.
The :mod:`tty` module defines the following functions:


.. function:: cfmakeecho(mode, echo=True)

Set ECHO in the tty attribute list *mode*, which is a list like the one
returned by :func:`termios.tcgetattr`, if *echo* is :const:`True` or is
omitted. Unset ECHO if *echo* is :const:`False`.


.. function:: cfmakeraw(mode)

Convert the tty attribute list *mode*, which is a list like the one returned
by :func:`termios.tcgetattr`, to that of a tty in raw mode.


.. function:: cfmakecbreak(mode)

Convert the tty attribute list *mode*, which is a list like the one returned
by :func:`termios.tcgetattr`, to that of a tty in cbreak mode.


.. function:: setraw(fd, when=termios.TCSAFLUSH)

Change the mode of the file descriptor *fd* to raw. If *when* is omitted, it
defaults to :const:`termios.TCSAFLUSH`, and is passed to
:func:`termios.tcsetattr`.
:func:`termios.tcsetattr`. The return value of :func:`termios.tcgetattr`
is saved before setting *fd* to raw mode; this value is returned.


.. function:: setcbreak(fd, when=termios.TCSAFLUSH)

Change the mode of file descriptor *fd* to cbreak. If *when* is omitted, it
defaults to :const:`termios.TCSAFLUSH`, and is passed to
:func:`termios.tcsetattr`.
:func:`termios.tcsetattr`. The return value of :func:`termios.tcgetattr`
is saved before setting *fd* to cbreak mode; this value is returned.


.. seealso::
Expand Down
77 changes: 61 additions & 16 deletions 77 Lib/tty.py
Show comments
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

from termios import *

__all__ = ["setraw", "setcbreak"]
__all__ = ["cfmakeecho", "cfmakeraw", "cfmakecbreak", "setraw", "setcbreak"]

# Indexes for termios list.
# Indices for termios list.
IFLAG = 0
OFLAG = 1
CFLAG = 2
Expand All @@ -15,22 +15,67 @@
OSPEED = 5
CC = 6

def setraw(fd, when=TCSAFLUSH):
"""Put terminal into a raw mode."""
mode = tcgetattr(fd)
mode[IFLAG] = mode[IFLAG] & ~(BRKINT | ICRNL | INPCK | ISTRIP | IXON)
mode[OFLAG] = mode[OFLAG] & ~(OPOST)
mode[CFLAG] = mode[CFLAG] & ~(CSIZE | PARENB)
mode[CFLAG] = mode[CFLAG] | CS8
mode[LFLAG] = mode[LFLAG] & ~(ECHO | ICANON | IEXTEN | ISIG)
def cfmakeecho(mode, echo=True):
"""Set/unset ECHO."""
if echo:
mode[LFLAG] |= ECHO
else:
mode[LFLAG] &= ~ECHO

def cfmakeraw(mode):
"""raw mode termios"""
# Clear all POSIX.1-2017 input mode flags.
mode[IFLAG] &= ~(IGNBRK | BRKINT | IGNPAR | PARMRK | INPCK | ISTRIP |
INLCR | IGNCR | ICRNL | IXON | IXANY | IXOFF)

# Do not post-process output.
mode[OFLAG] &= ~OPOST

# Disable parity generation and detection; clear character size mask;
# let character size be 8 bits.
mode[CFLAG] &= ~(PARENB | CSIZE)
mode[CFLAG] |= CS8

# Clear all POSIX.1-2017 local mode flags.
mode[LFLAG] &= ~(ECHO | ECHOE | ECHOK | ECHONL | ICANON |
IEXTEN | ISIG | NOFLSH | TOSTOP)

# POSIX.1-2017, 11.1.7 Non-Canonical Mode Input Processing,
# Case B: MIN>0, TIME=0
# A pending read shall block until MIN (here 1) bytes are received,
# or a signal is received.
mode[CC][VMIN] = 1
mode[CC][VTIME] = 0
tcsetattr(fd, when, mode)

def setcbreak(fd, when=TCSAFLUSH):
"""Put terminal into a cbreak mode."""
mode = tcgetattr(fd)
mode[LFLAG] = mode[LFLAG] & ~(ECHO | ICANON)
def cfmakecbreak(mode):
"""cbreak mode termios"""
# Do not map CR to NL on input.
mode[IFLAG] &= ~(ICRNL)

# Do not echo characters; disable canonical input.
mode[LFLAG] &= ~(ECHO | ICANON)

# POSIX.1-2017, 11.1.7 Non-Canonical Mode Input Processing,
# Case B: MIN>0, TIME=0
# A pending read shall block until MIN (here 1) bytes are received,
# or a signal is received.
mode[CC][VMIN] = 1
mode[CC][VTIME] = 0
tcsetattr(fd, when, mode)

def setraw(fd, when=TCSAFLUSH):
"""Put terminal into raw mode.
Returns original termios."""
mode = tcgetattr(fd)
new = list(mode)
cfmakeraw(new)
tcsetattr(fd, when, new)
return mode

def setcbreak(fd, when=TCSAFLUSH):
"""Put terminal into cbreak mode.
Returns original termios."""
mode = tcgetattr(fd)
new = list(mode)
cfmakecbreak(new)
tcsetattr(fd, when, new)
return mode
2 changes: 2 additions & 0 deletions 2 Misc/NEWS.d/next/Library/2022-05-06-23-41-53.gh-issue-85984.v0hNdq.rst
Show comments
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Soumendra Ganguly: new additions to the tty library. Functions added: cfmakeecho(), cfmakeraw(), and cfmakecbreak().
The functions setcbreak() and setraw() now return original termios to save an extra tcgetattr() call.
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.