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 — gh-156347: Fix wrong statements in the curses documentation by serhiy-storchaka · Pull Request #156354 · python/cpython

Conversation

@serhiy-storchaka

@serhiy-storchaka serhiy-storchaka commented Aug 25, 2026 •
edited by bedevere-app Bot
Loading

Uh oh!

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

Copy link
Copy Markdown
Member

window.encoding does not encode the string arguments on a build with wide-character support: the curses library converts the characters itself.

In the HOWTO: getch() returns -1, not curses.ERR, when there is no input, and half-delay mode does the same as no-delay mode. getkey() returns the key name only for a special key. leaveok() is not a synonym for curs_set(). getstr() returns a bytes object, interprets the erase and kill characters, and limits bytes. The ACS_* constants are not all larger than 255.

Also document get_wch() before getch(), mention complexchar and complexstr, and read whole characters in the examples.

  • Issue: curses window.encoding does not encode str arguments on a wide build #156347

Sorry, something went wrong.

Uh oh!

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

All reactions
@serhiy-storchaka
pythongh-156347: Fix wrong statements in the curses documentation
147c463
window.encoding does not encode the string arguments on a build with
wide-character support: the curses library converts the characters itself.

In the HOWTO: getch() returns -1, not curses.ERR, when there is no input,
and half-delay mode does the same as no-delay mode.  getkey() returns the
key name only for a special key.  leaveok() is not a synonym for curs_set().
getstr() returns a bytes object, interprets the erase and kill characters,
and limits bytes.  The ACS_* constants are not all larger than 255.

Also document get_wch() before getch(), mention complexchar and complexstr,
and read whole characters in the examples.
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Aug 25, 2026
@github-project-automation github-project-automation Bot added this to Docs PRs Aug 25, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Aug 25, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Aug 25, 2026
curses window.encoding does not encode str arguments on a wide build #156347
Closed
@bedevere-app bedevere-app Bot added the awaiting core review label Aug 25, 2026
@serhiy-storchaka serhiy-storchaka added the topic-curses label Aug 25, 2026
@read-the-docs-community

read-the-docs-community Bot commented Aug 25, 2026

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34221737 | 📁 Comparing 147c463 against main (a728080)

  🔍 Preview build  

2 files changed
± howto/curses.html
± library/curses.html
All reactions

Sorry, something went wrong.

Uh oh!

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

@serhiy-storchaka
serhiy-storchaka merged commit 161054c into python:main Sep 3, 2026
38 checks passed

Uh oh!

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

@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Sep 3, 2026
@bedevere-app bedevere-app Bot removed the awaiting core review label Sep 3, 2026
@serhiy-storchaka
serhiy-storchaka deleted the curses-howto-fixes branch September 3, 2026 07:18
This was referenced Sep 3, 2026
[3.15] gh-156347: Fix wrong statements in the curses documentation (GH-156354) #156872
Merged
[3.14] gh-156347: Fix wrong statements in the curses documentation (GH-156354) #156873
Merged
@bedevere-app

bedevere-app Bot commented Sep 3, 2026

Copy link
Copy Markdown

GH-156872 is a backport of this pull request to the 3.15 branch.

All reactions

Sorry, something went wrong.

Uh oh!

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

@serhiy-storchaka serhiy-storchaka mentioned this pull request Sep 3, 2026
[3.13] gh-156347: Fix wrong statements in the curses documentation (GH-156354) #156874
Merged
@bedevere-app

bedevere-app Bot commented Sep 3, 2026

Copy link
Copy Markdown

GH-156873 is a backport of this pull request to the 3.14 branch.

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-app

bedevere-app Bot commented Sep 3, 2026

Copy link
Copy Markdown

GH-156874 is a backport of this pull request to the 3.13 branch.

All reactions

Sorry, something went wrong.

Uh oh!

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

serhiy-storchaka added a commit that referenced this pull request Sep 3, 2026
@serhiy-storchaka
[3.14] gh-156347: Fix wrong statements in the curses documentation (G…
a3084ff
…H-156354) (GH-156873)

window.encoding does not encode the string arguments on a build with
wide-character support: the curses library converts the characters itself.

In the HOWTO: getch() returns -1, not curses.ERR, when there is no input,
and half-delay mode does the same as no-delay mode.  getkey() returns the
key name only for a special key.  leaveok() is not a synonym for curs_set().
getstr() returns a bytes object, interprets the erase and kill characters,
and limits bytes.  The ACS_* constants are not all larger than 255.
Also document get_wch() before getch(), and read whole characters in the
example.

(cherry picked from commit 161054c)
serhiy-storchaka added a commit that referenced this pull request Sep 3, 2026
@serhiy-storchaka
[3.13] gh-156347: Fix wrong statements in the curses documentation (G…
6ad0c73
…H-156354) (GH-156874)

window.encoding does not encode the string arguments on a build with
wide-character support: the curses library converts the characters itself.

In the HOWTO: getch() returns -1, not curses.ERR, when there is no input,
and half-delay mode does the same as no-delay mode.  getkey() returns the
key name only for a special key.  leaveok() is not a synonym for curs_set().
getstr() returns a bytes object, interprets the erase and kill characters,
and limits bytes.  The ACS_* constants are not all larger than 255.
Also document get_wch() before getch(), and read whole characters in the
example.

(cherry picked from commit 161054c)
@serhiy-storchaka serhiy-storchaka mentioned this pull request Sep 3, 2026
gh-156347: Fix the documentation of curses window.encoding #156352
Closed
hugovk pushed a commit that referenced this pull request Sep 5, 2026
@serhiy-storchaka
[3.15] gh-156347: Fix wrong statements in the curses documentation (G…
996300c
…H-156354) (#156872)

window.encoding does not encode the string arguments on a build with
wide-character support: the curses library converts the characters itself.

In the HOWTO: getch() returns -1, not curses.ERR, when there is no input,
and half-delay mode does the same as no-delay mode.  getkey() returns the
key name only for a special key.  leaveok() is not a synonym for curs_set().
getstr() returns a bytes object, interprets the erase and kill characters,
and limits bytes.  The ACS_* constants are not all larger than 255.
Also document get_wch() before getch(), and read whole characters in the
example.

(cherry picked from commit 161054c)
clin1234 pushed a commit to clin1234/cpython that referenced this pull request Sep 12, 2026
@serhiy-storchaka @clin1234
pythongh-156347: Fix wrong statements in the curses documentation (py…
a81d06a
…thonGH-156354)

window.encoding does not encode the string arguments on a build with
wide-character support: the curses library converts the characters itself.

In the HOWTO: getch() returns -1, not curses.ERR, when there is no input,
and half-delay mode does the same as no-delay mode.  getkey() returns the
key name only for a special key.  leaveok() is not a synonym for curs_set().
getstr() returns a bytes object, interprets the erase and kill characters,
and limits bytes.  The ACS_* constants are not all larger than 255.

Also document get_wch() before getch(), mention complexchar and complexstr,
and read whole characters in the examples.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

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

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news topic-curses

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

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

1 participant

@serhiy-storchaka
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.