Windows only: set the current value of the ctypes-private copy of the system LastError variable in the calling thread to value and return the previous value.
Raises an auditing event ctypes.set_last_error with argument error.


Returns the size in bytes of a ctypes type or instance memory buffer. Does the same as the C sizeof operator.


This function returns the C string starting at memory address address as a bytes object. If size is specified, it is used as size, otherwise the string is assumed to be zero-terminated.
Raises an auditing event ctypes.string_at with arguments address, size.


Abstract base class for structures in native byte order.
Concrete structure and union types must be created by subclassing one of these types, and at least define a _fields_ class variable. ctypes will create descriptors which allow reading and writing the fields by direct attribute accesses. These are the
A sequence defining the structure fields. The items must be 2-tuples or 3-tuples. The first item is the name of the field, the second item specifies the type of the field; it can be any ctypes data type.
For integer type fields like c_int, a third optional item can be given. It must be a small positive integer defining the bit width of the field.
Field names must be unique within one structure or union. This is not checked, only one field can be accessed when names are repeated.
It is possible to define the _fields_ class variable after the class statement that defines the Structure subclass, this allows creating data types that directly or indirectly reference themselves:
The _fields_ class variable must, however, be defined before the type is first used (an instance is created, sizeof() is called on it, and so on). Later assignments to the _fields_ class variable will raise an AttributeError.
It is possible to define sub-subclasses of structure types, they inherit the fields of the base class plus the _fields_ defined in the sub-subclass, if any.
An optional small integer that allows overriding the alignment of structure fields in the instance. _pack_ must already be defined when _fields_ is assigned, otherwise it will have no effect.
An optional sequence that lists the names of unnamed (anonymous) fields. _anonymous_ must be already defined when _fields_ is assigned, otherwise it will have no effect.
The fields listed in this variable must be structure or union type fields. ctypes will create descriptors in the structure type that allows accessing the nested fields directly, without the need to create the structure or union field.
Here is an example type (Windows):
The TYPEDESC structure describes a COM data type, the vt field specifies which one of the union fields is valid. Since the u field is defined as anonymous field, it is now possible to access the members directly off the TYPEDESC instance. td.lptdesc and td.u.lptdesc are equivalent, but the former is faster since it does not need to create a temporary union instance:
It is possible to define sub-subclasses of structures, they inherit the fields of the base class. If the subclass definition has a separate _fields_ variable, the fields specified in this are appended to the fields of the base class.
Structure and union constructors accept both positional and keyword arguments. Positional arguments are used to initialize member fields in the same order as they are appear in _fields_. Keyword arguments in the constructor are interpreted as attribute assignments, so they will initialize _fields_ with the same name, or create new attributes for names not present in _fields_.


An optional sequence that lists the names of unnamed (anonymous) fields. _anonymous_ must be already defined when _fields_ is assigned, otherwise it will have no effect.
The fields listed in this variable must be structure or union type fields. ctypes will create descriptors in the structure type that allows accessing the nested fields directly, without the need to create the structure or union field.
Here is an example type (Windows):
The TYPEDESC structure describes a COM data type, the vt field specifies which one of the union fields is valid. Since the u field is defined as anonymous field, it is now possible to access the members directly off the TYPEDESC instance. td.lptdesc and td.u.lptdesc are equivalent, but the former is faster since it does not need to create a temporary union instance:


A sequence defining the structure fields. The items must be 2-tuples or 3-tuples. The first item is the name of the field, the second item specifies the type of the field; it can be any ctypes data type.
For integer type fields like c_int, a third optional item can be given. It must be a small positive integer defining the bit width of the field.
Field names must be unique within one structure or union. This is not checked, only one field can be accessed when names are repeated.
It is possible to define the _fields_ class variable after the class statement that defines the Structure subclass, this allows creating data types that directly or indirectly reference themselves:
The _fields_ class variable must, however, be defined before the type is first used (an instance is created, sizeof() is called on it, and so on). Later assignments to the _fields_ class variable will raise an AttributeError.
It is possible to define sub-subclasses of structure types, they inherit the fields of the base class plus the _fields_ defined in the sub-subclass, if any.


An optional small integer that allows overriding the alignment of structure fields in the instance. _pack_ must already be defined when _fields_ is assigned, otherwise it will have no effect.


Abstract base class for unions in native byte order.


Try to find a library and return a pathname. name is the library name without any prefix like lib, suffix like .so, .dylib or version number (this is the form used for the posix linker option -l). If no library can be found, returns None.
The exact functionality is system dependent.


Windows only: return the filename of the VC runtime library used by Python, and by the extension modules. If the name of the library cannot be determined, None is returned.
If you need to free memory, for example, allocated by an extension module with a call to the free(void *), it is important that you use the function in the same library that allocated the memory.


Windows only: Instances of this class represent loaded shared libraries, functions in these libraries use the stdcall calling convention, and are assumed to return int by default.
On Windows CE only the standard calling convention is used, for convenience the WinDLL and OleDLL use the standard calling convention on this platform.


Windows only: this function is probably the worst-named thing in ctypes. It creates an instance of OSError. If code is not specified, GetLastError is called to determine the error code. If descr is not specified, FormatError() is called to get a textual description of the error.
Changed in version 3.3: An instance of WindowsError used to be created.


Windows only: The returned function prototype creates functions that use the stdcall calling convention, except on Windows CE where WINFUNCTYPE() is the same as CFUNCTYPE(). The function will release the GIL during the call. use_errno and use_last_error have the same meaning as above.


This function returns the wide character string starting at memory address address as a string. If size is specified, it is used as the number of characters of the string, otherwise the string is assumed to be zero-terminated.
Raises an auditing event ctypes.wstring_at with arguments address, size.


This non-public class is the common base class of all ctypes data types. Among other things, all ctypes type instances contain a memory block that hold C compatible data; the address of the memory block is returned by the addressof() helper function. Another instance variable is exposed as _objects; this contains other Python objects that need to be kept alive in case the memory block contains pointers.
Common methods of ctypes data types, these are all class methods (to be exact, they are methods of the metaclass):
This method returns a ctypes instance that shares the buffer of the source object. The source object must support the writeable buffer interface. The optional offset parameter specifies an offset into the source buffer in bytes; the default is zero. If the source buffer is not large enough a ValueError is raised.
Raises an auditing event ctypes.cdata/buffer with arguments pointer, size, offset.
This method creates a ctypes instance, copying the buffer from the source object buffer which must be readable. The optional offset parameter specifies an offset into the source buffer in bytes; the default is zero. If the source buffer is not large enough a ValueError is raised.
Raises an auditing event ctypes.cdata/buffer with arguments pointer, size, offset.
This method returns a ctypes type instance using the memory specified by address which must be an integer.
This method, and others that indirectly call this method, raises an auditing event ctypes.cdata with argument address.
This method adapts obj to a ctypes type. It is called with the actual object used in a foreign function call when the type is present in the foreign function’s argtypes tuple; it must return an object that can be used as a function call parameter.
All ctypes data types have a default implementation of this classmethod that normally returns obj if that is an instance of the type. Some types accept other objects as well.
This method returns a ctypes type instance exported by a shared library. name is the name of the symbol that exports the data, library is the loaded shared library.
Common instance variables of ctypes data types:
Sometimes ctypes data instances do not own the memory block they contain, instead they share part of the memory block of a base object. The _b_base_ read-only member is the root ctypes object that owns the memory block.
This read-only variable is true when the ctypes data instance has allocated the memory block itself, false otherwise.
This member is either None or a dictionary containing Python objects that need to be kept alive so that the memory block contents is kept valid. This object is only exposed for debugging; never modify the contents of this dictionary.


This method returns a ctypes type instance using the memory specified by address which must be an integer.
This method, and others that indirectly call this method, raises an auditing event ctypes.cdata with argument address.


This method returns a ctypes instance that shares the buffer of the source object. The source object must support the writeable buffer interface. The optional offset parameter specifies an offset into the source buffer in bytes; the default is zero. If the source buffer is not large enough a ValueError is raised.
Raises an auditing event ctypes.cdata/buffer with arguments pointer, size, offset.


This method creates a ctypes instance, copying the buffer from the source object buffer which must be readable. The optional offset parameter specifies an offset into the source buffer in bytes; the default is zero. If the source buffer is not large enough a ValueError is raised.
Raises an auditing event ctypes.cdata/buffer with arguments pointer, size, offset.


This method adapts obj to a ctypes type. It is called with the actual object used in a foreign function call when the type is present in the foreign function’s argtypes tuple; it must return an object that can be used as a function call parameter.
All ctypes data types have a default implementation of this classmethod that normally returns obj if that is an instance of the type. Some types accept other objects as well.


This method returns a ctypes type instance exported by a shared library. name is the name of the symbol that exports the data, library is the loaded shared library.


Sometimes ctypes data instances do not own the memory block they contain, instead they share part of the memory block of a base object. The _b_base_ read-only member is the root ctypes object that owns the memory block.


This read-only variable is true when the ctypes data instance has allocated the memory block itself, false otherwise.


This member is either None or a dictionary containing Python objects that need to be kept alive so that the memory block contents is kept valid. This object is only exposed for debugging; never modify the contents of this dictionary.


