https://github.com/python/cpython/commit/4de00a42661a1c280e06d2d5d71c4f69eda41562
commit: 4de00a42661a1c280e06d2d5d71c4f69eda41562
branch: main
author: Serhiy Storchaka <[email protected]>
committer: serhiy-storchaka <[email protected]>
date: 2026-09-09T16:21:06+03:00
summary:
gh-157170: Document the scope of global curses settings (GH-157207)
use_env() and filter() affect every screen created afterwards, slk_init()
affects only the screen created next, and set_escdelay() and set_tabsize()
may apply to all screens. Also add missing cross-references to newterm(),
window.refresh() and doupdate().
files:
M Doc/library/curses.rst
diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst
index bcf2ef47d48898a..f9ffd4d376e0f5b 100644
--- a/Doc/library/curses.rst
+++ b/Doc/library/curses.rst
@@ -326,9 +326,10 @@ Input options
The curses library does "line-breakout optimization" by looking for
typeahead
periodically while updating the screen. If input is found, and it is coming
- from a tty, the current update is postponed until refresh or doupdate is
called
- again, allowing faster response to commands typed in advance. This function
- allows specifying a different file descriptor for typeahead checking.
+ from a tty, the current update is postponed until :meth:`~window.refresh` or
+ :func:`doupdate` is called again, allowing faster response to commands typed
+ in advance. This function allows specifying a different file descriptor for
+ typeahead checking.
.. function:: is_cbreak()
@@ -702,7 +703,8 @@ labels.
(eight labels). Where the underlying curses library supports them, ``2``
gives 4-4-4 (twelve labels) and ``3`` gives 4-4-4 with an index line.
- Must be called before :func:`initscr` or :func:`newterm`.
+ Must be called before :func:`initscr` or :func:`newterm`,
+ and affects only the screen created next.
.. versionadded:: next
@@ -1067,8 +1069,10 @@ Utilities
.. function:: filter()
- The :func:`.filter` routine, if used, must be called before :func:`initscr`
is
- called. The effect is that, during the initialization, :envvar:`LINES` is
set to ``1``; the
+ The :func:`.filter` routine, if used, must be called before :func:`initscr`
+ or :func:`newterm` is called,
+ and affects every screen created afterwards.
+ The effect is that, during the initialization, :envvar:`LINES` is set to
``1``; the
capabilities ``clear``, ``cup``, ``cud``, ``cud1``, ``cuu1``, ``cuu``,
``vpa`` are disabled; and the ``home``
string is set to the value of ``cr``. The effect is that the cursor is
confined to
the current line, and so are screen updates. This may be used for enabling
@@ -1087,8 +1091,10 @@ Utilities
.. function:: use_env(flag)
- If used, this function should be called before :func:`initscr` or newterm
are
- called. When *flag* is ``False``, the values of lines and columns
specified in the
+ If used, this function should be called before :func:`initscr` or
+ :func:`newterm` are called,
+ and affects every screen created afterwards.
+ When *flag* is ``False``, the values of lines and columns specified in the
terminfo database will be used, even if environment variables
:envvar:`LINES`
and :envvar:`COLUMNS` (used by default) are set, or if curses is running in
a
window (in which case default behavior would be to use the window size if
@@ -1106,6 +1112,9 @@ Utilities
to distinguish between an individual escape character entered on the
keyboard from escape sequences sent by cursor and function keys.
+ Depending on the curses library, the setting may apply to all screens,
+ not only to the current one.
+
.. versionadded:: 3.9
.. function:: get_tabsize()
@@ -1119,6 +1128,9 @@ Utilities
Sets the number of columns used by the curses library when converting a tab
character to spaces as it adds the tab to a window.
+ Depending on the curses library, the setting may apply to all screens,
+ not only to the current one, and creating a screen may reset it.
+
.. versionadded:: 3.9
.. function:: napms(ms)
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
