neulab/docprompting-conala huggingface dataset:
curses.getmouse()  
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.
curses.getsyx()  
Return the current coordinates of the virtual screen cursor as a tuple (y, x). If leaveok is currently True, then return (-1, -1).
curses.getwin(file)  
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.
curses.get_escdelay()  
Retrieves the value set by set_escdelay().  New in version 3.9.
curses.get_tabsize()  
Retrieves the value set by set_tabsize().  New in version 3.9.
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, 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.
curses.has_colors()  
Return True if the terminal can display colors; otherwise, return False.
curses.has_ic()  
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.
curses.has_il()  
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.
curses.has_key(ch)  
Take a key value ch, and return True if the current terminal type recognizes a key with that value.
curses.initscr()  
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.
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 - 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.
curses.init_pair(pair_number, fg, bg)  
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.
curses.isendwin()  
Return True if endwin() has been called (that is, the curses library has been deinitialized).
curses.is_term_resized(nlines, ncols)  
Return True if resize_term() would modify the window structure, False otherwise.
curses.keyname(k)  
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.
curses.killchar()  
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.
curses.longname()  
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().
curses.meta(flag)  
If flag is True, allow 8-bit characters to be input. If flag is False, allow only 7-bit chars.
curses.mouseinterval(interval)  
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.
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.ncurses_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.
curses.newpad(nlines, ncols)  
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.
curses.newwin(nlines, ncols)  
curses.newwin(nlines, ncols, begin_y, begin_x)  
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.
curses.nl()  
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.
curses.nocbreak()  
Leave cbreak mode. Return to normal “cooked” mode with line buffering.
curses.noecho()  
Leave echo mode. Echoing of input characters is turned off.
curses.nonl()  
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.
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()  
Leave raw mode. Return to normal “cooked” mode with line buffering.
curses.OK  
Some curses routines that return an integer, such as napms(), return OK upon success.
curses.pair_content(pair_number)  
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.
curses.pair_number(attr)  
Return the number of the color-pair set by the attribute value attr. color_pair() is the counterpart to this function.
curses.panel — A panel stack extension for curses 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. Functions The module curses.panel defines the following functions:  
curses.panel.bottom_panel()  
Returns the bottom panel in the panel stack. 
  
curses.panel.new_panel(win)  
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. 
  
curses.panel.top_panel()  
Returns the top panel in the panel stack. 
  
curses.panel.update_panels()  
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 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:  
Panel.above()  
Returns the panel above the current panel. 
  
Panel.below()  
Returns the panel below the current panel. 
  
Panel.bottom()  
Push the panel to the bottom of the stack. 
  
Panel.hidden()  
Returns True if the panel is hidden (not visible), False otherwise. 
  
Panel.hide()  
Hide the panel. This does not delete the object, it just makes the window on screen invisible. 
  
Panel.move(y, x)  
Move the panel to the screen coordinates (y, x). 
  
Panel.replace(win)  
Change the window associated with the panel to the window win. 
  
Panel.set_userptr(obj)  
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. 
  
Panel.show()  
Display the panel (which might have been hidden). 
  
Panel.top()  
Push panel to the top of the stack. 
  
Panel.userptr()  
Returns the user pointer for the panel. This might be any Python object. 
  
Panel.window()  
Returns the window object associated with the panel.
curses.panel.new_panel(win)  
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.
Panel.hide()  
Hide the panel. This does not delete the object, it just makes the window on screen invisible.
Panel.move(y, x)  
Move the panel to the screen coordinates (y, x).
Panel.set_userptr(obj)  
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.
Panel.userptr()  
Returns the user pointer for the panel. This might be any Python object.
curses.panel.update_panels()  
Updates the virtual screen after changes in the panel stack. This does not call curses.doupdate(), so you’ll have to do this yourself.
curses.putp(str)  
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.
curses.qiflush([flag])  
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.
curses.raw()  
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.
curses.resetty()  
Restore the state of the terminal modes to what it was at the last call to savetty().
curses.reset_prog_mode()  
Restore the terminal to “program” mode, as previously saved by def_prog_mode().
curses.reset_shell_mode()  
Restore the terminal to “shell” mode, as previously saved by def_shell_mode().
curses.resizeterm(nlines, ncols)  
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).
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.savetty()  
Save the current state of the terminal modes in a buffer, usable by resetty().
curses.setsyx(y, x)  
Set the virtual screen cursor to y, x. If y and x are both -1, then leaveok is set True.
curses.setupterm(term=None, fd=-1)  
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.
curses.set_escdelay(ms)  
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.
curses.set_tabsize(size)  
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.
curses.start_color()  
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.
curses.termattrs()  
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.
curses.termname()  
Return the value of the environment variable TERM, as a bytes object, truncated to 14 characters.
curses.textpad.rectangle(win, uly, ulx, lry, lrx)  
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.
class curses.textpad.Textbox(win)  
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:  
edit([validator])  
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. 
  
do_command(ch)  
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). 
  
gather()  
Return the window contents as a string; whether blanks in the window are included is affected by the stripspaces member. 
  
stripspaces  
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.
do_command(ch)  
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).
edit([validator])  
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.
gather()  
Return the window contents as a string; whether blanks in the window are included is affected by the stripspaces member.
stripspaces  
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.
curses.tigetflag(capname)  
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.
curses.tigetnum(capname)  
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.
curses.tigetstr(capname)  
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.
curses.tparm(str[, ...])  
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.
curses.typeahead(fd)  
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.
curses.unctrl(ch)  
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.
curses.ungetch(ch)  
Push ch so the next getch() will return it.  Note Only one ch can be pushed before getch() is called.
curses.ungetmouse(id, x, y, z, bstate)  
Push a KEY_MOUSE event onto the input queue, associating the given state data with it.
curses.unget_wch(ch)  
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.
curses.update_lines_cols()  
Update LINES and COLS. Useful for detecting manual screen resize.  New in version 3.5.
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.use_env(flag)  
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).
curses.version  
A bytes object representing the current version of the module. Also available as __version__.
window.addch(ch[, attr])  
window.addch(y, x, ch[, attr])  
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.
window.addnstr(str, n[, attr])  
window.addnstr(y, x, str, n[, attr])  
Paint at most n characters of the character string str at (y, x) with attributes attr, overwriting anything previously on the display.