Base class for C callable foreign functions.
Instances of foreign functions are also C compatible data types; they represent C function pointers.
This behavior can be customized by assigning to special attributes of the foreign function object.
Assign a ctypes type to specify the result type of the foreign function. Use None for void, a function not returning anything.
It is possible to assign a callable Python object that is not a ctypes type, in this case the function is assumed to return a C int, and the callable will be called with this integer, allowing further processing or error checking. Using this is deprecated, for more flexible post processing or error checking use a ctypes data type as restype and assign a callable to the errcheck attribute.
Assign a tuple of ctypes types to specify the argument types that the function accepts. Functions using the stdcall calling convention can only be called with the same number of arguments as the length of this tuple; functions using the C calling convention accept additional, unspecified arguments as well.
When a foreign function is called, each actual argument is passed to the from_param() class method of the items in the argtypes tuple, this method allows adapting the actual argument to an object that the foreign function accepts. For example, a c_char_p item in the argtypes tuple will convert a string passed as argument into a bytes object using ctypes conversion rules.
New: It is now possible to put items in argtypes which are not ctypes types, but each item must have a from_param() method which returns a value usable as argument (integer, string, ctypes instance). This allows defining adapters that can adapt custom objects as function parameters.
Assign a Python function or another callable to this attribute. The callable will be called with three or more arguments:
result is what the foreign function returns, as specified by the restype attribute.
func is the foreign function object itself, this allows reusing the same callable object to check or post process the results of several functions.
arguments is a tuple containing the parameters originally passed to the function call, this allows specializing the behavior on the arguments used.
The object that this function returns will be returned from the foreign function call, but it can also check the result value and raise an exception if the foreign function call failed.


Assign a tuple of ctypes types to specify the argument types that the function accepts. Functions using the stdcall calling convention can only be called with the same number of arguments as the length of this tuple; functions using the C calling convention accept additional, unspecified arguments as well.
When a foreign function is called, each actual argument is passed to the from_param() class method of the items in the argtypes tuple, this method allows adapting the actual argument to an object that the foreign function accepts. For example, a c_char_p item in the argtypes tuple will convert a string passed as argument into a bytes object using ctypes conversion rules.
New: It is now possible to put items in argtypes which are not ctypes types, but each item must have a from_param() method which returns a value usable as argument (integer, string, ctypes instance). This allows defining adapters that can adapt custom objects as function parameters.


Assign a Python function or another callable to this attribute. The callable will be called with three or more arguments:
result is what the foreign function returns, as specified by the restype attribute.
func is the foreign function object itself, this allows reusing the same callable object to check or post process the results of several functions.
arguments is a tuple containing the parameters originally passed to the function call, this allows specializing the behavior on the arguments used.
The object that this function returns will be returned from the foreign function call, but it can also check the result value and raise an exception if the foreign function call failed.


Assign a ctypes type to specify the result type of the foreign function. Use None for void, a function not returning anything.
It is possible to assign a callable Python object that is not a ctypes type, in this case the function is assumed to return a C int, and the callable will be called with this integer, allowing further processing or error checking. Using this is deprecated, for more flexible post processing or error checking use a ctypes data type as restype and assign a callable to the errcheck attribute.


Private, abstract base class for pointers.
Concrete pointer types are created by calling POINTER() with the type that will be pointed to; this is done automatically by pointer().
If a pointer points to an array, its elements can be read and written using standard subscript and slice accesses. Pointer objects have no size, so len() will raise TypeError. Negative subscripts will read from the memory before the pointer (as in C), and out-of-range subscripts will probably crash with an access violation (if you’re lucky).
Specifies the type pointed to.
Returns the object to which to pointer points. Assigning to this attribute changes the pointer to point to the assigned object.


Returns the object to which to pointer points. Assigning to this attribute changes the pointer to point to the assigned object.


This non-public class is the base class of all fundamental ctypes data types. It is mentioned here because it contains the common attributes of the fundamental ctypes data types. _SimpleCData is a subclass of _CData, so it inherits their methods and attributes. ctypes data types that are not and do not contain pointers can now be pickled.
Instances have a single attribute:
This attribute contains the actual value of the instance. For integer and pointer types, it is an integer, for character types, it is a single character bytes object or string, for character pointer types it is a Python bytes object or string.
When the value attribute is retrieved from a ctypes instance, usually a new object is returned each time. ctypes does not implement original object return, always a new object is constructed. The same is true for all other ctypes object instances.


This attribute contains the actual value of the instance. For integer and pointer types, it is an integer, for character types, it is a single character bytes object or string, for character pointer types it is a Python bytes object or string.
When the value attribute is retrieved from a ctypes instance, usually a new object is returned each time. ctypes does not implement original object return, always a new object is constructed. The same is true for all other ctypes object instances.


