16.10. curses — 终端字符单元显示的处理

---

curses 模块提供了 curses 库的接口，这是可移植高级终端处理的事实标准。

虽然 curses 在 Unix 环境中使用最为广泛，但也有适用于 Windows，DOS 以及其他可能的系统的版本。此扩展模块旨在匹配 ncurses 的 API，这是一个部署在 Linux 和 Unix 的 BSD 变体上的开源 curses 库。

注解

从 5.4 版本开始，ncurses 库使用 nl_langinfo 函数来决定如何解释非 ASCII 数据。这意味着你需要在程序中调用 locale.setlocale() 函数，并使用一种系统中可用的编码方法来编码 Unicode 字符串。这个例子使用了系统默认的编码:

import locale
locale.setlocale(locale.LC_ALL, '')
code = locale.getpreferredencoding()

然后使用 code 作为 str.encode() 调用的编码。

参见

模块 curses.ascii

在 ASCII 字符上工作的工具，无论你的区域设置是什么。

模块 curses.panel

为 curses 窗口添加深度的面板栈扩展。

模块 curses.textpad

用于使 curses 支持 Emacs 式绑定的可编辑文本部件。

用 Python 进行 Curses 编程

关于配合 Python 使用 curses 的教学材料，由 Andrew Kuchling 和 Eric Raymond 撰写。

Python 源码发布包的 Tools/demo/ 目录包含了一些使用此模块所提供的 curses 绑定的示例程序。

16.10.1. 函数

curses 模块定义了以下异常：

exception curses.error

当 curses 库中函数返回一个错误时引发的异常。

注解

只要一个函数或方法的 x 或 y 参数是可选项，它们会默认为当前光标位置。 而当 attr 是可选项时，它会默认为 A_NORMAL。

curses 模块定义了以下函数：

curses.baudrate()

以每秒比特数为单位返回终端输出速度。 在软件终端模拟器上它将具有一个固定的最高值。 此函数出于历史原因被包括；在以前，它被用于写输出循环以提供时间延迟，并偶尔根据线路速度来改变接口。

curses.beep()

发出短促的提醒声音。

curses.can_change_color()

根据程序员能否改变终端显示的颜色返回 True 或 False。

curses.cbreak()

进入 cbreak 模式。 在 cbreak 模式（有时也称为“稀有”模式）通常的 tty 行缓冲会被关闭并且字符可以被一个一个地读取。 但是，与原始模式不同，特殊字符（中断、退出、挂起和流程控制）会在 tty 驱动和调用程序上保留其效果。 首先调用 raw() 然后调用 cbreak() 会将终端置于 cbreak 模式。

curses.color_content(color_number)

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

curses.color_pair(color_number)

返回用于显示指定颜色的文本的属性值。 该属性值可与 A_STANDOUT, A_REVERSE 以及其他 A_* 属性组合使用。 pair_number() 是此函数的对应操作。

curses.curs_set(visibility)

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, the previous cursor state is returned; otherwise, an exception is raised. On many terminals, the “visible” mode is an underline cursor and the “very visible” mode is a block cursor.

curses.def_prog_mode()

将当前终端模式保存为 “program” 模式，即正在运行的程序使用 curses 时的模式。 （与其相对的是 “shell” 模式，即程序不使用 curses。） 对 reset_prog_mode() 的后续调用将恢复此模式。

curses.def_shell_mode()

将当前终端模式保存为 “shell” 模式，即正在运行的程序不使用 curses 的模式。 （与其相对的是 “program” 模式，即程序使用 功能。） 对 reset_shell_mode() 的后续调用将恢复此模式。

curses.delay_output(ms)

在输出中插入 ms 毫秒的暂停。

curses.doupdate()

更新物理屏幕。 curses 库会保留两个数据结构，一个代表当前物理屏幕的内容以及一个虚拟屏幕代表需要的后续状态。 doupdate() 整体更新物理屏幕以匹配虚拟屏幕。

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().

curses.echo()

进入 echo 模式。 在 echo 模式下，输入的每个字符都会在输入后回显到屏幕上。

curses.endwin()

撤销库的初始化，使终端返回正常状态。

curses.erasechar()

Return the user’s current erase character. 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.

curses.filter()

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.

curses.flash()

闪烁屏幕。 也就是将其改为反显并在很短的时间内将其改回原状。 有些人更喜欢这样的‘视觉响铃’而非 beep() 所产生的听觉提醒信号。

curses.flushinp()

刷新所有输入缓冲区。 这会丢弃任何已被用户输入但尚未被程序处理的预输入内容。

curses.getmouse()

After getch() returns KEY_MOUSE to signal a mouse event, this method should be call 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.

curses.getsyx()

Return the current coordinates of the virtual screen cursor in y and x. If leaveok is currently true, then -1,-1 is returned.

