mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-29 11:45:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

merge #6771: fix docs: curses.wrapper is exposed as a function, not a module

Browse source
This commit is contained in:
R David Murray 2011-06-18 19:41:43 -04:00
commit 50ae84e727
1 changed files with 13 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

46
Doc/library/curses.rst
View file

@ -41,10 +41,6 @@ Linux and the BSD variants of Unix.
Module :mod:`curses.textpad` Module :mod:`curses.textpad`
Editable text widget for curses supporting :program:`Emacs`\ -like bindings. Editable text widget for curses supporting :program:`Emacs`\ -like bindings.
Module :mod:`curses.wrapper`
Convenience function to ensure proper terminal setup and resetting on
application entry and exit.
:ref:`curses-howto` :ref:`curses-howto`
Tutorial material on using curses with Python, by Andrew Kuchling and Eric Tutorial material on using curses with Python, by Andrew Kuchling and Eric
Raymond. Raymond.
@ -592,6 +588,19 @@ The module :mod:`curses` defines the following functions:
foreground color on the default background. foreground color on the default background.
.. function:: wrapper(func, ...)
Initialize curses and call another callable object, *func*, which should be the
rest of your curses-using application. If the application raises an exception,
this function will restore the terminal to a sane state before re-raising the
exception and generating a traceback. The callable object *func* is then passed
the main window 'stdscr' as its first argument, followed by any other arguments
passed to :func:`wrapper`. Before calling *func*, :func:`wrapper` turns on
cbreak mode, turns off echo, enables the terminal keypad, and initializes colors
if the terminal has color support. On exit (whether normally or by exception)
it restores cooked mode, turns on echo, and disables the terminal keypad.
.. _curses-window-objects: .. _curses-window-objects:
Window Objects Window Objects
@ -1659,32 +1668,3 @@ You can instantiate a :class:`Textbox` object as follows:
cursor motion that would land the cursor on a trailing blank goes to the cursor motion that would land the cursor on a trailing blank goes to the
end of that line instead, and trailing blanks are stripped when the window end of that line instead, and trailing blanks are stripped when the window
contents are gathered. contents are gathered.
:mod:`curses.wrapper` --- Terminal handler for curses programs
==============================================================
.. module:: curses.wrapper
:synopsis: Terminal configuration wrapper for curses programs.
.. moduleauthor:: Eric Raymond <esr@thyrsus.com>
.. sectionauthor:: Eric Raymond <esr@thyrsus.com>
This module supplies one function, :func:`wrapper`, which runs another function
which should be the rest of your curses-using application. If the application
raises an exception, :func:`wrapper` will restore the terminal to a sane state
before re-raising the exception and generating a traceback.
.. function:: wrapper(func, ...)
Wrapper function that initializes curses and calls another function, *func*,
restoring normal keyboard/screen behavior on error. The callable object *func*
is then passed the main window 'stdscr' as its first argument, followed by any
other arguments passed to :func:`wrapper`.
Before calling the hook function, :func:`wrapper` turns on cbreak mode, turns
off echo, enables the terminal keypad, and initializes colors if the terminal
has color support. On exit (whether normally or by exception) it restores
cooked mode, turns on echo, and disables the terminal keypad.