The curses module provides an interface to the curses library, the de-facto standard for portable advanced terminal handling.
While curses is most widely used in the Unix environment, versions are available for Windows, DOS, and possibly other systems as well. This extension module is designed to match the API of ncurses, an open-source curses library hosted on Linux and the BSD variants of Unix.
Note
Whenever the documentation mentions a character it can be specified as an integer, a one-character Unicode string or a one-byte byte string.
Whenever the documentation mentions a character string it can be specified as a Unicode string or a byte string.
Note
Since version 5.4, the ncurses library decides how to interpret non-ASCII data using the nl_langinfo function. That means that you have to call locale.setlocale() in the application and encode Unicode strings using one of the system’s available encodings. This example uses the system’s default encoding:
Then use code as the encoding for str.encode() calls.
See also
Utilities for working with ASCII characters, regardless of your locale settings.
A panel stack extension that adds depth to curses windows.
Editable text widget for curses supporting Emacs-like bindings.
Tutorial material on using curses with Python, by Andrew Kuchling and Eric Raymond.
The Tools/demo/ directory in the Python source distribution contains some example programs using the curses bindings provided by this module.
The module curses defines the following exception:
Exception raised when a curses library function returns an error.
Note
Whenever x or y arguments to a function or a method are optional, they default to the current cursor location. Whenever attr is optional, it defaults to A_NORMAL.
The module curses defines the following functions:
Return the output speed of the terminal in bits per second. On software terminal emulators it will have a fixed high value. Included for historical reasons; in former times, it was used to write output loops for time delays and occasionally to change interfaces depending on the line speed.
Emit a short attention sound.
Return True or False, depending on whether the programmer can change the colors displayed by the terminal.
Enter cbreak mode. In cbreak mode (sometimes called “rare” mode) normal tty line buffering is turned off and characters are available to be read one by one. However, unlike raw mode, special characters (interrupt, quit, suspend, and flow control) retain their effects on the tty driver and calling program. Calling first raw() then cbreak() leaves the terminal in cbreak mode.
Return the intensity of the red, green, and blue (RGB) components in the color color_number, which must be between 0 and COLORS - 1. Return a 3-tuple, containing the R,G,B values for the given color, which will be between 0 (no component) and 1000 (maximum amount of component).
Return the attribute value for displaying text in the specified color pair. Only the first 256 color pairs are supported. This attribute value can be combined with A_STANDOUT, A_REVERSE, and the other A_* attributes. pair_number() is the counterpart to this function.
Set the cursor state. visibility can be set to 0, 1, or 2, for invisible, normal, or very visible. If the terminal supports the visibility requested, return the previous cursor state; otherwise raise an exception. On many terminals, the “visible” mode is an underline cursor and the “very visible” mode is a block cursor.
Save the current terminal mode as the “program” mode, the mode when the running program is using curses. (Its counterpart is the “shell” mode, for when the program is not in curses.) Subsequent calls to reset_prog_mode() will restore this mode.
Save the current terminal mode as the “shell” mode, the mode when the running program is not using curses. (Its counterpart is the “program” mode, when the program is using curses capabilities.) Subsequent calls to reset_shell_mode() will restore this mode.
Insert an ms millisecond pause in output.
Update the physical screen. The curses library keeps two data structures, one representing the current physical screen contents and a virtual screen representing the desired next state. The doupdate() ground updates the physical screen to match the virtual screen.
The virtual screen may be updated by a noutrefresh() call after write operations such as addstr() have been performed on a window. The normal refresh() call is simply noutrefresh() followed by doupdate(); if you have to update multiple windows, you can speed performance and perhaps reduce screen flicker by issuing noutrefresh() calls on all windows, followed by a single doupdate().
Enter echo mode. In echo mode, each character input is echoed to the screen as it is entered.
De-initialize the library, and return terminal to normal status.
Return the user’s current erase character as a one-byte bytes object. Under Unix operating systems this is a property of the controlling tty of the curses program, and is not set by the curses library itself.
The filter() routine, if used, must be called before initscr() is called. The effect is that, during those calls, 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 character-at-a-time line editing without touching the rest of the screen.
Flash the screen. That is, change it to reverse-video and then change it back in a short interval. Some people prefer such as ‘visible bell’ to the audible attention signal produced by beep().
Flush all input buffers. This throws away any typeahead that has been typed by the user and has not yet been processed by the program.
After getch() returns KEY_MOUSE to signal a mouse event, this method should be called to retrieve the queued mouse event, represented as a 5-tuple (id, x, y, z, bstate). id is an ID value used to distinguish multiple devices, and x, y, z are the event’s coordinates. (z is currently unused.) bstate is an integer value whose bits will be set to indicate the type of event, and will be the bitwise OR of one or more of the following constants, where n is the button number from 1 to 4: BUTTONn_PRESSED, BUTTONn_RELEASED, BUTTONn_CLICKED, BUTTONn_DOUBLE_CLICKED, BUTTONn_TRIPLE_CLICKED, BUTTON_SHIFT, BUTTON_CTRL, BUTTON_ALT.
Return the current coordinates of the virtual screen cursor as a tuple (y, x). If leaveok is currently True, then return (-1, -1).
Read window related data stored in the file by an earlier putwin() call. The routine then creates and initializes a new window using that data, returning the new window object.
Return True if the terminal can display colors; otherwise, return False.
Return True if the terminal has insert- and delete-character capabilities. This function is included for historical reasons only, as all modern software terminal emulators have such capabilities.
Return True if the terminal has insert- and delete-line capabilities, or can simulate them using scrolling regions. This function is included for historical reasons only, as all modern software terminal emulators have such capabilities.
Take a key value ch, and return True if the current terminal type recognizes a key with that value.
Used for half-delay mode, which is similar to cbreak mode in that characters typed by the user are immediately available to the program. However, after blocking for tenths tenths of seconds, raise an exception if nothing has been typed. The value of tenths must be a number between 1 and 255. Use nocbreak() to leave half-delay mode.
Change the definition of a color, taking the number of the color to be changed followed by three RGB values (for the amounts of red, green, and blue components). The value of color_number must be between 0 and COLORS - 1. Each of r, g, b, must be a value between 0 and 1000. When init_color() is used, all occurrences of that color on the screen immediately change to the new definition. This function is a no-op on most terminals; it is active only if can_change_color() returns True.
Change the definition of a color-pair. It takes three arguments: the number of the color-pair to be changed, the foreground color number, and the background color number. The value of pair_number must be between 1 and COLOR_PAIRS - 1 (the 0 color pair is wired to white on black and cannot be changed). The value of fg and bg arguments must be between 0 and COLORS - 1, or, after calling use_default_colors(), -1. If the color-pair was previously initialized, the screen is refreshed and all occurrences of that color-pair are changed to the new definition.
Initialize the library. Return a window object which represents the whole screen.
Note
If there is an error opening the terminal, the underlying curses library may cause the interpreter to exit.
Return True if resize_term() would modify the window structure, False otherwise.
Return True if endwin() has been called (that is, the curses library has been deinitialized).
Return the name of the key numbered k as a bytes object. The name of a key generating printable ASCII character is the key’s character. The name of a control-key combination is a two-byte bytes object consisting of a caret (b'^') followed by the corresponding printable ASCII character. The name of an alt-key combination (128–255) is a bytes object consisting of the prefix b'M-' followed by the name of the corresponding ASCII character.
Return the user’s current line kill character as a one-byte bytes object. Under Unix operating systems this is a property of the controlling tty of the curses program, and is not set by the curses library itself.
Return a bytes object containing the terminfo long name field describing the current terminal. The maximum length of a verbose description is 128 characters. It is defined only after the call to initscr().
If flag is True, allow 8-bit characters to be input. If flag is False, allow only 7-bit chars.
Set the maximum time in milliseconds that can elapse between press and release events in order for them to be recognized as a click, and return the previous interval value. The default value is 200 msec, or one fifth of a second.
Set the mouse events to be reported, and return a tuple (availmask,
oldmask). availmask indicates which of the specified mouse events can be reported; on complete failure it returns 0. oldmask is the previous value of the given window’s mouse event mask. If this function is never called, no mouse events are ever reported.
Sleep for ms milliseconds.
Create and return a pointer to a new pad data structure with the given number of lines and columns. Return a pad as a window object.
A pad is like a window, except that it is not restricted by the screen size, and is not necessarily associated with a particular part of the screen. Pads can be used when a large window is needed, and only a part of the window will be on the screen at one time. Automatic refreshes of pads (such as from scrolling or echoing of input) do not occur. The refresh() and noutrefresh() methods of a pad require 6 arguments to specify the part of the pad to be displayed and the location on the screen to be used for the display. The arguments are pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol; the p arguments refer to the upper left corner of the pad region to be displayed and the s arguments define a clipping box on the screen within which the pad region is to be displayed.
Return a new window, whose left-upper corner is at (begin_y, begin_x), and whose height/width is nlines/ncols.
By default, the window will extend from the specified position to the lower right corner of the screen.
Enter newline mode. This mode translates the return key into newline on input, and translates newline into return and line-feed on output. Newline mode is initially on.
Leave cbreak mode. Return to normal “cooked” mode with line buffering.
Leave echo mode. Echoing of input characters is turned off.
Leave newline mode. Disable translation of return into newline on input, and disable low-level translation of newline into newline/return on output (but this does not change the behavior of addch('\n'), which always does the equivalent of return and line feed on the virtual screen). With translation off, curses can sometimes speed up vertical motion a little; also, it will be able to detect the return key on input.
When the noqiflush() routine is used, normal flush of input and output queues associated with the INTR, QUIT and SUSP characters will not be done. You may want to call noqiflush() in a signal handler if you want output to continue as though the interrupt had not occurred, after the handler exits.
Leave raw mode. Return to normal “cooked” mode with line buffering.
Return a tuple (fg, bg) containing the colors for the requested color pair. The value of pair_number must be between 0 and COLOR_PAIRS - 1.
Return the number of the color-pair set by the attribute value attr. color_pair() is the counterpart to this function.
Equivalent to tputs(str, 1, putchar); emit the value of a specified terminfo capability for the current terminal. Note that the output of putp() always goes to standard output.
If flag is False, the effect is the same as calling noqiflush(). If flag is True, or no argument is provided, the queues will be flushed when these control characters are read.
Enter raw mode. In raw mode, normal line buffering and processing of interrupt, quit, suspend, and flow control keys are turned off; characters are presented to curses input functions one by one.
Restore the terminal to “program” mode, as previously saved by def_prog_mode().
Restore the terminal to “shell” mode, as previously saved by def_shell_mode().
Restore the state of the terminal modes to what it was at the last call to savetty().
Backend function used by resizeterm(), performing most of the work; when resizing the windows, resize_term() blank-fills the areas that are extended. The calling application should fill in these areas with appropriate data. The resize_term() function attempts to resize all windows. However, due to the calling convention of pads, it is not possible to resize these without additional interaction with the application.
Resize the standard and current windows to the specified dimensions, and adjusts other bookkeeping data used by the curses library that record the window dimensions (in particular the SIGWINCH handler).
Save the current state of the terminal modes in a buffer, usable by resetty().
Retrieves the value set by set_escdelay().
New in version 3.9.
Sets the number of milliseconds to wait after reading an escape character, to distinguish between an individual escape character entered on the keyboard from escape sequences sent by cursor and function keys.
New in version 3.9.
Retrieves the value set by set_tabsize().
New in version 3.9.
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.
New in version 3.9.
Set the virtual screen cursor to y, x. If y and x are both -1, then leaveok is set True.
Initialize the terminal. term is a string giving the terminal name, or None; if omitted or None, the value of the TERM environment variable will be used. fd is the file descriptor to which any initialization sequences will be sent; if not supplied or -1, the file descriptor for sys.stdout will be used.
Must be called if the programmer wants to use colors, and before any other color manipulation routine is called. It is good practice to call this routine right after initscr().
start_color() initializes eight basic colors (black, red, green, yellow, blue, magenta, cyan, and white), and two global variables in the curses module, COLORS and COLOR_PAIRS, containing the maximum number of colors and color-pairs the terminal can support. It also restores the colors on the terminal to the values they had when the terminal was just turned on.
Return a logical OR of all video attributes supported by the terminal. This information is useful when a curses program needs complete control over the appearance of the screen.
Return the value of the environment variable TERM, as a bytes object, truncated to 14 characters.
Return the value of the Boolean capability corresponding to the terminfo capability name capname as an integer. Return the value -1 if capname is not a Boolean capability, or 0 if it is canceled or absent from the terminal description.
Return the value of the numeric capability corresponding to the terminfo capability name capname as an integer. Return the value -2 if capname is not a numeric capability, or -1 if it is canceled or absent from the terminal description.
Return the value of the string capability corresponding to the terminfo capability name capname as a bytes object. Return None if capname is not a terminfo “string capability”, or is canceled or absent from the terminal description.
Instantiate the bytes object str with the supplied parameters, where str should be a parameterized string obtained from the terminfo database. E.g. tparm(tigetstr("cup"), 5, 3) could result in b'\033[6;4H', the exact result depending on terminal type.
Specify that the file descriptor fd be used for typeahead checking. If fd is -1, then no typeahead checking is done.
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.
Return a bytes object which is a printable representation of the character ch. Control characters are represented as a caret followed by the character, for example as b'^C'. Printing characters are left as they are.
Push ch so the next getch() will return it.
Note
Only one ch can be pushed before getch() is called.
Update LINES and COLS. Useful for detecting manual screen resize.
New in version 3.5.
Push ch so the next get_wch() will return it.
Note
Only one ch can be pushed before get_wch() is called.
New in version 3.3.
Push a KEY_MOUSE event onto the input queue, associating the given state data with it.
If used, this function should be called before initscr() or newterm are called. When flag is False, the values of lines and columns specified in the terminfo database will be used, even if environment variables LINES and 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 LINES and COLUMNS are not set).
Allow use of default values for colors on terminals supporting this feature. Use this to support transparency in your application. The default color is assigned to the color number -1. After calling this function, init_pair(x,
curses.COLOR_RED, -1) initializes, for instance, color pair x to a red foreground color on the default background.
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 wrapper(). Before calling 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.
Window objects, as returned by initscr() and newwin() above, have the following methods and attributes:
Paint character ch at (y, x) with attributes attr, overwriting any character previously painted at that location. By default, the character position and attributes are the current settings for the window object.
Note
Writing outside the window, subwindow, or pad raises a curses.error. Attempting to write to the lower right corner of a window, subwindow, or pad will cause an exception to be raised after the character is printed.
Paint at most n characters of the character string str at (y, x) with attributes attr, overwriting anything previously on the display.
Paint the character string str at (y, x) with attributes attr, overwriting anything previously on the display.
Note
Remove attribute attr from the “background” set applied to all writes to the current window.
Add attribute attr from the “background” set applied to all writes to the current window.
Set the “background” set of attributes to attr. This set is initially 0 (no attributes).
Set the background property of the window to the character ch, with attributes attr. The change is then applied to every character position in that window:
Set the window’s background. A window’s background consists of a character and any combination of attributes. The attribute part of the background is combined (OR’ed) with all non-blank characters that are written into the window. Both the character and attribute parts of the background are combined with the blank characters. The background becomes a property of the character and moves with the character through any scrolling and insert/delete line/character operations.
Draw a border around the edges of the window. Each parameter specifies the character to use for a specific part of the border; see the table below for more details.
Note
A 0 value for any parameter will cause the default character to be used for that parameter. Keyword parameters can not be used. The defaults are listed in this table:
Parameter
Description
Default value
ls
Left side
ACS_VLINE
rs
Right side
ACS_VLINE
ts
Top
ACS_HLINE
bs
Bottom
ACS_HLINE
tl
Upper-left corner
ACS_ULCORNER
tr
Upper-right corner
ACS_URCORNER
bl
Bottom-left corner
ACS_LLCORNER
br
Bottom-right corner
ACS_LRCORNER
Similar to border(), but both ls and rs are vertch and both ts and bs are horch. The default corner characters are always used by this function.
Set the attributes of num characters at the current cursor position, or at position (y, x) if supplied. If num is not given or is -1, the attribute will be set on all the characters to the end of the line. This function moves cursor to position (y, x) if supplied. The changed line will be touched using the touchline() method so that the contents will be redisplayed by the next window refresh.
Like erase(), but also cause the whole window to be repainted upon next call to refresh().
If flag is True, the next call to refresh() will clear the window completely.
Erase from cursor to the end of the window: all lines below the cursor are deleted, and then the equivalent of clrtoeol() is performed.
Erase from cursor to the end of the line.
Update the current cursor position of all the ancestors of the window to reflect the current cursor position of the window.
Delete any character at (y, x).
Delete the line under the cursor. All following lines are moved up by one line.
An abbreviation for “derive window”, derwin() is the same as calling subwin(), except that begin_y and begin_x are relative to the origin of the window, rather than relative to the entire screen. Return a window object for the derived window.
Add character ch with attribute attr, and immediately call refresh() on the window.
Test whether the given pair of screen-relative character-cell coordinates are enclosed by the given window, returning True or False. It is useful for determining what subset of the screen windows enclose the location of a mouse event.
Encoding used to encode method arguments (Unicode strings and characters). The encoding attribute is inherited from the parent window when a subwindow is created, for example with window.subwin(). By default, the locale encoding is used (see locale.getpreferredencoding()).
New in version 3.3.
Clear the window.
Return a tuple (y, x) of co-ordinates of upper-left corner.
Return the given window’s current background character/attribute pair.
Get a character. Note that the integer returned does not have to be in ASCII range: function keys, keypad keys and so on are represented by numbers higher than 255. In no-delay mode, return -1 if there is no input, otherwise wait until a key is pressed.
Get a wide character. Return a character for most keys, or an integer for function keys, keypad keys, and other special keys. In no-delay mode, raise an exception if there is no input.
New in version 3.3.
Get a character, returning a string instead of an integer, as getch() does. Function keys, keypad keys and other special keys return a multibyte string containing the key name. In no-delay mode, raise an exception if there is no input.
Return a tuple (y, x) of the height and width of the window.
Return the beginning coordinates of this window relative to its parent window as a tuple (y, x). Return (-1, -1) if this window has no parent.
Read a bytes object from the user, with primitive line editing capacity.
Return a tuple (y, x) of current cursor position relative to the window’s upper-left corner.
Display a horizontal line starting at (y, x) with length n consisting of the character ch.
If flag is False, curses no longer considers using the hardware insert/delete character feature of the terminal; if flag is True, use of character insertion and deletion is enabled. When curses is first initialized, use of character insert/delete is enabled by default.
If flag is True, curses will try and use hardware line editing facilities. Otherwise, line insertion/deletion are disabled.
If flag is True, any change in the window image automatically causes the window to be refreshed; you no longer have to call refresh() yourself. However, it may degrade performance considerably, due to repeated calls to wrefresh. This option is disabled by default.
Return the character at the given position in the window. The bottom 8 bits are the character proper, and upper bits are the attributes.
Paint character ch at (y, x) with attributes attr, moving the line from position x right by one character.
Insert nlines lines into the specified window above the current line. The nlines bottom lines are lost. For negative nlines, delete nlines lines starting with the one under the cursor, and move the remaining lines up. The bottom nlines lines are cleared. The current cursor position remains the same.
Insert a blank line under the cursor. All following lines are moved down by one line.
Insert a character string (as many characters as will fit on the line) before the character under the cursor, up to n characters. If n is zero or negative, the entire string is inserted. All characters to the right of the cursor are shifted right, with the rightmost characters on the line being lost. The cursor position does not change (after moving to y, x, if specified).
Insert a character string (as many characters as will fit on the line) before the character under the cursor. All characters to the right of the cursor are shifted right, with the rightmost characters on the line being lost. The cursor position does not change (after moving to y, x, if specified).
Return a bytes object of characters, extracted from the window starting at the current cursor position, or at y, x if specified. Attributes are stripped from the characters. If n is specified, instr() returns a string at most n characters long (exclusive of the trailing NUL).
Return True if the specified line was modified since the last call to refresh(); otherwise return False. Raise a curses.error exception if line is not valid for the given window.
Return True if the specified window was modified since the last call to refresh(); otherwise return False.
If flag is True, escape sequences generated by some keys (keypad, function keys) will be interpreted by curses. If flag is False, escape sequences will be left as is in the input stream.
If flag is True, cursor is left where it is on update, instead of being at “cursor position.” This reduces cursor movement where possible. If possible the cursor will be made invisible.
If flag is False, cursor will always be at “cursor position” after an update.
Move cursor to (new_y, new_x).
Move the window inside its parent window. The screen-relative parameters of the window are not changed. This routine is used to display different parts of the parent window at the same physical position on the screen.
Move the window so its upper-left corner is at (new_y, new_x).
If flag is True, getch() will be non-blocking.
If flag is True, escape sequences will not be timed out.
If flag is False, after a few milliseconds, an escape sequence will not be interpreted, and will be left in the input stream as is.
Mark for refresh but wait. This function updates the data structure representing the desired state of the window, but does not force an update of the physical screen. To accomplish that, call doupdate().
Overlay the window on top of destwin. The windows need not be the same size, only the overlapping region is copied. This copy is non-destructive, which means that the current background character does not overwrite the old contents of destwin.
To get fine-grained control over the copied region, the second form of overlay() can be used. sminrow and smincol are the upper-left coordinates of the source window, and the other variables mark a rectangle in the destination window.
Overwrite the window on top of destwin. The windows need not be the same size, in which case only the overlapping region is copied. This copy is destructive, which means that the current background character overwrites the old contents of destwin.
To get fine-grained control over the copied region, the second form of overwrite() can be used. sminrow and smincol are the upper-left coordinates of the source window, the other variables mark a rectangle in the destination window.
Write all data associated with the window into the provided file object. This information can be later retrieved using the getwin() function.
Indicate that the num screen lines, starting at line beg, are corrupted and should be completely redrawn on the next refresh() call.
Touch the entire window, causing it to be completely redrawn on the next refresh() call.
Update the display immediately (sync actual screen with previous drawing/deleting methods).
The 6 optional arguments can only be specified when the window is a pad created with newpad(). The additional parameters are needed to indicate what part of the pad and screen are involved. pminrow and pmincol specify the upper left-hand corner of the rectangle to be displayed in the pad. sminrow, smincol, smaxrow, and smaxcol specify the edges of the rectangle to be displayed on the screen. The lower right-hand corner of the rectangle to be displayed in the pad is calculated from the screen coordinates, since the rectangles must be the same size. Both rectangles must be entirely contained within their respective structures. Negative values of pminrow, pmincol, sminrow, or smincol are treated as if they were zero.
Reallocate storage for a curses window to adjust its dimensions to the specified values. If either dimension is larger than the current values, the window’s data is filled with blanks that have the current background rendition (as set by bkgdset()) merged into them.
Scroll the screen or scrolling region upward by lines lines.
Control what happens when the cursor of a window is moved off the edge of the window or scrolling region, either as a result of a newline action on the bottom line, or typing the last character of the last line. If flag is False, the cursor is left on the bottom line. If flag is True, the window is scrolled up one line. Note that in order to get the physical scrolling effect on the terminal, it is also necessary to call idlok().
Set the scrolling region from line top to line bottom. All scrolling actions will take place in this region.
Turn off the standout attribute. On some terminals this has the side effect of turning off all attributes.
Turn on attribute A_STANDOUT.
Return a sub-window, whose upper-left corner is at (begin_y, begin_x), and whose width/height is ncols/nlines.
Return a sub-window, whose upper-left corner is at (begin_y, begin_x), and whose width/height is ncols/nlines.
By default, the sub-window will extend from the specified position to the lower right corner of the window.
Touch each location in the window that has been touched in any of its ancestor windows. This routine is called by refresh(), so it should almost never be necessary to call it manually.
If flag is True, then syncup() is called automatically whenever there is a change in the window.
Touch all locations in ancestors of the window that have been changed in the window.
Set blocking or non-blocking read behavior for the window. If delay is negative, blocking read is used (which will wait indefinitely for input). If delay is zero, then non-blocking read is used, and getch() will return -1 if no input is waiting. If delay is positive, then getch() will block for delay milliseconds, and return -1 if there is still no input at the end of that time.
Pretend count lines have been changed, starting with line start. If changed is supplied, it specifies whether the affected lines are marked as having been changed (changed=True) or unchanged (changed=False).
Pretend the whole window has been changed, for purposes of drawing optimizations.
Mark all lines in the window as unchanged since the last call to refresh().
Display a vertical line starting at (y, x) with length n consisting of the character ch.
The curses module defines the following data members:
Some curses routines that return an integer, such as getch(), return ERR upon failure.
Some curses routines that return an integer, such as napms(), return OK upon success.
A bytes object representing the current version of the module. Also available as __version__.
A named tuple containing the three components of the ncurses library version: major, minor, and patch. All values are integers. The components can also be accessed by name, so curses.ncurses_version[0] is equivalent to curses.ncurses_version.major and so on.
Availability: if the ncurses library is used.
New in version 3.8.
Some constants are available to specify character cell attributes. The exact constants available are system dependent.
Attribute
Meaning
A_ALTCHARSET
Alternate character set mode
A_BLINK
Blink mode
A_BOLD
Bold mode
A_DIM
Dim mode
A_INVIS
Invisible or blank mode
A_ITALIC
Italic mode
A_NORMAL
Normal attribute
A_PROTECT
Protected mode
A_REVERSE
Reverse background and foreground colors
A_STANDOUT
Standout mode
A_UNDERLINE
Underline mode
A_HORIZONTAL
Horizontal highlight
A_LEFT
Left highlight
A_LOW
Low highlight
A_RIGHT
Right highlight
A_TOP
Top highlight
A_VERTICAL
Vertical highlight
A_CHARTEXT
Bit-mask to extract a character
New in version 3.7: A_ITALIC was added.
Several constants are available to extract corresponding attributes returned by some methods.
Bit-mask
Meaning
A_ATTRIBUTES
Bit-mask to extract attributes
A_CHARTEXT
Bit-mask to extract a character
A_COLOR
Bit-mask to extract color-pair field information
Keys are referred to by integer constants with names starting with KEY_. The exact keycaps available are system dependent.
Key constant
Key
KEY_MIN
Minimum key value
KEY_BREAK
Break key (unreliable)
KEY_DOWN
Down-arrow
KEY_UP
Up-arrow
KEY_LEFT
Left-arrow
KEY_RIGHT
Right-arrow
KEY_HOME
Home key (upward+left arrow)
KEY_BACKSPACE
Backspace (unreliable)
KEY_F0
Function keys. Up to 64 function keys are supported.
KEY_Fn
Value of function key n
KEY_DL
Delete line
KEY_IL
Insert line
KEY_DC
Delete character
KEY_IC
Insert char or enter insert mode
KEY_EIC
Exit insert char mode
KEY_CLEAR
Clear screen
KEY_EOS
Clear to end of screen
KEY_EOL
Clear to end of line
KEY_SF
Scroll 1 line forward
KEY_SR
Scroll 1 line backward (reverse)
KEY_NPAGE
Next page
KEY_PPAGE
Previous page
KEY_STAB
Set tab
KEY_CTAB
Clear tab
KEY_CATAB
Clear all tabs
KEY_ENTER
Enter or send (unreliable)
KEY_SRESET
Soft (partial) reset (unreliable)
KEY_RESET
Reset or hard reset (unreliable)
KEY_PRINT
Print
KEY_LL
Home down or bottom (lower left)
KEY_A1
Upper left of keypad
KEY_A3
Upper right of keypad
KEY_B2
Center of keypad
KEY_C1
Lower left of keypad
KEY_C3
Lower right of keypad
KEY_BTAB
Back tab
KEY_BEG
Beg (beginning)
KEY_CANCEL
Cancel
KEY_CLOSE
Close
KEY_COMMAND
Cmd (command)
KEY_COPY
Copy
KEY_CREATE
Create
KEY_END
End
KEY_EXIT
Exit
KEY_FIND
Find
KEY_HELP
Help
KEY_MARK
Mark
KEY_MESSAGE
Message
KEY_MOVE
Move
KEY_NEXT
Next
KEY_OPEN
Open
KEY_OPTIONS
Options
KEY_PREVIOUS
Prev (previous)
KEY_REDO
Redo
KEY_REFERENCE
Ref (reference)
KEY_REFRESH
Refresh
KEY_REPLACE
Replace
KEY_RESTART
Restart
KEY_RESUME
Resume
KEY_SAVE
Save
KEY_SBEG
Shifted Beg (beginning)
KEY_SCANCEL
Shifted Cancel
KEY_SCOMMAND
Shifted Command
KEY_SCOPY
Shifted Copy
KEY_SCREATE
Shifted Create
KEY_SDC
Shifted Delete char
KEY_SDL
Shifted Delete line
KEY_SELECT
Select
KEY_SEND
Shifted End
KEY_SEOL
Shifted Clear line
KEY_SEXIT
Shifted Exit
KEY_SFIND
Shifted Find
KEY_SHELP
Shifted Help
KEY_SHOME
Shifted Home
KEY_SIC
Shifted Input
KEY_SLEFT
Shifted Left arrow
KEY_SMESSAGE
Shifted Message
KEY_SMOVE
Shifted Move
KEY_SNEXT
Shifted Next
KEY_SOPTIONS
Shifted Options
KEY_SPREVIOUS
Shifted Prev
KEY_SPRINT
Shifted Print
KEY_SREDO
Shifted Redo
KEY_SREPLACE
Shifted Replace
KEY_SRIGHT
Shifted Right arrow
KEY_SRSUME
Shifted Resume
KEY_SSAVE
Shifted Save
KEY_SSUSPEND
Shifted Suspend
KEY_SUNDO
Shifted Undo
KEY_SUSPEND
Suspend
KEY_UNDO
Undo
KEY_MOUSE
Mouse event has occurred
KEY_RESIZE
Terminal resize event
KEY_MAX
Maximum key value
On VT100s and their software emulations, such as X terminal emulators, there are normally at least four function keys (KEY_F1, KEY_F2, KEY_F3, KEY_F4) available, and the arrow keys mapped to KEY_UP, KEY_DOWN, KEY_LEFT and KEY_RIGHT in the obvious way. If your machine has a PC keyboard, it is safe to expect arrow keys and twelve function keys (older PC keyboards may have only ten function keys); also, the following keypad mappings are standard:
Keycap
Constant
Insert
KEY_IC
Delete
KEY_DC
Home
KEY_HOME
End
KEY_END
Page Up
KEY_PPAGE
Page Down
KEY_NPAGE
The following table lists characters from the alternate character set. These are inherited from the VT100 terminal, and will generally be available on software emulations such as X terminals. When there is no graphic available, curses falls back on a crude printable ASCII approximation.
Note
These are available only after initscr() has been called.
ACS code
Meaning
ACS_BBSS
alternate name for upper right corner
ACS_BLOCK
solid square block
ACS_BOARD
board of squares
ACS_BSBS
alternate name for horizontal line
ACS_BSSB
alternate name for upper left corner
ACS_BSSS
alternate name for top tee
ACS_BTEE
bottom tee
ACS_BULLET
bullet
ACS_CKBOARD
checker board (stipple)
ACS_DARROW
arrow pointing down
ACS_DEGREE
degree symbol
ACS_DIAMOND
diamond
ACS_GEQUAL
greater-than-or-equal-to
ACS_HLINE
horizontal line
ACS_LANTERN
lantern symbol
ACS_LARROW
left arrow
ACS_LEQUAL
less-than-or-equal-to
ACS_LLCORNER
lower left-hand corner
ACS_LRCORNER
lower right-hand corner
ACS_LTEE
left tee
ACS_NEQUAL
not-equal sign
ACS_PI
letter pi
ACS_PLMINUS
plus-or-minus sign
ACS_PLUS
big plus sign
ACS_RARROW
right arrow
ACS_RTEE
right tee
ACS_S1
scan line 1
ACS_S3
scan line 3
ACS_S7
scan line 7
ACS_S9
scan line 9
ACS_SBBS
alternate name for lower right corner
ACS_SBSB
alternate name for vertical line
ACS_SBSS
alternate name for right tee
ACS_SSBB
alternate name for lower left corner
ACS_SSBS
alternate name for bottom tee
ACS_SSSB
alternate name for left tee
ACS_SSSS
alternate name for crossover or big plus
ACS_STERLING
pound sterling
ACS_TTEE
top tee
ACS_UARROW
up arrow
ACS_ULCORNER
upper left corner
ACS_URCORNER
upper right corner
ACS_VLINE
vertical line
The following table lists the predefined colors:
Constant
Color
COLOR_BLACK
Black
COLOR_BLUE
Blue
COLOR_CYAN
Cyan (light greenish blue)
COLOR_GREEN
Green
COLOR_MAGENTA
Magenta (purplish red)
COLOR_RED
Red
COLOR_WHITE
White
COLOR_YELLOW
Yellow
The curses.textpad module provides a Textbox class that handles elementary text editing in a curses window, supporting a set of keybindings resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x, FrameMaker, and many other programs). The module also provides a rectangle-drawing function useful for framing text boxes or for other purposes.
The module curses.textpad defines the following function:
Draw a rectangle. The first argument must be a window object; the remaining arguments are coordinates relative to that window. The second and third arguments are the y and x coordinates of the upper left hand corner of the rectangle to be drawn; the fourth and fifth arguments are the y and x coordinates of the lower right hand corner. The rectangle will be drawn using VT100/IBM PC forms characters on terminals that make this possible (including xterm and most other software terminal emulators). Otherwise it will be drawn with ASCII dashes, vertical bars, and plus signs.
You can instantiate a Textbox object as follows:
Return a textbox widget object. The win argument should be a curses window object in which the textbox is to be contained. The edit cursor of the textbox is initially located at the upper left hand corner of the containing window, with coordinates (0, 0). The instance’s stripspaces flag is initially on.
Textbox objects have the following methods:
This is the entry point you will normally use. It accepts editing keystrokes until one of the termination keystrokes is entered. If validator is supplied, it must be a function. It will be called for each keystroke entered with the keystroke as a parameter; command dispatch is done on the result. This method returns the window contents as a string; whether blanks in the window are included is affected by the stripspaces attribute.
Process a single command keystroke. Here are the supported special keystrokes:
Keystroke
Action
Control-A
Go to left edge of window.
Control-B
Cursor left, wrapping to previous line if appropriate.
Control-D
Delete character under cursor.
Control-E
Go to right edge (stripspaces off) or end of line (stripspaces on).
Control-F
Cursor right, wrapping to next line when appropriate.
Control-G
Terminate, returning the window contents.
Control-H
Delete character backward.
Control-J
Terminate if the window is 1 line, otherwise insert newline.
Control-K
If line is blank, delete it, otherwise clear to end of line.
Control-L
Refresh screen.
Control-N
Cursor down; move down one line.
Control-O
Insert a blank line at cursor location.
Control-P
Cursor up; move up one line.
Move operations do nothing if the cursor is at an edge where the movement is not possible. The following synonyms are supported where possible:
Constant
Keystroke
KEY_LEFT
Control-B
KEY_RIGHT
Control-F
KEY_UP
Control-P
KEY_DOWN
Control-N
KEY_BACKSPACE
Control-h
All other keystrokes are treated as a command to insert the given character and move right (with line wrapping).
Return the window contents as a string; whether blanks in the window are included is affected by the stripspaces member.
This attribute is a flag which controls the interpretation of blanks in the window. When it is on, trailing blanks on each line are ignored; any 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 contents are gathered.