curses.getwin(file)

读取由之前的 putwin() 调用存放在文件中的窗口相关数据。 该例程随后将使用该数据创建并初始化一个新窗口，并返回该新窗口对象。

curses.has_colors()

如果终端能显示彩色则返回 True；否则返回 False。

curses.has_ic()

如果终端具有插入和删除字符的功能则返回 True。 此函数仅是出于历史原因而被包括的，因为所有现代软件终端模拟器都具有这些功能。

curses.has_il()

如果终端具有插入和删除字符功能，或者能够使用滚动区域来模拟这些功能则返回 True。 此函数仅是出于历史原因而被包括的，因为所有现代软件终端模拟器都具有这些功能。

curses.has_key(ch)

接受一个键值 ch，并在当前终端类型能识别出具有该值的键时返回 True。

curses.halfdelay(tenths)

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, an exception is raised if nothing has been typed. The value of tenths must be a number between 1 and 255. Use nocbreak() to leave half-delay mode.

curses.init_color(color_number, r, g, b)

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. 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 1.

curses.init_pair(pair_number, fg, bg)

更改某个颜色对的定义。 它接受三个参数：要更改的颜色对编号，前景色编号和背景色编号。 pair_number 值必须为 1 和 COLOR_PAIRS - 1 之间的数字（并且 0 号颜色对固定为黑底白字而无法更改）。 fg 和 bg 参数值必须为 0 和 COLORS 之间的数字。 如果颜色对之前已被初始化，则屏幕会被刷新使得出现在屏幕上的该颜色对会立即按照新定义来更改。

curses.initscr()

初始化库。 返回代表整个屏幕的 窗口 对象。

注解

如果打开终端时发生错误，则下层的 curses 库可能会导致解释器退出。

curses.is_term_resized(nlines, ncols)

如果 resize_term() 会修改窗口结构则返回 True，否则返回 False。

curses.isendwin()

如果 endwin() 已经被调用（即 curses 库已经被撤销初始化则返回 True。

curses.keyname(k)

Return the name of the key numbered k. The name of a key generating printable ASCII character is the key’s character. The name of a control-key combination is a two-character string consisting of a caret followed by the corresponding printable ASCII character. The name of an alt-key combination (128–255) is a string consisting of the prefix ‘M-‘ followed by the name of the corresponding ASCII character.

curses.killchar()

Return the user’s current line kill character. 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.

curses.longname()

Return a string 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().

curses.meta(yes)

If yes is 1, allow 8-bit characters to be input. If yes is 0, allow only 7-bit chars.

curses.mouseinterval(interval)

以毫秒为单位设置能够被识别为点击的按下和释放事件之间可以间隔的最长时间，并返回之前的间隔值。 默认值为 200 毫秒，即五分之一秒。

curses.mousemask(mousemask)

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.

curses.napms(ms)

休眠 ms 毫秒。

curses.newpad(nlines, ncols)

Create and return a pointer to a new pad data structure with the given number of lines and columns. A pad is returned 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.

curses.newwin(nlines, ncols)

curses.newwin(nlines, ncols, begin_y, begin_x)

返回一个新的 窗口，其左上角位于 (begin_y, begin_x)，并且其高度/宽度为 nlines/ncols。

默认情况下，窗口将从指定位置扩展到屏幕的右下角。

curses.nl()

进入换行模式。 此模式会在输入时将回车转换为换行符，并在输出时将换行符转换为回车加换行。 换行模式会在初始时启用。

curses.nocbreak()

退出 cbreak 模式。 返回具有行缓冲的正常 “cooked” 模式。

curses.noecho()

退出 echo 模式。 关闭输入字符的回显。

curses.nonl()

退出 newline 模式。 停止在输入时将回车转换为换行，并停止在输出时从换行到换行/回车的底层转换（但这不会改变 addch('\n') 的行为，此行为总是在虚拟屏幕上执行相当于回车加换行的操作）。 当停止转换时，curses 有时能使纵向移动加快一些；并且，它将能够在输入时检测回车键。

curses.noqiflush()

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.

curses.noraw()

退出 raw 模式。 返回具有行缓冲的正常 “cooked” 模式。

curses.pair_content(pair_number)

返回包含对应于所请求颜色对的颜色的元组 (fg, bg)。 pair_number 的值必须在 1 和 COLOR_PAIRS - 1 之间。

curses.pair_number(attr)

返回通过属性值 attr 所设置的颜色对的编号。 color_pair() 是此函数的对应操作。

curses.putp(string)

等价于 tputs(str, 1, putchar)；为当前终端发出指定 terminfo 功能的值。 请注意 putp() 的输出总是前往标准输出。

curses.qiflush([flag])

