[3.13] gh-156234: Fix and rewrite the curses documentation on reading (GH-156235) - #156281
Merged
serhiy-storchaka merged 1 commit intoAug 23, 2026
Merged
Conversation
…eading (pythonGH-156235) Fix wrong types: instr() and getstr() return a bytes object, not a str, and their n limits the number of bytes; getkey() returns a str; unctrl() returns a bytes object. Make clear whether an integer standing for a character is an encoded byte or a character code. Rewrite the documentation of getch(), get_wch(), getkey(), getstr() and instr(), following X/Open Curses. The docstrings of getstr() and instr() said that n defaults to 2047, while the limit on this branch is 1023. (cherry picked from commit be87bfa)
Documentation build overview
470 files changed ·
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Manual backport of #156235.
Fix wrong types:
instr()andgetstr()return a bytes object, not a str, and their n limits the number of bytes;getkey()returns astr;unctrl()returns a bytes object. Make clear whether an integer standing for a character is an encoded byte or a character code.Rewrite the documentation of
getch(),get_wch(),getkey(),getstr()andinstr(), following X/Open Curses.The parts for
in_wstr(),in_wchstr(),get_wstr(),wunctrl()andcomplexchar/complexstrare omitted: these do not exist in 3.13. The limit is 1023 here, not 2047; the docstrings ofgetstr()andinstr()claimedn=2047, which is fixed too.(cherry picked from commit be87bfa)