The curses.ascii module supplies name constants for ASCII characters and functions to test membership in various ASCII character classes. The constants supplied are names for control characters as follows:
Name
Meaning
NUL
SOH
Start of heading, console interrupt
STX
Start of text
ETX
End of text
EOT
End of transmission
ENQ
Enquiry, goes with ACK flow control
ACK
Acknowledgement
BEL
Bell
BS
Backspace
TAB
Tab
HT
Alias for TAB: “Horizontal tab”
LF
Line feed
NL
Alias for LF: “New line”
VT
Vertical tab
FF
Form feed
CR
Carriage return
SO
Shift-out, begin alternate character set
SI
Shift-in, resume default character set
DLE
Data-link escape
DC1
XON, for flow control
DC2
Device control 2, block-mode flow control
DC3
XOFF, for flow control
DC4
Device control 4
NAK
Negative acknowledgement
SYN
Synchronous idle
ETB
End transmission block
CAN
Cancel
EM
End of medium
SUB
Substitute
ESC
Escape
FS
File separator
GS
Group separator
RS
Record separator, block-mode terminator
US
Unit separator
SP
Space
DEL
Delete
Note that many of these have little practical significance in modern usage. The mnemonics derive from teleprinter conventions that predate digital computers.
The module supplies the following functions, patterned on those in the standard C library:
Checks for an ASCII alphanumeric character; it is equivalent to isalpha(c) or
isdigit(c).
Checks for an ASCII alphabetic character; it is equivalent to isupper(c) or
islower(c).
Checks for a character value that fits in the 7-bit ASCII set.
Checks for an ASCII whitespace character; space or horizontal tab.
Checks for an ASCII control character (in the range 0x00 to 0x1f or 0x7f).
Checks for an ASCII decimal digit, '0' through '9'. This is equivalent to c in string.digits.
Checks for ASCII any printable character except space.
Checks for an ASCII lower-case character.
Checks for any ASCII printable character including space.
Checks for any printable ASCII character which is not a space or an alphanumeric character.
Checks for ASCII white-space characters; space, line feed, carriage return, form feed, horizontal tab, vertical tab.
Checks for an ASCII uppercase letter.
Checks for an ASCII hexadecimal digit. This is equivalent to c in
string.hexdigits.
Checks for an ASCII control character (ordinal values 0 to 31).
Checks for a non-ASCII character (ordinal values 0x80 and above).
These functions accept either integers or single-character strings; when the argument is a string, it is first converted using the built-in function ord().
Note that all these functions check ordinal bit values derived from the character of the string you pass in; they do not actually know anything about the host machine’s character encoding.
The following two functions take either a single-character string or integer byte value; they return a value of the same type.
Return the ASCII value corresponding to the low 7 bits of c.
Return the control character corresponding to the given character (the character bit value is bitwise-anded with 0x1f).
Return the 8-bit character corresponding to the given ASCII character (the character bit value is bitwise-ored with 0x80).
The following function takes either a single-character string or integer value; it returns a string.
Return a string representation of the ASCII character c. If c is printable, this string is the character itself. If the character is a control character (0x00–0x1f) the string consists of a caret ('^') followed by the corresponding uppercase letter. If the character is an ASCII delete (0x7f) the string is '^?'. If the character has its meta bit (0x80) set, the meta bit is stripped, the preceding rules applied, and '!' prepended to the result.
A 33-element string array that contains the ASCII mnemonics for the thirty-two ASCII control characters from 0 (NUL) to 0x1f (US), in order, plus the mnemonic SP for the space character.