如果 flag 为 False，则效果与调用 noqiflush() 相同。 如果 flag 为 True 或未提供参数，则在读取这些控制字符时队列将被刷新。

curses.raw()

进入 raw 模式。 在 raw 模式下，正常的行缓冲和对中断、退出、挂起和流程控制键的处理会被关闭；字符会被逐个地提交给 curses 输入函数。

curses.reset_prog_mode()

将终端恢复到 “program” 模式，如之前由 def_prog_mode() 所保存的一样。

curses.reset_shell_mode()

将终端恢复到 “shell” 模式，如之前由 def_shell_mode() 所保存的一样。

curses.resetty()

将终端模式恢复到最后一次调用 savetty() 时的状态。

curses.resize_term(nlines, ncols)

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.

curses.resizeterm(nlines, ncols)

将标准窗口和当前窗口的大小调整为指定的尺寸，并调整由 curses 库所使用的记录窗口尺寸的其他记录数据（特别是 SIGWINCH 处理程序）。

curses.savetty()

将终端模式的当前状态保存在缓冲区中，可供 resetty() 使用。

curses.setsyx(y, x)

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

curses.setupterm([termstr, fd])

Initialize the terminal. termstr is a string giving the terminal name; if omitted, 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, the file descriptor for sys.stdout will be used.

curses.start_color()

如果程序员想要使用颜色，则必须在任何其他颜色操作例程被调用之前调用它。 在 initscr() 之后立即调用此例程是一个很好的做法。

start_color() 会初始化八种基本颜色（黑、红、绿、黄、蓝、品、青和白）以及 curses 模块中的两个全局变量 COLORS 和 COLOR_PAIRS，其中包含终端可支持的颜色和颜色对的最大数量。 它还会将终端中的颜色恢复为终端刚启动时的值。

curses.termattrs()

返回终端所支持的所有视频属性逻辑 OR 的值。 此信息适用于当 curses 程序需要对屏幕外观进行完全控制的情况。

curses.termname()

Return the value of the environment variable TERM, truncated to 14 characters.

curses.tigetflag(capname)

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

curses.tigetnum(capname)

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

curses.tigetstr(capname)

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

curses.tparm(str[, ...])

Instantiate the string 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.

curses.typeahead(fd)

指定将被用于预输入检查的文件描述符 fd。 如果 fd 为 -1，则不执行预输入检查。

curses 库会在更新屏幕时通过定期查找预输入来执行 “断行优化”。 如果找到了输入，并且输入是来自于 tty，则会将当前更新推迟至 refresh 或 doupdate 再次被调用的时候，以便允许更快地响应预先输入的命令。 此函数允许为预输入检查指定其他的文件描述符。

curses.unctrl(ch)

Return a string which is a printable representation of the character ch. Control characters are displayed as a caret followed by the character, for example as ^C. Printing characters are left as they are.

curses.ungetch(ch)

Push ch so the next getch() will return it.

注解

Only one ch can be pushed before getch() is called.

curses.update_lines_cols()

更新 LINES 和 COLS。 适用于检测屏幕大小的手动调整。

3.5 新版功能.

curses.unget_wch(ch)

Push ch so the next get_wch() will return it.

注解

Only one ch can be pushed before get_wch() is called.

3.3 新版功能.

curses.ungetmouse(id, x, y, z, bstate)

将 KEY_MOUSE 事件推送到输入队列，将其与给定的状态数据进行关联。

curses.use_env(flag)

如果使用此函数，则应当在调用 initscr() 或 newterm 之前调用它。 当 flag 为 False 时，将会使用在 terminfo 数据库中指定的行和列的值，即使设置了环境变量 LINES 和 COLUMNS (默认使用)，或者如果 curses 是在窗口中运行（在此情况下如果未设置 LINES 和 COLUMNS 则默认行为将是使用窗口大小）。

curses.use_default_colors()

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.

curses.wrapper(func, ...)

Initialize curses and call another callable object, func, which should be the rest of your curses-using application. If the application raises an exception, this function will restore the terminal to a sane state before re-raising the exception and generating a traceback. The callable object func is then passed the main window ‘stdscr’ as its first argument, followed by any other arguments passed to 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.

16.10.2. Window 对象

Window 对象会由上面的 initscr() 和 newwin() 返回，它具有以下方法和属性:

window.addch(ch[, attr])

window.addch(y, x, ch[, attr])

注解

A character means a C character (an ASCII code), rather than a Python character (a string of length 1). (This note is true whenever the documentation mentions a character.) The built-in ord() is handy for conveying strings to codes.

Paint character ch at (y, x) with attributes attr, overwriting any character previously painter at that location. By default, the character position and attributes are the current settings for the window object.

window.addnstr(str, n[, attr])

window.addnstr(y, x, str, n[, attr])

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

window.addstr(str[, attr])