Return the 8-bit character corresponding to the given ASCII character (the character bit value is bitwise-ored with 0x80).


Return the ASCII value corresponding to the low 7 bits of c.


A 33-element string array that contains the ASCII mnemonics for the thirty-two ASCII control characters from 0 (NUL) to 0x1f (US), in order, plus the mnemonic SP for the space character.


Return the control character corresponding to the given character (the character bit value is bitwise-anded with 0x1f).


Checks for an ASCII alphanumeric character; it is equivalent to isalpha(c) or
isdigit(c).


Checks for an ASCII alphabetic character; it is equivalent to isupper(c) or
islower(c).


Checks for a character value that fits in the 7-bit ASCII set.


Checks for an ASCII whitespace character; space or horizontal tab.


Checks for an ASCII control character (in the range 0x00 to 0x1f or 0x7f).


Checks for an ASCII control character (ordinal values 0 to 31).


Checks for an ASCII decimal digit, '0' through '9'. This is equivalent to c in string.digits.


Checks for ASCII any printable character except space.


Checks for an ASCII lower-case character.


Checks for a non-ASCII character (ordinal values 0x80 and above).


Checks for any ASCII printable character including space.


Checks for any printable ASCII character which is not a space or an alphanumeric character.


Checks for ASCII white-space characters; space, line feed, carriage return, form feed, horizontal tab, vertical tab.


Checks for an ASCII hexadecimal digit. This is equivalent to c in
string.hexdigits.


Return a string representation of the ASCII character c. If c is printable, this string is the character itself. If the character is a control character (0x00–0x1f) the string consists of a caret ('^') followed by the corresponding uppercase letter. If the character is an ASCII delete (0x7f) the string is '^?'. If the character has its meta bit (0x80) set, the meta bit is stripped, the preceding rules applied, and '!' prepended to the result.


Return the output speed of the terminal in bits per second. On software terminal emulators it will have a fixed high value. Included for historical reasons; in former times, it was used to write output loops for time delays and occasionally to change interfaces depending on the line speed.


Return True or False, depending on whether the programmer can change the colors displayed by the terminal.


Enter cbreak mode. In cbreak mode (sometimes called “rare” mode) normal tty line buffering is turned off and characters are available to be read one by one. However, unlike raw mode, special characters (interrupt, quit, suspend, and flow control) retain their effects on the tty driver and calling program. Calling first raw() then cbreak() leaves the terminal in cbreak mode.


Return the intensity of the red, green, and blue (RGB) components in the color color_number, which must be between 0 and COLORS - 1. Return a 3-tuple, containing the R,G,B values for the given color, which will be between 0 (no component) and 1000 (maximum amount of component).


Return the attribute value for displaying text in the specified color pair. Only the first 256 color pairs are supported. This attribute value can be combined with A_STANDOUT, A_REVERSE, and the other A_* attributes. pair_number() is the counterpart to this function.


Set the cursor state. visibility can be set to 0, 1, or 2, for invisible, normal, or very visible. If the terminal supports the visibility requested, return the previous cursor state; otherwise raise an exception. On many terminals, the “visible” mode is an underline cursor and the “very visible” mode is a block cursor.


Save the current terminal mode as the “program” mode, the mode when the running program is using curses. (Its counterpart is the “shell” mode, for when the program is not in curses.) Subsequent calls to reset_prog_mode() will restore this mode.


Save the current terminal mode as the “shell” mode, the mode when the running program is not using curses. (Its counterpart is the “program” mode, when the program is using curses capabilities.) Subsequent calls to reset_shell_mode() will restore this mode.


Insert an ms millisecond pause in output.


Update the physical screen. The curses library keeps two data structures, one representing the current physical screen contents and a virtual screen representing the desired next state. The doupdate() ground updates the physical screen to match the virtual screen.
The virtual screen may be updated by a noutrefresh() call after write operations such as addstr() have been performed on a window. The normal refresh() call is simply noutrefresh() followed by doupdate(); if you have to update multiple windows, you can speed performance and perhaps reduce screen flicker by issuing noutrefresh() calls on all windows, followed by a single doupdate().


Enter echo mode. In echo mode, each character input is echoed to the screen as it is entered.


De-initialize the library, and return terminal to normal status.


Return the user’s current erase character as a one-byte bytes object. Under Unix operating systems this is a property of the controlling tty of the curses program, and is not set by the curses library itself.


Some curses routines that return an integer, such as getch(), return ERR upon failure.


Exception raised when a curses library function returns an error.


The filter() routine, if used, must be called before initscr() is called. The effect is that, during those calls, 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 character-at-a-time line editing without touching the rest of the screen.


Flash the screen. That is, change it to reverse-video and then change it back in a short interval. Some people prefer such as ‘visible bell’ to the audible attention signal produced by beep().


Flush all input buffers. This throws away any typeahead that has been typed by the user and has not yet been processed by the program.


After getch() returns KEY_MOUSE to signal a mouse event, this method should be called to retrieve the queued mouse event, represented as a 5-tuple (id, x, y, z, bstate). id is an ID value used to distinguish multiple devices, and x, y, z are the event’s coordinates. (z is currently unused.) bstate is an integer value whose bits will be set to indicate the type of event, and will be the bitwise OR of one or more of the following constants, where n is the button number from 1 to 4: BUTTONn_PRESSED, BUTTONn_RELEASED, BUTTONn_CLICKED, BUTTONn_DOUBLE_CLICKED, BUTTONn_TRIPLE_CLICKED, BUTTON_SHIFT, BUTTON_CTRL, BUTTON_ALT.


Return the current coordinates of the virtual screen cursor as a tuple (y, x). If leaveok is currently True, then return (-1, -1).