window.addstr(y, x, str[, attr])

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

window.attroff(attr)

从应用于写入到当前窗口的 “background” 集中移除属性 attr。

window.attron(attr)

向应用于写入到当前窗口的 “background” 集中添加属性 attr。

window.attrset(attr)

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

window.bkgd(ch[, attr])

将窗口 background 特征属性设为带有属性 attr 的字符 ch。 随后此修改将应用于放置到该窗口中的每个字符。

• 窗口中每个字符的属性会被修改为新的 background 属性。
• 不论之前的 background 字符出现在哪里，它都会被修改为新的 background 字符。

window.bkgdset(ch[, attr])

设置窗口的背景。 窗口的背景由字符和属性的任意组合构成。 背景的属性部分会与写入窗口的所有非空白字符合并（即 OR 运算）。 背景和字符和属性部分均会与空白字符合并。 背景将成为字符的特征属性并在任何滚动与插入/删除行/字符操作中与字符一起移动。

window.border([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])

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. The characters can be specified as integers or as one-character strings.

注解

任何形参的值为 0 都将导致该形参使用默认字符。 关键字形参 不可 被使用。 默认字符在下表中列出:

参数	描述	默认值
ls	左侧	ACS_VLINE
rs	右侧	ACS_VLINE
ts	顶部	ACS_HLINE
bs	底部	ACS_HLINE
tl	左上角	ACS_ULCORNER
tr	右上角	ACS_URCORNER
bl	左下角	ACS_LLCORNER
br	右下角	ACS_LRCORNER

window.box([vertch, horch])

类似于 border()，但 ls 和 rs 均为 vertch 而 ts 和 bs 均为 horch。 此函数总是会使用默认的转角字符。

window.chgat(attr)

window.chgat(num, attr)

window.chgat(y, x, attr)

window.chgat(y, x, num, attr)

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

window.clear()

类似于 erase()，但还会导致在下次调用 refresh() 时整个窗口被重新绘制。

window.clearok(yes)

If yes is 1, the next call to refresh() will clear the window completely.

window.clrtobot()

从光标位置开始擦除直至窗口末端：光标以下的所有行都会被删除，然后会执行 clrtoeol() 的等效操作。

window.clrtoeol()

从光标位置开始擦除直至行尾。

window.cursyncup()

更新窗口所有上级窗口的当前光标位置以反映窗口的当前光标位置。

window.delch([y, x])

删除位于 (y, x) 的任何字符。

window.deleteln()

删除在光标之下的行。 所有后续的行都会上移一行。

window.derwin(begin_y, begin_x)

window.derwin(nlines, ncols, begin_y, begin_x)

“derive window” 的缩写，derwin() 与调用 subwin() 等效，不同之处在于 begin_y 和 begin_x 是想对于窗口的初始位置，而不是相对于整个屏幕。 返回代表所派生窗口的窗口对象。

window.echochar(ch[, attr])

使用属性 attr 添加字符 ch，并立即在窗口上调用 refresh()。

window.enclose(y, x)

检测给定的相对屏幕的字符-单元格坐标是否被给定的窗口所包围，返回 True 或 False。 它适用于确定是哪个屏幕窗口子集包围着某个鼠标事件的位置。

window.encoding

用于编码方法参数（Unicode 字符串和字符）的编码格式。 encoding 属性是在创建子窗口时从父窗口继承的，例如通过 window.subwin()。 默认情况下，会使用当前区域的编码格式 (参见 locale.getpreferredencoding())。

3.3 新版功能.

window.erase()

清空窗口。

window.getbegyx()

返回左上角坐标的元组 (y, x)。

window.getbkgd()

返回给定窗口的当前背景字符/属性对。

window.getch([y, x])

Get a character. Note that the integer returned does not have to be in ASCII range: function keys, keypad keys and so on return numbers higher than 256. In no-delay mode, -1 is returned if there is no input, else getch() waits until a key is pressed.

window.get_wch([y, x])

Get a wide character. Return a character for most keys, or an integer for function keys, keypad keys, and other special keys.

3.3 新版功能.

window.getkey([y, x])

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, an exception is raised if there is no input.

window.getmaxyx()

返回窗口高度和宽度的元组 (y, x)。

window.getparyx()

Return the beginning coordinates of this window relative to its parent window into two integer variables y and x. Return -1, -1 if this window has no parent.

window.getstr([y, x])

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

window.getyx()

返回当前光标相对于窗口左上角的位置的元组 (y, x)。

window.hline(ch, n)

window.hline(y, x, ch, n)

显示一条起始于 (y, x) 长度为 n 个字符 ch 的水平线。

window.idcok(flag)

如果 flag 为 False，curses 将不再考虑使用终端的硬件插入/删除字符功能；如果 flag 为 True，则会启用字符插入和删除。 当 curses 首次初始化时，默认会启用字符插入/删除。

window.idlok(yes)

If called with yes equal to 1, curses will try and use hardware line editing facilities. Otherwise, line insertion/deletion are disabled.

window.immedok(flag)

如果 flag 为 True，窗口图像中的任何改变都会自动导致窗口被刷新；你不必再自己调用 refresh()。 但是，这可能会由于重复调用 wrefresh 而显著降低性能。 此选项默认被禁用。

window.inch([y, x])

返回窗口中给定位置上的字符。 下面的 8 个比特位是字符本身，上面的比特位则为属性。

window.insch(ch[, attr])

window.insch(y, x, ch[, attr])

将带有属性 attr 的字符串 ch 绘制到 (y, x)，将该行从位置 x 开始右移一个字符。

window.insdelln(nlines)

在指定窗口的当前行上方插入 nlines 行。 下面的 nlines 行将丢失。 对于 nlines 为负值的情况，则从光标下方的行开始删除 nlines 行，并将其余的行向上移动。 下面的 nlines 行会被清空。 当前光标位置将保持不变。

window.insertln()

在光标下方插入一个空行。 所有后续的行都会下移一行。

window.insnstr(str, n[, attr])

window.insnstr(y, x, str, n[, attr])

在光标下方的字符之前插入一个至多为 n 个字符的字符串（字符数量将与该行相匹配）。 如果 n 为零或负数，则插入整个字符串。 光标右边的所有字符将被右移，该行右端的字符将丢失。 光标位置将保持不变（在移到可能指定的 y, x 之后）。

window.insstr(str[, attr])

window.insstr(y, x, str[, attr])

在光标下方的字符之前插入一个字符串（字符数量将与该行相匹配）。 光标右边的所有字符将被右移，该行右端的字符将丢失。 光标位置将保持不变（在移到可能指定的 y, x 之后）。

window.instr([n])

window.instr(y, x[, n])

Return a string 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).

window.is_linetouched(line)

如果指定的行自上次调用 refresh() 后发生了改变则返回 True；否则返回 False。 如果 line 对于给定的窗口不可用则会引发 curses.error 异常。

window.is_wintouched()

如果指定的窗口自上次调用 refresh() 后发生了改变则返回 True；否则返回 False。

window.keypad(yes)

If yes is 1, escape sequences generated by some keys (keypad, function keys) will be interpreted by curses. If yes is 0, escape sequences will be left as is in the input stream.

window.leaveok(yes)

If yes is 1, 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 yes is 0, cursor will always be at “cursor position” after an update.

window.move(new_y, new_x)

将光标移至 (new_y, new_x)。

window.mvderwin(y, x)

让窗口在其父窗口内移动。 窗口相对于屏幕的参数不会被更改。 此例程用于在屏幕的相同物理位置显示父窗口的不同部分。

window.mvwin(new_y, new_x)

移动窗口以使其左上角位于 (new_y, new_x)。

window.nodelay(yes)

If yes is 1, getch() will be non-blocking.

window.notimeout(yes)

If yes is 1, escape sequences will not be timed out.

If yes is 0, after a few milliseconds, an escape sequence will not be interpreted, and will be left in the input stream as is.

window.noutrefresh()

标记为刷新但保持等待。 此函数会更新代表预期窗口状态的数据结构，但并不强制更新物理屏幕。 要完成后者，请调用 doupdate()。