Read window related data stored in the file by an earlier putwin() call. The routine then creates and initializes a new window using that data, returning the new window object.


Retrieves the value set by set_escdelay().
New in version 3.9.


Retrieves the value set by set_tabsize().
New in version 3.9.


Used for half-delay mode, which is similar to cbreak mode in that characters typed by the user are immediately available to the program. However, after blocking for tenths tenths of seconds, raise an exception if nothing has been typed. The value of tenths must be a number between 1 and 255. Use nocbreak() to leave half-delay mode.


Return True if the terminal can display colors; otherwise, return False.


Return True if the terminal has insert- and delete-character capabilities. This function is included for historical reasons only, as all modern software terminal emulators have such capabilities.


Return True if the terminal has insert- and delete-line capabilities, or can simulate them using scrolling regions. This function is included for historical reasons only, as all modern software terminal emulators have such capabilities.


Take a key value ch, and return True if the current terminal type recognizes a key with that value.


Initialize the library. Return a window object which represents the whole screen.
Note
If there is an error opening the terminal, the underlying curses library may cause the interpreter to exit.


Change the definition of a color, taking the number of the color to be changed followed by three RGB values (for the amounts of red, green, and blue components). The value of color_number must be between 0 and COLORS - 1. Each of r, g, b, must be a value between 0 and 1000. When init_color() is used, all occurrences of that color on the screen immediately change to the new definition. This function is a no-op on most terminals; it is active only if can_change_color() returns True.


Change the definition of a color-pair. It takes three arguments: the number of the color-pair to be changed, the foreground color number, and the background color number. The value of pair_number must be between 1 and COLOR_PAIRS - 1 (the 0 color pair is wired to white on black and cannot be changed). The value of fg and bg arguments must be between 0 and COLORS - 1, or, after calling use_default_colors(), -1. If the color-pair was previously initialized, the screen is refreshed and all occurrences of that color-pair are changed to the new definition.


Return True if endwin() has been called (that is, the curses library has been deinitialized).


Return True if resize_term() would modify the window structure, False otherwise.


Return the name of the key numbered k as a bytes object. The name of a key generating printable ASCII character is the key’s character. The name of a control-key combination is a two-byte bytes object consisting of a caret (b'^') followed by the corresponding printable ASCII character. The name of an alt-key combination (128–255) is a bytes object consisting of the prefix b'M-' followed by the name of the corresponding ASCII character.


Return the user’s current line kill character as a one-byte bytes object. Under Unix operating systems this is a property of the controlling tty of the curses program, and is not set by the curses library itself.


Return a bytes object containing the terminfo long name field describing the current terminal. The maximum length of a verbose description is 128 characters. It is defined only after the call to initscr().


If flag is True, allow 8-bit characters to be input. If flag is False, allow only 7-bit chars.


Set the maximum time in milliseconds that can elapse between press and release events in order for them to be recognized as a click, and return the previous interval value. The default value is 200 msec, or one fifth of a second.


Set the mouse events to be reported, and return a tuple (availmask,
oldmask). availmask indicates which of the specified mouse events can be reported; on complete failure it returns 0. oldmask is the previous value of the given window’s mouse event mask. If this function is never called, no mouse events are ever reported.


A named tuple containing the three components of the ncurses library version: major, minor, and patch. All values are integers. The components can also be accessed by name, so curses.ncurses_version[0] is equivalent to curses.ncurses_version.major and so on.
Availability: if the ncurses library is used.
New in version 3.8.


Create and return a pointer to a new pad data structure with the given number of lines and columns. Return a pad as a window object.
A pad is like a window, except that it is not restricted by the screen size, and is not necessarily associated with a particular part of the screen. Pads can be used when a large window is needed, and only a part of the window will be on the screen at one time. Automatic refreshes of pads (such as from scrolling or echoing of input) do not occur. The refresh() and noutrefresh() methods of a pad require 6 arguments to specify the part of the pad to be displayed and the location on the screen to be used for the display. The arguments are pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol; the p arguments refer to the upper left corner of the pad region to be displayed and the s arguments define a clipping box on the screen within which the pad region is to be displayed.


Return a new window, whose left-upper corner is at (begin_y, begin_x), and whose height/width is nlines/ncols.
By default, the window will extend from the specified position to the lower right corner of the screen.


Enter newline mode. This mode translates the return key into newline on input, and translates newline into return and line-feed on output. Newline mode is initially on.


Leave cbreak mode. Return to normal “cooked” mode with line buffering.


Leave echo mode. Echoing of input characters is turned off.


Leave newline mode. Disable translation of return into newline on input, and disable low-level translation of newline into newline/return on output (but this does not change the behavior of addch('\n'), which always does the equivalent of return and line feed on the virtual screen). With translation off, curses can sometimes speed up vertical motion a little; also, it will be able to detect the return key on input.


When the noqiflush() routine is used, normal flush of input and output queues associated with the INTR, QUIT and SUSP characters will not be done. You may want to call noqiflush() in a signal handler if you want output to continue as though the interrupt had not occurred, after the handler exits.


Leave raw mode. Return to normal “cooked” mode with line buffering.


Some curses routines that return an integer, such as napms(), return OK upon success.


Return a tuple (fg, bg) containing the colors for the requested color pair. The value of pair_number must be between 0 and COLOR_PAIRS - 1.


Return the number of the color-pair set by the attribute value attr. color_pair() is the counterpart to this function.


Panels are windows with the added feature of depth, so they can be stacked on top of each other, and only the visible portions of each window will be displayed. Panels can be added, moved up or down in the stack, and removed.
The module curses.panel defines the following functions:
Returns the bottom panel in the panel stack.
Returns a panel object, associating it with the given window win. Be aware that you need to keep the returned panel object referenced explicitly. If you don’t, the panel object is garbage collected and removed from the panel stack.
Returns the top panel in the panel stack.
Updates the virtual screen after changes in the panel stack. This does not call curses.doupdate(), so you’ll have to do this yourself.
Panel objects, as returned by new_panel() above, are windows with a stacking order. There’s always a window associated with a panel which determines the content, while the panel methods are responsible for the window’s depth in the panel stack.
Panel objects have the following methods:
Returns the panel above the current panel.
Returns the panel below the current panel.
Push the panel to the bottom of the stack.
Returns True if the panel is hidden (not visible), False otherwise.
Hide the panel. This does not delete the object, it just makes the window on screen invisible.
Move the panel to the screen coordinates (y, x).
Change the window associated with the panel to the window win.
Set the panel’s user pointer to obj. This is used to associate an arbitrary piece of data with the panel, and can be any Python object.
Display the panel (which might have been hidden).
Push panel to the top of the stack.
Returns the user pointer for the panel. This might be any Python object.
Returns the window object associated with the panel.


Returns the bottom panel in the panel stack.


Returns a panel object, associating it with the given window win. Be aware that you need to keep the returned panel object referenced explicitly. If you don’t, the panel object is garbage collected and removed from the panel stack.


Returns the panel above the current panel.


Returns the panel below the current panel.


Push the panel to the bottom of the stack.


Returns True if the panel is hidden (not visible), False otherwise.


Hide the panel. This does not delete the object, it just makes the window on screen invisible.


Move the panel to the screen coordinates (y, x).


Change the window associated with the panel to the window win.


Set the panel’s user pointer to obj. This is used to associate an arbitrary piece of data with the panel, and can be any Python object.


Display the panel (which might have been hidden).


Returns the user pointer for the panel. This might be any Python object.


Returns the window object associated with the panel.


Returns the top panel in the panel stack.


Updates the virtual screen after changes in the panel stack. This does not call curses.doupdate(), so you’ll have to do this yourself.


Equivalent to tputs(str, 1, putchar); emit the value of a specified terminfo capability for the current terminal. Note that the output of putp() always goes to standard output.


If flag is False, the effect is the same as calling noqiflush(). If flag is True, or no argument is provided, the queues will be flushed when these control characters are read.


Enter raw mode. In raw mode, normal line buffering and processing of interrupt, quit, suspend, and flow control keys are turned off; characters are presented to curses input functions one by one.


Restore the state of the terminal modes to what it was at the last call to savetty().


Restore the terminal to “program” mode, as previously saved by def_prog_mode().


Restore the terminal to “shell” mode, as previously saved by def_shell_mode().


Resize the standard and current windows to the specified dimensions, and adjusts other bookkeeping data used by the curses library that record the window dimensions (in particular the SIGWINCH handler).


Backend function used by resizeterm(), performing most of the work; when resizing the windows, resize_term() blank-fills the areas that are extended. The calling application should fill in these areas with appropriate data. The resize_term() function attempts to resize all windows. However, due to the calling convention of pads, it is not possible to resize these without additional interaction with the application.


Save the current state of the terminal modes in a buffer, usable by resetty().


Set the virtual screen cursor to y, x. If y and x are both -1, then leaveok is set True.


Initialize the terminal. term is a string giving the terminal name, or None; if omitted or None, the value of the TERM environment variable will be used. fd is the file descriptor to which any initialization sequences will be sent; if not supplied or -1, the file descriptor for sys.stdout will be used.


Sets the number of milliseconds to wait after reading an escape character, to distinguish between an individual escape character entered on the keyboard from escape sequences sent by cursor and function keys.
New in version 3.9.


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.
New in version 3.9.


Must be called if the programmer wants to use colors, and before any other color manipulation routine is called. It is good practice to call this routine right after initscr().
start_color() initializes eight basic colors (black, red, green, yellow, blue, magenta, cyan, and white), and two global variables in the curses module, COLORS and COLOR_PAIRS, containing the maximum number of colors and color-pairs the terminal can support. It also restores the colors on the terminal to the values they had when the terminal was just turned on.


Return a logical OR of all video attributes supported by the terminal. This information is useful when a curses program needs complete control over the appearance of the screen.