window.overlay(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

将窗口覆盖在 destwin 上方。 窗口的大小不必相同，只有重叠的区域会被复制。 此复制是非破坏性的，这意味着当前背景字符不会覆盖掉 destwin 的旧内容。

为了获得对被复制区域的细粒度控制，可以使用 overlay() 的第二种形式。 sminrow 和 smincol 是源窗口的左上角坐标，而其他变量则在目标窗口中标记出一个矩形。

window.overwrite(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

将窗口覆盖在 destwin 上方。 窗口的大小不必相同，此时只有重叠的区域会被复制。 此复制是破坏性的，这意味着当前背景字符会覆盖掉 destwin 的旧内容。

为了获得对被复制区域的细粒度控制，可以使用 overwrite() 的第二种形式。 sminrow 和 smincol 是源窗口的左上角坐标，而其他变量则在目标窗口中标记出一个矩形。

window.putwin(file)

将关联到窗口的所有数据写入到所提供的文件对象。 此信息可在以后使用 getwin() 函数来提取。

window.redrawln(beg, num)

指明从 beg 行开始的 num 个屏幕行已被破坏并且应当在下次 refresh() 调用时完全重绘。

window.redrawwin()

标记整个窗口，以使其在下次 refresh() 调用时完全重绘。

window.refresh([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])

立即更新显示（将实际屏幕与之前的绘制/删除方法进行同步）。

6 个可选参数仅在窗口为使用 newpad() 创建的面板时可被指定。 需要额外的形参来指定所涉及到的是面板和屏幕的哪一部分。 pminrow 和 pmincol 指定要在面板中显示的矩形的左上角。 sminrow, smincol, smaxrow 和 smaxcol 指定要在屏幕中显示的矩形的边。 要在面板中显示的矩形的右下角是根据屏幕坐标计算出来的，由于矩形的大小必须相同。 两个矩形都必须完全包含在其各自的结构之内。 负的 pminrow, pmincol, sminrow 或 smincol 值会被视为将它们设为零值。

window.resize(nlines, ncols)

为 curses 窗口重新分配存储空间以将其尺寸调整为指定的值。 如果任一维度的尺寸大于当前值，则窗口的数据将以具有合并了当前背景渲染（由 bkgdset() 设置）的空白来填充。

window.scroll([lines=1])

将屏幕或滚动区域向上滚动 lines 行。

window.scrollok(flag)

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().

window.setscrreg(top, bottom)

设置从 top 行至 bottom 行的滚动区域。 所有滚动操作将在此区域中进行。

window.standend()

关闭 standout 属性。 在某些终端上此操作会有关闭所有属性的副作用。

window.standout()

启用属性 A_STANDOUT。

window.subpad(begin_y, begin_x)

window.subpad(nlines, ncols, begin_y, begin_x)

返回一个子窗口，其左上角位于 (begin_y, begin_x)，并且其宽度/高度为 ncols/nlines。

window.subwin(begin_y, begin_x)

window.subwin(nlines, ncols, begin_y, begin_x)

返回一个子窗口，其左上角位于 (begin_y, begin_x)，并且其宽度/高度为 ncols/nlines。

默认情况下，子窗口将从指定位置扩展到窗口的右下角。

window.syncdown()

触碰已在上级窗口上被触碰的每个位置。 此例程由 refresh() 调用，因此几乎从不需要手动调用。

window.syncok(flag)

If called with flag set to True, then syncup() is called automatically whenever there is a change in the window.

window.syncup()

触碰已在窗口中被改变的此窗口的各个上级窗口中的所有位置。

window.timeout(delay)

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 -1 will be returned by getch() 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.

window.touchline(start, count[, changed])

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=1) or unchanged (changed=0).

window.touchwin()

假定整个窗口已被更改，其目的是用于绘制优化。

window.untouchwin()

将自上次调用 refresh() 以来窗口中的所有行标记为未改变。

window.vline(ch, n)

window.vline(y, x, ch, n)

显示一条起始于 (y, x) 长度为 n 个字符 ch 的垂直线。

16.10.3. 常量

curses 模块定义了以下数据成员:

curses.ERR

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

curses.OK

一些返回整数的 curses 例程，例如 napms()，在成功时将返回 OK。

curses.version

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

有些常量可用于指定字符单元属性。 实际可用的常量取决于具体的系统。

属性	含义
A_ALTCHARSET	备用字符集模式
A_BLINK	闪烁模式
A_BOLD	粗体模式
A_DIM	暗淡模式
A_INVIS	不可见或空白模式
A_NORMAL	正常属性
A_PROTECT	保护模式
A_REVERSE	反转背景色和前景色
A_STANDOUT	突出模式
A_UNDERLINE	下划线模式
A_HORIZONTAL	水平突出显示
A_LEFT	左高亮
A_LOW	底部高亮
A_RIGHT	右高亮
A_TOP	顶部高亮
A_VERTICAL	垂直突出显示
A_CHARTEXT	用于提取字符的位掩码

有几个常量可用于提取某些方法返回的相应属性。

位掩码	含义
A_ATTRIBUTES	用于提取属性的位掩码
A_CHARTEXT	用于提取字符的位掩码
A_COLOR	用于提取颜色对字段信息的位掩码

键由名称以 KEY_ 开头的整数常量引用。确切的可用键取决于系统。

关键常数	（Windows 注册表的）键
KEY_MIN	最小键值
KEY_BREAK	中断键（不可靠）
KEY_DOWN	向下箭头
KEY_UP	向上箭头
KEY_LEFT	向左箭头
KEY_RIGHT	向右箭头
KEY_HOME	Home 键 (上+左箭头)
KEY_BACKSPACE	退格（不可靠）
KEY_F0	功能键。 支持至多 64 个功能键。
KEY_Fn	功能键 n 的值
KEY_DL	删除行
KEY_IL	插入行
KEY_DC	删除字符
KEY_IC	插入字符或进入插入模式
KEY_EIC	退出插入字符模式
KEY_CLEAR	清空屏幕
KEY_EOS	清空至屏幕底部
KEY_EOL	清空至行尾
KEY_SF	向前滚动 1 行
KEY_SR	向后滚动 1 行 (反转)
KEY_NPAGE	下一页
KEY_PPAGE	上一页
KEY_STAB	设置制表符
KEY_CTAB	清除制表制
KEY_CATAB	清除所有制表符
KEY_ENTER	回车或发送 (不可靠)
KEY_SRESET	软件 (部分) 重置 (不可靠)
KEY_RESET	重置或硬重置 (不可靠)
KEY_PRINT	打印
KEY_LL	Home 向下或到底 (左下)
KEY_A1	键盘的左上角
KEY_A3	键盘的右上角
KEY_B2	键盘的中心
KEY_C1	键盘左下方
KEY_C3	键盘右下方
KEY_BTAB	回退制表符
KEY_BEG	Beg (开始)
KEY_CANCEL	取消
KEY_CLOSE	关闭
KEY_COMMAND	Cmd (命令行)
KEY_COPY	复制
KEY_CREATE	创建
KEY_END	End
KEY_EXIT	退出
KEY_FIND	查找
KEY_HELP	帮助
KEY_MARK	标记
KEY_MESSAGE	消息
KEY_MOVE	移动
KEY_NEXT	下一个
KEY_OPEN	打开
KEY_OPTIONS	选项
KEY_PREVIOUS	Prev (上一个)
KEY_REDO	重做
KEY_REFERENCE	Ref (引用)
KEY_REFRESH	刷新
KEY_REPLACE	替换
KEY_RESTART	重启
KEY_RESUME	恢复
KEY_SAVE	保存
KEY_SBEG	Shift 的 Beg (开始)
KEY_SCANCEL	Shift 的 Cancel
KEY_SCOMMAND	Shift 的 Command
KEY_SCOPY	Shift + Copy
KEY_SCREATE	Shift + Create
KEY_SDC	Shift + 删除字符
KEY_SDL	Shift + 删除行
KEY_SELECT	选择
KEY_SEND	Shift + End
KEY_SEOL	Shift + 清空行
KEY_SEXIT	Shift + Exit
KEY_SFIND	Shift + 查找
KEY_SHELP	Shift + 帮助
KEY_SHOME	Shift + Home
KEY_SIC	Shift + 输入
KEY_SLEFT	Shift + 向左箭头
KEY_SMESSAGE	Shift + 消息
KEY_SMOVE	Shift + 移动
KEY_SNEXT	Shift + 下一个
KEY_SOPTIONS	Shift + 选项
KEY_SPREVIOUS	Shift + 上一个
KEY_SPRINT	Shift + 打印
KEY_SREDO	Shift + 重做
KEY_SREPLACE	Shift + 替换
KEY_SRIGHT	Shift + 向右箭头
KEY_SRSUME	Shift + 恢复
KEY_SSAVE	Shift + 保存
KEY_SSUSPEND	Shift + 挂起
KEY_SUNDO	Shift + 撤销
KEY_SUSPEND	挂起
KEY_UNDO	撤销操作
KEY_MOUSE	鼠标事件已发生
KEY_RESIZE	终端大小改变事件
KEY_MAX	最大键值

在VT100及其软件仿真（例如X终端仿真器）上，通常至少有四个功能键（ KEY_F1, KEY_F2, KEY_F3, KEY_F4 ）可用，并且箭头键以明显的方式映射到 KEY_UP, KEY_DOWN, KEY_LEFT 和 KEY_RIGHT 。如果您的机器有一个PC键盘，可以安全地使用箭头键和十二个功能键（旧的PC键盘可能只有十个功能键）;此外，以下键盘映射是标准的：

键帽	常数
Insert	KEY_IC
Delete	KEY_DC
Home	KEY_HOME
End	KEY_END
Page Up	KEY_PPAGE
Page Down	KEY_NPAGE

下表列出了替代字符集中的字符。 这些字符继承自 VT100 终端，在 X 终端等软件模拟器上通常均为可用。 当没有可用的图形时，curses 会回退为粗糙的可打印 ASCII 近似符号。

注解

只有在调用 initscr() 之后才能使用它们

ACS代码	含义
ACS_BBSS	右上角的别名
ACS_BLOCK	实心方块
ACS_BOARD	正方形
ACS_BSBS	水平线的别名
ACS_BSSB	左上角的别名
ACS_BSSS	顶部 T 型的别名
ACS_BTEE	底部 T 型
ACS_BULLET	正方形
ACS_CKBOARD	棋盘（点刻）
ACS_DARROW	向下箭头
ACS_DEGREE	等级符
ACS_DIAMOND	菱形
ACS_GEQUAL	大于或等于
ACS_HLINE	水平线
ACS_LANTERN	灯形符号
ACS_LARROW	向左箭头
ACS_LEQUAL	小于或等于
ACS_LLCORNER	左下角
ACS_LRCORNER	右下角
ACS_LTEE	左侧 T 型
ACS_NEQUAL	不等号
ACS_PI	字母π
ACS_PLMINUS	正负号
ACS_PLUS	加号
ACS_RARROW	向右箭头
ACS_RTEE	右侧 T 型
ACS_S1	扫描线 1
ACS_S3	扫描线3
ACS_S7	扫描线7
ACS_S9	扫描线 9
ACS_SBBS	右下角的别名
ACS_SBSB	垂直线的别名
ACS_SBSS	右侧 T 型的别名
ACS_SSBB	左下角的别名
ACS_SSBS	底部 T 型的别名
ACS_SSSB	左侧 T 型的别名
ACS_SSSS	交叉或大加号的替代名称
ACS_STERLING	英镑
ACS_TTEE	顶部 T 型
ACS_UARROW	向上箭头
ACS_ULCORNER	左上角
ACS_URCORNER	右上角
ACS_VLINE	垂线

下表列出了预定义的颜色：

常数	颜色
COLOR_BLACK	黑色
COLOR_BLUE	蓝色
COLOR_CYAN	青色（浅绿蓝色）
COLOR_GREEN	绿色
COLOR_MAGENTA	洋红色（紫红色）
COLOR_RED	红色
COLOR_WHITE	白色
COLOR_YELLOW	黄色

16.11. curses.textpad — 用于 curses 程序的文本输入控件

curses.textpad 模块提供了一个 Textbox 类，该类在 curses 窗口中处理基本的文本编辑，支持一组与 Emacs 类似的键绑定（因此这也适用于 Netscape Navigator, BBedit 6.x, FrameMaker 和许多其他程序）。 该模块还提供了一个绘制矩形的函数，适用于容纳文本框或其他目的。

curses.textpad 模块定义了以下函数:

curses.textpad.rectangle(win, uly, ulx, lry, lrx)

绘制一个矩形。 第一个参数必须为窗口对象；其余参数均为相对于该窗口的坐标值。 第二和第三个参数为要绘制的矩形的左上角的 y 和 x 坐标值；第四和第五个参数为其右下角的 y 和 x 坐标值。 将会使用 VT100/IBM PC 形式的字符在可用的终端上（包括 xterm 和大多数其他软件终端模拟器）绘制矩形。 在其他情况下则将使用 ASCII 横杠、竖线和加号绘制。

16.11.1. 文本框对象

你可以通过如下方式实例化一个 Textbox:

class curses.textpad.Textbox(win)

返回一个文本框控件对象。 win 参数必须是一个 curses 窗口 对象，文本框将被包含在其中。 文本框的编辑光标在初始时位于包含窗口的左上角，坐标值为 (0, 0)。 实例的 stripspaces 旗标初始时为启用。

Textbox 对象具有以下方法:

edit([validator])

这是你通常将使用的入口点。 它接受编辑按键直到键入了一个终止按键。 如果提供了 validator，它必须是一个函数。 它将在每次按键时被调用并传入相应的按键作作为形参；命令发送将在结果上执行。 此方法会以字符串形式返回窗口内容；是否包括窗口中的空白将受到 stripspaces 属性的影响。

do_command(ch)

处理单个按键命令。以下是支持的特殊按键：

按键	动作
Control-A	转到窗口的左边缘。
Control-B	光标向左，如果可能，包含前一行。
Control-D	删除光标下的字符。
Control-E	前往右边缘（stripspaces 关闭时）或者行尾（stripspaces 启用时）。
Control-F	向右移动光标，适当时换行到下一行。
Control-G	终止，返回窗口内容。
Control-H	向后删除字符。
Control-J	如果窗口是1行则终止，否则插入换行符。
Control-K	如果行为空，则删除它，否则清除到行尾。
Control-L	刷新屏幕。
Control-N	光标向下;向下移动一行。
Control-O	在光标位置插入一个空行。
Control-P	光标向上;向上移动一行。

如果光标位于无法移动的边缘，则移动操作不执行任何操作。在可能的情况下，支持以下同义词：

常数	按键
KEY_LEFT	Control-B
KEY_RIGHT	Control-F
KEY_UP	Control-P
KEY_DOWN	Control-N
KEY_BACKSPACE	Control-h

所有其他按键将被视为插入给定字符并右移的命令（带有自动折行）。

gather()

以字符串形式返回窗口内容；是否包括窗口中的空白将受到 stripspaces 成员的影响。

stripspaces

此属性是控制窗口中空白解读方式的旗标。 当启用时，每一行的末尾空白会被忽略；任何将光标定位至末尾空白的光标动作都将改为前往该行末尾，并且在收集窗口内容时将去除末尾空白。