Return the value of the environment variable TERM, as a bytes object, truncated to 14 characters.


Draw a rectangle. The first argument must be a window object; the remaining arguments are coordinates relative to that window. The second and third arguments are the y and x coordinates of the upper left hand corner of the rectangle to be drawn; the fourth and fifth arguments are the y and x coordinates of the lower right hand corner. The rectangle will be drawn using VT100/IBM PC forms characters on terminals that make this possible (including xterm and most other software terminal emulators). Otherwise it will be drawn with ASCII dashes, vertical bars, and plus signs.


Return a textbox widget object. The win argument should be a curses window object in which the textbox is to be contained. The edit cursor of the textbox is initially located at the upper left hand corner of the containing window, with coordinates (0, 0). The instance’s stripspaces flag is initially on.
Textbox objects have the following methods:
This is the entry point you will normally use. It accepts editing keystrokes until one of the termination keystrokes is entered. If validator is supplied, it must be a function. It will be called for each keystroke entered with the keystroke as a parameter; command dispatch is done on the result. This method returns the window contents as a string; whether blanks in the window are included is affected by the stripspaces attribute.
Process a single command keystroke. Here are the supported special keystrokes:
Keystroke
Action
Control-A
Go to left edge of window.
Control-B
Cursor left, wrapping to previous line if appropriate.
Control-D
Delete character under cursor.
Control-E
Go to right edge (stripspaces off) or end of line (stripspaces on).
Control-F
Cursor right, wrapping to next line when appropriate.
Control-G
Terminate, returning the window contents.
Control-H
Delete character backward.
Control-J
Terminate if the window is 1 line, otherwise insert newline.
Control-K
If line is blank, delete it, otherwise clear to end of line.
Control-L
Refresh screen.
Control-N
Cursor down; move down one line.
Control-O
Insert a blank line at cursor location.
Control-P
Cursor up; move up one line.
Move operations do nothing if the cursor is at an edge where the movement is not possible. The following synonyms are supported where possible:
Constant
Keystroke
KEY_LEFT
Control-B
KEY_RIGHT
Control-F
KEY_UP
Control-P
KEY_DOWN
Control-N
KEY_BACKSPACE
Control-h
All other keystrokes are treated as a command to insert the given character and move right (with line wrapping).
Return the window contents as a string; whether blanks in the window are included is affected by the stripspaces member.
This attribute is a flag which controls the interpretation of blanks in the window. When it is on, trailing blanks on each line are ignored; any 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 contents are gathered.


Process a single command keystroke. Here are the supported special keystrokes:
Keystroke
Action
Control-A
Go to left edge of window.
Control-B
Cursor left, wrapping to previous line if appropriate.
Control-D
Delete character under cursor.
Control-E
Go to right edge (stripspaces off) or end of line (stripspaces on).
Control-F
Cursor right, wrapping to next line when appropriate.
Control-G
Terminate, returning the window contents.
Control-H
Delete character backward.
Control-J
Terminate if the window is 1 line, otherwise insert newline.
Control-K
If line is blank, delete it, otherwise clear to end of line.
Control-L
Refresh screen.
Control-N
Cursor down; move down one line.
Control-O
Insert a blank line at cursor location.
Control-P
Cursor up; move up one line.
Move operations do nothing if the cursor is at an edge where the movement is not possible. The following synonyms are supported where possible:
Constant
Keystroke
KEY_LEFT
Control-B
KEY_RIGHT
Control-F
KEY_UP
Control-P
KEY_DOWN
Control-N
KEY_BACKSPACE
Control-h
All other keystrokes are treated as a command to insert the given character and move right (with line wrapping).


This is the entry point you will normally use. It accepts editing keystrokes until one of the termination keystrokes is entered. If validator is supplied, it must be a function. It will be called for each keystroke entered with the keystroke as a parameter; command dispatch is done on the result. This method returns the window contents as a string; whether blanks in the window are included is affected by the stripspaces attribute.


Return the window contents as a string; whether blanks in the window are included is affected by the stripspaces member.


This attribute is a flag which controls the interpretation of blanks in the window. When it is on, trailing blanks on each line are ignored; any 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 contents are gathered.


Return the value of the Boolean capability corresponding to the terminfo capability name capname as an integer. Return the value -1 if capname is not a Boolean capability, or 0 if it is canceled or absent from the terminal description.


Return the value of the numeric capability corresponding to the terminfo capability name capname as an integer. Return the value -2 if capname is not a numeric capability, or -1 if it is canceled or absent from the terminal description.


Return the value of the string capability corresponding to the terminfo capability name capname as a bytes object. Return None if capname is not a terminfo “string capability”, or is canceled or absent from the terminal description.


Instantiate the bytes object str with the supplied parameters, where str should be a parameterized string obtained from the terminfo database. E.g. tparm(tigetstr("cup"), 5, 3) could result in b'\033[6;4H', the exact result depending on terminal type.


Specify that the file descriptor fd be used for typeahead checking. If fd is -1, then no typeahead checking is done.
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.


Return a bytes object which is a printable representation of the character ch. Control characters are represented as a caret followed by the character, for example as b'^C'. Printing characters are left as they are.


Push ch so the next getch() will return it.
Note
Only one ch can be pushed before getch() is called.


Push a KEY_MOUSE event onto the input queue, associating the given state data with it.


Push ch so the next get_wch() will return it.
Note
Only one ch can be pushed before get_wch() is called.
New in version 3.3.


Update LINES and COLS. Useful for detecting manual screen resize.
New in version 3.5.


Allow use of default values for colors on terminals supporting this feature. Use this to support transparency in your application. The default color is assigned to the color number -1. After calling this function, init_pair(x,
curses.COLOR_RED, -1) initializes, for instance, color pair x to a red foreground color on the default background.


If used, this function should be called before initscr() or newterm are called. When flag is False, the values of lines and columns specified in the terminfo database will be used, even if environment variables LINES and 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 LINES and COLUMNS are not set).


A bytes object representing the current version of the module. Also available as __version__.


Paint character ch at (y, x) with attributes attr, overwriting any character previously painted at that location. By default, the character position and attributes are the current settings for the window object.
Note
Writing outside the window, subwindow, or pad raises a curses.error. Attempting to write to the lower right corner of a window, subwindow, or pad will cause an exception to be raised after the character is printed.


Paint at most n characters of the character string str at (y, x) with attributes attr, overwriting anything previously on the display.


Paint the character string str at (y, x) with attributes attr, overwriting anything previously on the display.
Note


Remove attribute attr from the “background” set applied to all writes to the current window.


Add attribute attr from the “background” set applied to all writes to the current window.


Set the “background” set of attributes to attr. This set is initially 0 (no attributes).


Set the background property of the window to the character ch, with attributes attr. The change is then applied to every character position in that window:


Set the window’s background. A window’s background consists of a character and any combination of attributes. The attribute part of the background is combined (OR’ed) with all non-blank characters that are written into the window. Both the character and attribute parts of the background are combined with the blank characters. The background becomes a property of the character and moves with the character through any scrolling and insert/delete line/character operations.


Draw a border around the edges of the window. Each parameter specifies the character to use for a specific part of the border; see the table below for more details.
Note
A 0 value for any parameter will cause the default character to be used for that parameter. Keyword parameters can not be used. The defaults are listed in this table:
Parameter
Description
Default value
ls
Left side
ACS_VLINE
rs
Right side
ACS_VLINE
ts
Top
ACS_HLINE
bs
Bottom
ACS_HLINE
tl
Upper-left corner
ACS_ULCORNER
tr
Upper-right corner
ACS_URCORNER
bl
Bottom-left corner
ACS_LLCORNER
br
Bottom-right corner
ACS_LRCORNER


Similar to border(), but both ls and rs are vertch and both ts and bs are horch. The default corner characters are always used by this function.


Set the attributes of num characters at the current cursor position, or at position (y, x) if supplied. If num is not given or is -1, the attribute will be set on all the characters to the end of the line. This function moves cursor to position (y, x) if supplied. The changed line will be touched using the touchline() method so that the contents will be redisplayed by the next window refresh.


Like erase(), but also cause the whole window to be repainted upon next call to refresh().


If flag is True, the next call to refresh() will clear the window completely.


Erase from cursor to the end of the window: all lines below the cursor are deleted, and then the equivalent of clrtoeol() is performed.


Erase from cursor to the end of the line.


Update the current cursor position of all the ancestors of the window to reflect the current cursor position of the window.


Delete the line under the cursor. All following lines are moved up by one line.


An abbreviation for “derive window”, derwin() is the same as calling subwin(), except that begin_y and begin_x are relative to the origin of the window, rather than relative to the entire screen. Return a window object for the derived window.


Add character ch with attribute attr, and immediately call refresh() on the window.


Test whether the given pair of screen-relative character-cell coordinates are enclosed by the given window, returning True or False. It is useful for determining what subset of the screen windows enclose the location of a mouse event.


Encoding used to encode method arguments (Unicode strings and characters). The encoding attribute is inherited from the parent window when a subwindow is created, for example with window.subwin(). By default, the locale encoding is used (see locale.getpreferredencoding()).
New in version 3.3.


Return a tuple (y, x) of co-ordinates of upper-left corner.


Return the given window’s current background character/attribute pair.


Get a character. Note that the integer returned does not have to be in ASCII range: function keys, keypad keys and so on are represented by numbers higher than 255. In no-delay mode, return -1 if there is no input, otherwise wait until a key is pressed.


Get a character, returning a string instead of an integer, as getch() does. Function keys, keypad keys and other special keys return a multibyte string containing the key name. In no-delay mode, raise an exception if there is no input.


Return a tuple (y, x) of the height and width of the window.


Return the beginning coordinates of this window relative to its parent window as a tuple (y, x). Return (-1, -1) if this window has no parent.


Read a bytes object from the user, with primitive line editing capacity.