Инициализация и завершение¶Initialization and termination

curses.initscr()¶

Инициализирует библиотеку. Возвращает объект window, представляющий весь экран.

См. setupterm() о предостережении относительно вызова до этой функции.

Примечание

Если при открытии терминала возникает ошибка, базовая библиотека curses может вызвать завершение интерпретатора.

curses.endwin()¶

Деинициализирует библиотеку и возвращает терминал в обычное состояние.

curses.isendwin()¶

Возвращает True, если endwin() был вызван (то есть библиотека curses была деинициализирована).

curses.newterm(type=None, fd=None, infd=None, /)¶

Инициализирует новый терминал в дополнение к тому, который был инициализирован с помощью initscr(), и возвращает экран для него. Это позволяет программе управлять более чем одним терминалом.

type – это имя терминала, как в setupterm(); если None, используется значение переменной окружения TERM. fd и infd – это выходной и входной файлы для терминала: либо файловый объект, либо файловый дескриптор. По умолчанию они равны sys.stdout и sys.stdin.

Новый экран становится текущим. Используйте set_term() для переключения между экранами.

См. setupterm() о предостережении относительно вызова до этой функции.

Добавлено в версии 3.16.0a0 (не выпущена).

curses.new_prescr()¶

Возвращает новый экран, который можно использовать для вызова функций, влияющих на глобальное состояние, до того, как будет вызвана initscr() или newterm().

Доступность: если базовая библиотека curses предоставляет new_prescr().

Добавлено в версии 3.16.0a0 (не выпущена).

curses.set_term(screen, /)¶

Делает screen (экран, возвращённый newterm()) текущим терминалом и возвращает предыдущий текущий экран. Возвращает None, если предыдущий экран был создан с помощью initscr().

Добавлено в версии 3.16.0a0 (не выпущена).

curses.wrapper(func, /, *args, **kwargs)¶

Инициализирует curses и вызывает другой вызываемый объект – func, который должен быть остальной частью вашего приложения, использующего curses. Если приложение вызывает исключение, эта функция восстанавливает терминал в нормальное состояние перед повторным возбуждением исключения и формированием трассировки. Вызываемому объекту func передаётся главное окно 'stdscr' в качестве первого аргумента, а затем все остальные аргументы, переданные в wrapper(). Перед вызовом func функция wrapper() включает режим cbreak, отключает эхо, включает клавиатуру терминала и инициализирует цвета, если терминал поддерживает цвет. При завершении (нормальном или по исключению) она восстанавливает cooked-режим, включает эхо и отключает клавиатуру терминала.

Управление режимом терминала¶Terminal mode control

curses.def_prog_mode()¶

Сохраняет текущий режим терминала как «программный» режим – режим, в котором работающая программа использует curses. (Его аналог – «shell» режим, когда программа не в curses.) Последующие вызовы reset_prog_mode() восстановят этот режим.

curses.def_shell_mode()¶

Сохраняет текущий режим терминала как «shell» режим – режим, в котором работающая программа не использует curses. (Его аналог – «программный» режим, когда программа использует возможности curses.) Последующие вызовы reset_shell_mode() восстановят этот режим.

curses.reset_prog_mode()¶

Восстанавливает терминал в «программный» режим, как было сохранено ранее с помощью def_prog_mode().

curses.reset_shell_mode()¶

Восстанавливает терминал в «оболочечный» режим, как было сохранено ранее с помощью def_shell_mode().

curses.savetty()¶

Сохраняет текущее состояние режимов терминала в буфере, пригодном для использования с помощью resetty().

curses.resetty()¶

Восстанавливает состояние режимов терминала до того, которое было при последнем вызове savetty().

curses.curs_set(visibility)¶

Устанавливает состояние курсора. visibility может быть установлено в 0, 1 или 2 (невидимый, нормальный, очень видимый). Если терминал поддерживает запрошенный режим видимости, возвращает предыдущее состояние курсора; в противном случае вызывает исключение. На многих терминалах режим «visible» – это подчёркивающий курсор, а режим «very visible» – блочный курсор.

curses.getsyx()¶

Возвращает текущие координаты курсора виртуального экрана в виде кортежа (y, x). Если в данный момент leaveok равен True, возвращает (-1, -1).

curses.setsyx(y, x)¶

Устанавливает курсор виртуального экрана в позицию y, x. Если y и x оба равны -1, то leaveok устанавливается True.

curses.doupdate()¶

Обновляет физический экран. Библиотека curses хранит две структуры данных: одна представляет текущее содержимое физического экрана, а виртуальный экран – желаемое следующее состояние. Функция doupdate() обновляет физический экран, чтобы он соответствовал виртуальному.

Виртуальный экран можно обновить вызовом noutrefresh() после выполнения операций записи, таких как addstr(), в окне. Обычный вызов refresh() – это просто noutrefresh(), за которым следует doupdate(); если нужно обновить несколько окон, можно ускорить работу и уменьшить мерцание экрана, выполнив вызовы noutrefresh() для всех окон, а затем один doupdate().

Параметры ввода¶Input options

curses.cbreak()¶

Входит в режим cbreak. В режиме cbreak (иногда называемом «редким» режимом) нормальная буферизация строк tty отключается, и символы становятся доступными для чтения по одному. Однако, в отличие от raw-режима, специальные символы (прерывание, выход, приостановка и управление потоком) сохраняют своё воздействие на драйвер tty и вызывающую программу. Вызов сначала raw(), затем cbreak() оставляет терминал в режиме cbreak.

curses.nocbreak()¶

Выходит из режима cbreak. Возвращается к обычному «cooked»-режиму с буферизацией строк.

curses.echo()¶

Включает режим эхоповтора. В режиме эхоповтора каждый введённый символ отображается на экране по мере ввода.

curses.noecho()¶

Выходит из режима эхопечати. Эхо-вывод вводимых символов отключается.

curses.raw()¶

Переход в необработанный режим. В необработанном режиме отключаются обычная буферизация строк и обработка клавиш прерывания, выхода, приостановки и управления потоком; символы передаются функциям ввода curses по одному.

curses.noraw()¶

Выходит из режима raw. Возвращается к обычному «cooked»-режиму с буферизацией строк.

curses.halfdelay(tenths)¶

Используется для режима половинной задержки (half-delay), который похож на режим cbreak тем, что вводимые пользователем символы сразу становятся доступны программе. Однако после блокировки на tenths десятых долей секунды возбуждается исключение, если ничего не было введено. Значение tenths должно быть числом от 1 до 255. Используйте nocbreak() для выхода из режима половинной задержки.

curses.meta(flag)¶

Если flag равен True, разрешить ввод 8-битных символов. Если flag равен False, разрешить только 7-битные символы.

curses.nl(flag=True)¶

Включает режим перевода строки. В этом режиме клавиша возврата каретки преобразуется в перевод строки при вводе, а перевод строки преобразуется в возврат каретки и перевод строки при выводе. Режим перевода строки изначально включен.

Если flag равен False, эффект аналогичен вызову nonl().

curses.nonl()¶

Выходит из режима перевода строки. Отключает преобразование возврата каретки в перевод строки при вводе и отключает низкоуровневое преобразование перевода строки в возврат каретки/перевод строки при выводе (но это не меняет поведение addch('\n'), которое всегда выполняет эквивалент возврата каретки и перевода строки на виртуальном экране). При отключенном преобразовании curses иногда может немного ускорить вертикальное перемещение; также он сможет обнаруживать нажатие клавиши возврата каретки при вводе.

curses.intrflush(flag)¶

Если flag равен True, нажатие клавиши прерывания (interrupt, break или quit) сбросит весь вывод из очереди драйвера терминала. Если flag равен False, сброс не производится.

curses.qiflush([flag])¶

Если flag равно False, эффект аналогичен вызову noqiflush(). Если flag равно True или аргумент не указан, очереди будут сбрасываться при чтении этих управляющих символов.

curses.noqiflush()¶

При использовании процедуры noqiflush() обычный сброс очередей ввода и вывода, связанных с символами INTR, QUIT и SUSP, выполняться не будет. Возможно, стоит вызывать noqiflush() в обработчике сигнала, чтобы вывод продолжался так, как если бы прерывания не было, после выхода из обработчика.

curses.typeahead(fd)¶

Указывает, что файловый дескриптор fd должен использоваться для проверки упреждающего ввода. Если fd равен -1, то проверка упреждающего ввода не выполняется.

Библиотека curses выполняет «оптимизацию прерывания строки» (line-breakout optimization), периодически проверяя упреждающий ввод\nво время обновления экрана. Если ввод обнаружен и поступает с tty,\nтекущее обновление откладывается до следующего вызова refresh или doupdate,\nчто обеспечивает более быстрый ответ на заранее введённые команды. Эта функция\nпозволяет указать другой файловый дескриптор для проверки упреждающего ввода.

curses.is_cbreak()¶

Возвращает True, если режим cbreak (см. cbreak()) включён, False в противном случае. Доступно: ncurses 6.5 или новее.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.is_echo()¶

Возвращает True, если режим echo (см. echo()) включён, False в противном случае. Доступно: ncurses 6.5 или новее.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.is_nl()¶

Возвращает True, если режим nl (см. nl()) включён, False в противном случае. Доступно: ncurses 6.5 или новее.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.is_raw()¶

Возвращает True, если режим raw (см. raw()) включён, False в противном случае. Доступно: ncurses 6.5 или новее.

Добавлено в версии 3.16.0a0 (не выпущено).

Ввод с клавиатуры¶Keyboard input

curses.ungetch(ch)¶

Помещает ch так, что следующий вызов getch() или get_wch() вернёт его.

ch может быть целым числом (код клавиши или код символа), байтом или строкой длиной 1. Односимвольная строка помещается как unget_wch(); в узкой сборке она должна кодироваться в один байт.

Примечание

До вызова getch() можно поместить только один символ ch.

Изменено в версии 3.16.0a0 (не выпущено): Аргумент в виде односимвольной строки больше не обязан кодироваться в один байт, за исключением узкой сборки.

curses.unget_wch(ch)¶

Помещает ch в очередь, чтобы следующий вызов get_wch() вернул его.

Примечание

До вызова get_wch() можно поместить только один символ ch.

Добавлено в версии 3.3.

Изменено в версии 3.16.0a0 (не выпущено): Также доступно в узкой сборке, где ch должен кодироваться в один байт (8-битная локаль).

curses.flushinp()¶

Очищает все входные буферы. Отбрасывает любой упреждающий ввод, который был набран пользователем, но ещё не обработан программой.

curses.has_key(ch)¶

Принимает значение клавиши ch и возвращает True, если текущий тип терминала распознаёт клавишу с таким значением.

curses.keyname(k)¶

Возвращает имя клавиши с номером k в виде байтового объекта. Имя клавиши, создающей печатный символ ASCII, – это сам символ. Имя комбинации управляющей клавиши – это двухбайтовый байтовый объект, состоящий из знака вставки (b'^') с последующим соответствующим печатным символом ASCII. Имя комбинации alt-клавиши (128–255) – это байтовый объект, состоящий из префикса b'M-', за которым следует имя соответствующего символа ASCII.

Возбуждает ValueError, если k отрицателен.

curses.define_key(definition, keycode)¶

Определяет управляющую последовательность definition (строку) как клавишу, которая генерирует код клавиши keycode, так что curses интерпретирует её как одну из клавиш, предопределённых в терминальной базе данных.

Если definition равно None, любая существующая привязка для keycode удаляется. Если keycode равен нулю или отрицателен, удаляется любая привязка для definition.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.key_defined(definition)¶

Возвращает код клавиши, привязанный к управляющей последовательности definition (строке), 0, если ни один код клавиши не привязан, или -1, если definition является префиксом более длинной привязанной последовательности (то есть неоднозначен).

Добавлено в версии 3.16.0a0 (не выпущено).

curses.keyok(keycode, enable)¶

Включает (если enable равно true) или отключает (в противном случае) интерпретацию кода клавиши keycode. В отличие от window.keypad(), это влияет на один конкретный код клавиши, а не на все.

Добавлено в версии 3.16.0a0 (не выпущено).

Мышь¶Mouse

curses.getmouse()¶

После того как getch() возвращает KEY_MOUSE, сигнализируя о событии мыши, следует вызвать этот метод для получения события мыши из очереди. Событие представлено в виде кортежа из 5 элементов (id, x, y, z, bstate). id – это идентификатор, используемый для различения нескольких устройств, а x, y, z – координаты события. (z в настоящее время не используется.) bstate – целое число, биты которого указывают на тип события; это побитовое ИЛИ одной или нескольких следующих констант, где n – номер кнопки от 1 до 5: BUTTONn_PRESSED, BUTTONn_RELEASED, BUTTONn_CLICKED, BUTTONn_DOUBLE_CLICKED, BUTTONn_TRIPLE_CLICKED, BUTTON_SHIFT, BUTTON_CTRL, BUTTON_ALT.

Изменено в версии 3.10: Константы BUTTON5_* теперь доступны, если они предоставляются базовой библиотекой curses.

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

Помещает событие KEY_MOUSE во входную очередь, связывая с ним указанные данные состояния.

curses.mousemask(mousemask)¶

Устанавливает, какие события мыши отслеживать, и возвращает кортеж (availmask, oldmask). availmask указывает, какие из указанных событий мыши могут отслеживаться; в случае полной неудачи возвращается 0. oldmask – предыдущее значение маски событий мыши. Если эта функция ни разу не вызывалась, события мыши не отслеживаются.

curses.mouseinterval(interval)¶

Устанавливает максимальное время в миллисекундах, которое может пройти между нажатием и отпусканием, чтобы это считалось щелчком, и возвращает предыдущее значение интервала. Значение по умолчанию – 166 миллисекунд, или одна шестая секунды. Используйте отрицательное interval, чтобы получить значение интервала без его изменения.

curses.has_mouse()¶

Возвращает True, если драйвер мыши успешно инициализирован.

Доступность: если базовая библиотека curses предоставляет has_mouse().

Добавлено в версии 3.16.0a0 (не выпущено).

Цвет¶Color

curses.start_color()¶

Должна быть вызвана, если программист хочет использовать цвета, и перед вызовом любой другой процедуры управления цветом. Рекомендуется вызывать эту процедуру сразу после initscr().

start_color() инициализирует восемь базовых цветов (чёрный, красный, зелёный, жёлтый,\nсиний, пурпурный, голубой и белый) и две глобальные переменные в модуле curses:\nCOLORS и COLOR_PAIRS, содержащие максимальное количество\nцветов и цветовых пар, которые поддерживает терминал. Она также восстанавливает цвета\nна терминале до значений, которые были при его включении.

curses.has_colors()¶

Возвращает True, если терминал может отображать цвета; в противном случае возвращает False.

curses.has_extended_color_support()¶

Возвращает True, если модуль поддерживает расширенные цвета; в противном случае возвращает False. Расширенная поддержка цветов позволяет использовать более 256 цветовых пар для терминалов, поддерживающих более 16 цветов (например, xterm-256color).

Расширенная поддержка цветов требует ncurses версии 6.1 или выше.

Добавлено в версии 3.10.

curses.can_change_color()¶

Возвращает True или False в зависимости от того, может ли программист изменять цвета, отображаемые терминалом.

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

Изменяет определение цвета: принимает номер изменяемого цвета и три значения RGB (для количеств красной, зелёной и синей составляющих). Значение color_number должно быть от 0 до COLORS - 1. Каждое из r, g, b должно быть значением от 0 до 1000. При использовании init_color() все вхождения этого цвета на экране немедленно изменяются на новое определение. На большинстве терминалов эта функция ничего не делает; она активна только если can_change_color() возвращает True.

curses.color_content(color_number)¶

Возвращает интенсивность красного, зелёного и синего (RGB) компонентов цвета color_number, который должен быть в диапазоне от 0 до COLORS - 1. Возвращает кортеж из трёх элементов, содержащий значения R, G, B для указанного цвета; каждое значение будет в диапазоне от 0 (нет компонента) до 1000 (максимальная интенсивность компонента). Вызывает исключение, если цвет не поддерживается.

curses.init_pair(pair_number, fg, bg)¶

Изменяет определение цветовой пары. Принимает три аргумента: номер изменяемой цветовой пары, номер цвета переднего плана и номер цвета фона. Значение pair_number должно быть от 1 до COLOR_PAIRS - 1 (цветовую пару 0 можно изменить только с помощью use_default_colors() и assume_default_colors()). Значения аргументов fg и bg должны быть от 0 до COLORS - 1 или, после вызова use_default_colors() или assume_default_colors(), -1. Если цветовая пара была предварительно инициализирована, экран обновляется, и все вхождения этой пары заменяются новым определением.

curses.pair_content(pair_number)¶

Возвращает кортеж (fg, bg), содержащий цвета для запрошенной пары цветов. Значение pair_number должно находиться в диапазоне от 0 до COLOR_PAIRS - 1.

curses.color_pair(pair_number)¶

Возвращает значение атрибута для вывода текста в заданной цветовой паре. Могут быть представлены только те цветовые пары, которые помещаются в поле цветовой пары возвращаемого значения (обычно первые 256); больший pair_number вызывает OverflowError, а не молча маскируется на другую пару. Используйте color_set() или attr_set() для отображения более высоких пар. Это значение атрибута можно комбинировать с A_STANDOUT, A_REVERSE и другими атрибутами A_*. pair_number() является аналогом этой функции.

curses.pair_number(attr)¶

Возвращает номер пары цветов, установленной значением атрибута attr. color_pair() является аналогом этой функции.

curses.use_default_colors()¶

Эквивалентно assume_default_colors(-1, -1).

curses.assume_default_colors(fg, bg, /)¶

Разрешает использование значений по умолчанию для цветов на терминалах, поддерживающих эту возможность. Используется для поддержки прозрачности в приложении.

• Назначает цвета переднего и заднего плана терминала по умолчанию номеру цвета -1. Таким образом, init_pair(x, COLOR_RED, -1) инициализирует пару x как красный на фоне по умолчанию, а init_pair(x, -1, COLOR_BLUE) инициализирует пару x как передний план по умолчанию на синем.

• Изменяет определение цветовой пары 0 на (fg, bg).

Это расширение ncurses.

Добавлено в версии 3.14.

curses.alloc_pair(fg, bg)¶

Выделяет цветовую пару для цвета переднего плана fg и цвета фона bg, и возвращает её номер. Если цветовая пара для той же комбинации цветов уже существует, возвращает её номер. В противном случае выделяет новую цветовую пару и возвращает её номер.

Эта функция доступна только в том случае, если Python был собран для работы с широкосимвольной версией базовой библиотеки curses с поддержкой расширенных цветов (см. has_extended_color_support()).

Добавлено в версии 3.16.0a0 (не выпущена).

curses.free_pair(pair_number)¶

Освобождает цветовую пару pair_number, которая должна быть выделена с помощью alloc_pair(). Пара не должна использоваться.

Эта функция доступна только в том случае, если Python был собран для работы с широкосимвольной версией базовой библиотеки curses с поддержкой расширенных цветов (см. has_extended_color_support()).

Добавлено в версии 3.16.0a0 (не выпущена).

curses.find_pair(fg, bg)¶

Возвращает номер цветовой пары для цвета переднего плана fg и цвета фона bg, или -1, если для этой комбинации цветов не было выделено ни одной пары.

Эта функция доступна только в том случае, если Python был собран для работы с широкосимвольной версией базовой библиотеки curses с поддержкой расширенных цветов (см. has_extended_color_support()).

Добавлено в версии 3.16.0a0 (не выпущена).

curses.reset_color_pairs()¶

Сбрасывает все определения цветовых пар, освобождая пары, выделенные с помощью init_pair() и alloc_pair().

Эта функция доступна только в том случае, если Python был собран для работы с широкосимвольной версией базовой библиотеки curses с поддержкой расширенных цветов (см. has_extended_color_support()).

Добавлено в версии 3.16.0a0 (не выпущена).

Окна и pads¶Windows and pads

curses.newwin(nlines, ncols)¶

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

Возвращает новое окно, левый верхний угол которого находится в (begin_y, begin_x), а высота/ширина равны nlines/ncols.

По умолчанию окно будет расширяться от указанной позиции до нижнего правого угла экрана.

curses.newpad(nlines, ncols)¶

Создает и возвращает указатель на новую структуру данных pad с заданным количеством строк и столбцов. Возвращает pad как объект окна.

Pad похож на окно, за исключением того, что он не ограничен размером экрана и не обязательно связан с определенной частью экрана. Pad'ы можно использовать, когда нужно большое окно, а на экране одновременно видна только его часть. Автоматическое обновление pad'ов (например, при прокрутке или эхо-вводе) не происходит. Методы refresh() и noutrefresh() pad'а требуют 6 аргументов для указания отображаемой части pad'а и места на экране для отображения. Аргументы: pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol. Аргументы p относятся к левому верхнему углу отображаемой области pad'а, а аргументы s определяют прямоугольник отсечения на экране, в который будет выведена область pad'а.

Программируемые метки¶Soft labels

Следующие функции управляют клавишами программируемых меток – строкой меток, отображаемой вдоль нижней строки экрана, обычно используемой для подписи функциональных клавиш. slk_init() должна быть вызвана до initscr() или newterm(); она отнимает одну экранную строку у стандартного окна для меток.

curses.slk_init(fmt=0)¶

Резервирует экранную строку для программируемых меток и выбирает их размещение. fmt выбирает расположение: 0 для 3-2-3 (восемь меток), 1 для 4-4 (восемь меток). Если базовая библиотека curses их поддерживает, 2 даёт 4-4-4 (двенадцать меток) и 3 даёт 4-4-4 со строкой индекса.

Должна быть вызвана до initscr() или newterm().

Добавлено в версии 3.16.0a0 (не выпущена).

curses.slk_set(labnum, label, justify)¶

Устанавливает текст программной метки с номером labnum, в диапазоне от 1 до 8 (или 12 в двенадцатиметочном расположении). justify управляет тем, как label размещается внутри метки: 0 для выравнивания по левому краю, 1 для центрирования, 2 для выравнивания по правому краю.

Добавлено в версии 3.16.0a0 (не выпущена).

curses.slk_label(labnum)¶

Возвращает текущий текст мягкой метки номер labnum, выровненный так, как было задано, или пустую строку, если у неё нет метки.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.slk_refresh()¶

Обновляет мягкие метки на физическом экране, как refresh() для окна.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.slk_noutrefresh()¶

Обновляет мягкие метки на виртуальном экране, как window.noutrefresh(). Используется вместе с doupdate() для пакетного обновления экрана.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.slk_clear()¶

Удаляет мягкие метки с экрана.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.slk_restore()¶

Восстанавливает мягкие метки на экране после slk_clear().

Добавлено в версии 3.16.0a0 (не выпущено).

curses.slk_touch()¶

Принудительно перерисовывает все мягкие метки при следующем slk_refresh() или slk_noutrefresh().

Добавлено в версии 3.16.0a0 (не выпущено).

curses.slk_attron(attr)¶

curses.slk_attroff(attr)¶

curses.slk_attrset(attr)¶

Добавляет, удаляет или задаёт атрибуты, используемые для отображения мягких меток, заданные в виде упакованных A_* атрибутов.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.slk_attr()¶

Возвращает текущие атрибуты мягких меток в виде упакованных A_* атрибутов. Доступность зависит от используемой библиотеки curses.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.slk_attr_on(attr)¶

curses.slk_attr_off(attr)¶

Включает или выключает указанные атрибуты, не затрагивая остальные. Как и методы окна attr_*, они работают с атрибутами WA_*, а не с упакованными A_* атрибутами.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.slk_attr_set(attr, pair=0)¶

Задаёт атрибуты и цветовую пару мягких меток. attr задаётся как атрибуты WA_*, а pair – как номер цветовой пары.

Добавлено в версии 3.16.0a0 (не выпущена).

curses.slk_color(pair)¶

Устанавливает цветовую пару для программируемых меток по номеру цветовой пары pair.

Добавлено в версии 3.16.0a0 (не выпущена).

Сохранение и восстановление¶Saving and restoring

curses.getwin(file)¶

Читает данные окна из файла, сохранённые предыдущим вызовом window.putwin(). Затем процедура создаёт и инициализирует новое окно, используя эти данные, и возвращает объект нового окна. Аргумент file должен быть файловым объектом, открытым для чтения в двоичном режиме.

curses.scr_dump(filename)¶

Записывает текущее содержимое виртуального экрана в filename, который может быть строкой или объектом, подобным пути. Файл впоследствии может быть прочитан с помощью scr_restore(), scr_init() или scr_set(). Это полноэкранный аналог window.putwin().

Добавлено в версии 3.16.0a0 (не выпущена).

curses.scr_restore(filename)¶

Устанавливает виртуальный экран в содержимое filename, которое должно быть записано с помощью scr_dump(). Следующий вызов doupdate() или window.refresh() восстанавливает экран в это содержимое.

Добавлено в версии 3.16.0a0 (не выпущена).

curses.scr_init(filename)¶

Инициализирует предполагаемое содержимое терминала из filename, который должен быть записан с помощью scr_dump(). Используйте это, когда терминал уже отображает это содержимое, например, после того, как другая программа нарисовала экран, чтобы curses не перерисовывал то, что уже отображено.

Добавлено в версии 3.16.0a0 (не выпущена).

curses.scr_set(filename)¶

Использует filename, который должен быть записан с помощью scr_dump(), как виртуальный экран и предполагаемое содержимое терминала. Это объединяет эффекты scr_restore() и scr_init().

Добавлено в версии 3.16.0a0 (не выпущена).

Запрос терминала¶Querying the terminal

curses.baudrate()¶

Возвращает скорость вывода терминала в битах в секунду. На программных терминальных эмуляторах она будет иметь фиксированное высокое значение. Включена по историческим причинам; в прежние времена она использовалась для написания циклов вывода с временными задержками и иногда для изменения интерфейсов в зависимости от скорости линии.

curses.erasechar()¶

Возвращает текущий символ стирания пользователя в виде сырого байта, объекта bytes длиной 1. См. также erasewchar().

curses.erasewchar()¶

Возвращает текущий символ стирания пользователя в виде односимвольного str. В операционных системах Unix это свойство управляющего tty программы curses и не устанавливается самой библиотекой curses.

Добавлено в версии 3.16.0a0 (не выпущена).

curses.killchar()¶

Возвращает текущий символ удаления строки пользователя в виде сырого байта, объекта bytes длиной 1. См. также killwchar().

curses.killwchar()¶

Возвращает текущий символ удаления строки пользователя в виде односимвольного str. В операционных системах Unix это свойство управляющего tty программы curses и не устанавливается самой библиотекой curses.

Добавлено в версии 3.16.0a0 (не выпущена).

curses.termname()¶

Возвращает значение переменной окружения TERM в виде объекта bytes,\nусечённое до 14 символов.

curses.longname()¶

Возвращает байтовый объект, содержащий поле длинного имени terminfo, описывающее текущий терминал. Максимальная длина подробного описания – 128 символов. Оно определено только после вызова initscr().

curses.termattrs()¶

Возвращает логическое ИЛИ всех видеоатрибутов, поддерживаемых терминалом. Эта\nинформация полезна, когда программа curses требует полного контроля над\nвнешним видом экрана.

curses.term_attrs()¶

Как termattrs(), но возвращает атрибуты в виде значений WA_*, а не A_* значений.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.has_ic()¶

Возвращает True, если терминал поддерживает вставку и удаление символов. Эта функция включена только по историческим причинам, так как все современные программные эмуляторы терминала имеют такие возможности.

curses.has_il()¶

Возвращает True, если терминал поддерживает вставку и удаление строк, или может имитировать их с помощью областей прокрутки. Эта функция включена только по историческим причинам, так как все современные программные эмуляторы терминала имеют такие возможности.

Звуковой сигнал и вспышка экрана¶Bell and screen flash

curses.beep()¶

Издаёт короткий звуковой сигнал.

curses.flash()¶

Выполняет вспышку экрана. То есть переключает его в режим инвертированного видео и обратно через короткий интервал. Некоторые предпочитают такой «видимый звонок» звуковому сигналу внимания, создаваемому beep().

Изменение размера терминала¶Terminal resizing

curses.resizeterm(nlines, ncols)¶

Изменяет размеры стандартного и текущего окон до указанных размеров и корректирует другие служебные данные, используемые библиотекой curses для записи размеров окон (в частности, обработчик SIGWINCH).

curses.resize_term(nlines, ncols)¶

Внутренняя функция, используемая resizeterm(), выполняющая основную работу; при изменении размеров окон resize_term() заполняет пробелами расширенные области. Вызывающее приложение должно заполнить эти области соответствующими данными. Функция resize_term() пытается изменить размеры всех окон. Однако из-за соглашения о вызове панелей невозможно изменить их размер без дополнительного взаимодействия с приложением.

curses.is_term_resized(nlines, ncols)¶

Возвращает True, если resize_term() изменит структуру окна, в противном случае False.

curses.update_lines_cols()¶

Обновляет переменные модуля LINES и COLS. Полезно для обнаружения ручного изменения размера экрана.

Добавлено в версии 3.5.

База данных Terminfo¶Terminfo database

curses.setupterm(term=None, fd=-1)¶

Инициализирует терминал. term – строка, задающая имя терминала\nили None; если опущена или None, будет использовано значение переменной окружения\nTERM. fd – файловый дескриптор, на который будут отправляться любые\nпоследовательности инициализации; если не указан или -1, будет использован\nфайловый дескриптор для sys.stdout.

Вызывает curses.error, если терминал не найден или не удалось прочитать его запись\nв базе terminfo. Если терминал уже был\nинициализирован, эта функция не даёт эффекта.

Примечание

Вызов initscr() или newterm() после setupterm() приводит к утечке терминала, выделенного setupterm(): библиотека curses хранит только один текущий терминал и не освобождает ранее выделенный.

curses.tigetflag(capname)¶

Возвращает значение булевой возможности, соответствующей имени возможности terminfo\ncapname, в виде целого числа. Возвращает значение -1, если capname не является\nбулевой возможностью, или 0, если она отменена или отсутствует в описании\nтерминала.

setupterm() (или initscr()) должна быть вызвана первой.

curses.tigetnum(capname)¶

Возвращает значение числовой возможности, соответствующей имени возможности terminfo\ncapname, в виде целого числа. Возвращает значение -2, если capname не является\nчисловой возможностью, или -1, если она отменена или отсутствует в описании\nтерминала.

setupterm() (или initscr()) должна быть вызвана первой.

curses.tigetstr(capname)¶

Возвращает значение строковой возможности, соответствующей имени возможности terminfo\ncapname, в виде объекта bytes. Возвращает None, если capname\nне является «строковой возможностью» terminfo, либо отменена или отсутствует в\nописании терминала.

setupterm() (или initscr()) должна быть вызвана первой.

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

Создаёт экземпляр объекта bytes str с заданными параметрами, где str должна\nбыть параметризованной строкой, полученной из базы terminfo. Например,\ntparm(tigetstr("cup"), 5, 3) может дать b'\033[6;4H', точный\nрезультат зависит от типа терминала. Можно передать до девяти целочисленных параметров.

setupterm() (или initscr()) должна быть вызвана первой.

curses.putp(str)¶

Эквивалентно tputs(str, 1, putchar); выводит значение указанной возможности terminfo для текущего терминала. Обратите внимание, что вывод putp() всегда направляется в стандартный вывод.

setupterm() (или initscr()) должна быть вызвана первой.

Утилиты¶Utilities

curses.unctrl(ch)¶

Возвращает объект bytes, содержащий печатное представление символа ch. ch не может быть символом, который не помещается в один байт; для таких используйте wunctrl().

curses.wunctrl(ch)¶

Возвращает строку, которая является печатным представлением символа ch; все атрибуты и цветовая пара игнорируются. Управляющие символы ASCII представляются в виде знака вставки (caret), за которым следует символ, например '^C'. Печатные символы, включая не-ASCII символы, печатаемые в текущей локали, остаются без изменений. Представление других символов определяется используемой библиотекой curses.

Добавлено в версии 3.16.0a0 (не выпущено).

curses.filter()¶

Подпрограмма filter(), если используется, должна вызываться до вызова initscr(). Эффект заключается в том, что во время инициализации LINES устанавливается в 1; отключаются возможности clear, cup, cud, cud1, cuu1, cuu, vpa; а строка home устанавливается в значение cr. В результате курсор и обновления экрана ограничиваются текущей строкой. Это может использоваться для построчного редактирования посимвольно, не затрагивая остальную часть экрана.

curses.nofilter()¶

Отменяет действие предыдущего вызова filter(). Как и filter(), должна быть вызвана до initscr() (или newterm()), чтобы следующая инициализация снова использовала весь экран.

Доступность: если используемая библиотека curses предоставляет nofilter().

Добавлено в версии 3.16.0a0 (не выпущено).

curses.use_env(flag)¶

Если эта функция используется, её следует вызывать до вызова initscr() или newterm. Когда flag равен False, используются значения строк и столбцов, указанные в базе terminfo, даже если установлены переменные окружения LINES и COLUMNS (используемые по умолчанию) или если curses работает в окне (в этом случае поведением по умолчанию было бы использование размера окна, если LINES и COLUMNS не установлены).

curses.get_escdelay()¶

Возвращает значение, установленное set_escdelay().

Добавлено в версии 3.9.

curses.set_escdelay(ms)¶

Устанавливает количество миллисекунд ожидания после чтения escape-символа, чтобы различать отдельный escape-символ, введённый с клавиатуры, и escape-последовательности, отправляемые клавишами курсора и функциональными клавишами.

Добавлено в версии 3.9.

curses.get_tabsize()¶

Возвращает значение, установленное set_tabsize().

Добавлено в версии 3.9.

curses.set_tabsize(size)¶

Устанавливает количество столбцов, используемое библиотекой curses при преобразовании символа табуляции в пробелы при добавлении табуляции в окно.

Добавлено в версии 3.9.

curses.napms(ms)¶

Приостанавливает выполнение на ms миллисекунд.

curses.delay_output(ms)¶

Вставляет паузу в вывод на ms миллисекунд.

Добавление и вставка текста¶Adding and inserting text

window.addch(ch[, attr])¶

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

Выводит символ ch в позиции (y, x) с атрибутами attr, перезаписывая любой символ, ранее выведенный в этой позиции. По умолчанию позиция символа и атрибуты берутся из текущих настроек объекта окна.

ch может быть одним символом, за которым могут следовать комбинирующие символы, которые вместе занимают одну символьную ячейку.

Примечание

Запись за пределами окна, подокна или pad'а вызывает исключение curses.error. Попытка записи в правый нижний угол окна, подокна или pad'а приведёт к возбуждению исключения после вывода символа.

Изменено в версии 3.16.0a0 (не выпущена): Теперь символ можно задать в виде строки из базового символа, за которым следуют комбинирующие символы, а не только как одиночный символ, или как complexchar ячейка.

window.addstr(str[, attr])¶

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

Выводит строку str в позиции (y, x) с атрибутами attr, перезаписывая всё, что ранее было на экране.

str также может быть complexstr; в этом случае каждая ячейка несёт свои собственные атрибуты и цветовую пару, поэтому attr указывать нельзя. complexstr полученный из in_wchstr(), записывается обратно без изменений.

Примечание

• Запись за пределами окна, подокна или pad'а вызывает исключение curses.error. Попытка записи в правый нижний угол окна, подокна или pad'а приведёт к возбуждению исключения после вывода строки.

• Ошибка в ncurses (бэкенде этого модуля Python) могла вызывать ошибку сегментации при изменении размера окон. Это было исправлено в ncurses-6.1-20190511. Если вы вынуждены использовать более старую версию ncurses, вы можете избежать этой ошибки, не вызывая addstr() с str, содержащим символы новой строки; вместо этого вызывайте addstr() отдельно для каждой строки.

Изменено в версии 3.16.0a0 (не выпущена): Теперь str также может быть complexstr, как описано выше.

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

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

Выводит не более n символов строки str в позиции (y, x) с атрибутами attr, перезаписывая всё, что ранее было на экране.

Изменено в версии 3.16.0a0 (не выпущена): Теперь str также может быть complexstr; см. addstr().

window.echochar(ch[, attr])¶

Добавляет символ ch с атрибутом attr и сразу же вызывает refresh() для окна.

Изменено в версии 3.16.0a0 (не выпущена): Широкие и комбинирующие символы, а также ячейки complexchar, теперь принимаются.

window.insch(ch[, attr])¶

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

Вставляет символ ch с атрибутами attr перед символом под курсором или в позиции (y, x), если указано. Все символы правее курсора сдвигаются на одну позицию вправо, при этом крайний правый символ строки теряется. Положение курсора не меняется.

Изменено в версии 3.16.0a0 (не выпущена): Широкие и комбинирующие символы, а также ячейки complexchar, теперь принимаются.

window.insstr(str[, attr])¶

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

Вставляет строку символов (столько символов, сколько помещается на строке) перед символом под курсором. Все символы справа от курсора сдвигаются вправо, при этом крайние правые символы строки теряются. Позиция курсора не меняется (после перемещения в y, x, если указано).

str также может быть complexstr; в этом случае каждая ячейка несёт свои собственные атрибуты и цветовую пару, поэтому attr указывать нельзя.

Изменено в версии 3.16.0a0 (не выпущена): Теперь str также может быть complexstr, как описано выше.

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

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

Вставляет строку символов (столько символов, сколько помещается на строке) перед символом под курсором, до n символов. Если n равно нулю или отрицательно, вставляется вся строка. Все символы справа от курсора сдвигаются вправо, при этом крайние правые символы строки теряются. Позиция курсора не меняется (после перемещения в y, x, если указано).

Изменено в версии 3.16.0a0 (не выпущена): Теперь str также может быть complexstr; см. insstr().

Удаление и вставка строк¶Deleting and inserting lines

window.delch([y, x])¶

Удаляет символ под курсором или в позиции (y, x), если она указана. Все символы справа в той же строке сдвигаются на одну позицию влево.

window.deleteln()¶

Удаляет строку под курсором. Все последующие строки сдвигаются вверх на одну.

window.insertln()¶

Вставляет пустую строку под курсором. Все последующие строки сдвигаются на одну строку вниз.

window.insdelln(nlines)¶

Вставляет nlines строк в указанное окно над текущей строкой. nlines нижних строк теряются. При отрицательном nlines удаляет nlines строк, начиная с той, на которой находится курсор, и сдвигает оставшиеся строки вверх. Нижние nlines строк очищаются. Текущая позиция курсора остаётся неизменной.

Чтение ввода¶Reading input

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 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. A multibyte character is returned as its encoded bytes one at a time; use get_wch() to read it as a single character.

window.get_wch([y, x])¶

Получить широкий символ. Возвращает символ для большинства клавиш или целое число для функциональных клавиш, клавиш цифровой клавиатуры и других специальных клавиш. В отличие от getch(), обычная клавиша возвращается как односимвольная str. В режиме без задержки вызывает исключение, если ввода нет.

Добавлено в версии 3.3.

Изменено в версии 3.16.0a0 (не выпущена): Также доступно в узкой сборке, где может быть возвращён только символ, представимый одним байтом (8-битная локаль).

window.getkey([y, x])¶

Возвращает символ в виде строки, а не целого числа, как getch(). Функциональные клавиши, клавиши цифровой клавиатуры и другие специальные клавиши возвращают многобайтовую строку, содержащую имя клавиши. В режиме без задержки, если нет ввода, генерируется исключение.

window.getstr()¶

window.getstr(n)

window.getstr(y, x)

window.getstr(y, x, n)

Считывает объект bytes от пользователя с возможностью примитивного редактирования строки. Максимум n символов читается; n по умолчанию равен 2047 и не может его превышать. Многобайтовый символ возвращается в виде закодированных байтов; используйте get_wstr() для чтения ввода как str.

Изменено в версии 3.14: Максимальное значение n увеличено с 1023 до 2047.

window.get_wstr()¶

window.get_wstr(n)

window.get_wstr(y, x)

window.get_wstr(y, x, n)

Считывает строку от пользователя с возможностью примитивного редактирования строки. В отличие от getstr(), может возвращать символы, непредставимые в кодировке окна. Максимум n символов читается; n по умолчанию равен 2047 и не может его превышать.

Добавлено в версии 3.16.0a0 (не выпущена).

window.getdelay()¶

Возвращает тайм-аут чтения окна в миллисекундах, заданный с помощью nodelay() или timeout(): -1 для блокирующего режима, 0 для неблокирующего, или положительное число миллисекунд.

Добавлено в версии 3.16.0a0 (не выпущена).

Чтение содержимого окна¶Reading window contents

window.inch([y, x])¶

Возвращает символ в заданной позиции окна. Младшие 8 бит – это сам символ, а старшие биты – атрибуты; извлеките их с помощью битовых масок A_CHARTEXT и A_ATTRIBUTES, а цветовую пару – с помощью pair_number(). Он не может представлять ячейку, содержащую комбинируемые символы, символ, не помещающийся в один байт, или цветовую пару вне диапазона color_pair(); используйте in_wch() для таких случаев, он возвращает их как complexchar.

window.in_wch([y, x])¶

Возвращает составной символ в заданной позиции окна как complexchar. В отличие от inch(), возвращаемый объект содержит текст ячейки (разделительный символ, за которым могут следовать комбинируемые символы) вместе с его атрибутами и цветовой парой.

Добавлено в версии 3.16.0a0 (не выпущена).

window.instr([n])¶

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

Возвращает объект bytes, содержащий символы, извлечённые из окна, начиная с текущей позиции курсора или с y, x, если указано, и до конца строки. Атрибуты и информация о цвете удаляются из символов. Если указан n, instr() возвращает строку длиной не более n символов (не включая завершающий NUL). Максимальное значение n – 2047. Символ, который нельзя представить в кодировке окна, не может быть возвращён; используйте in_wstr() для таких случаев.

Изменено в версии 3.14: Максимальное значение n увеличено с 1023 до 2047.

window.in_wstr([n])¶

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

Возвращает строку символов, извлечённых из окна, начиная с текущей позиции курсора или с y, x, если указано. В отличие от instr(), этот метод может возвращать символы, которые нельзя представить в кодировке окна. Атрибуты и информация о цвете удаляются из символов. Максимальное значение n – 2047.

Добавлено в версии 3.16.0a0 (не выпущено).

window.in_wchstr([n])¶

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

Возвращает complexstr оформленных ячеек, извлечённых из окна, начиная с текущей позиции курсора или с y, x, если указано, и до конца строки. Это вариант методов instr() и in_wstr(), который сохраняет атрибуты и цветовую пару каждой ячейки (те методы удаляют оформление). Если указан n, возвращается не более n ячеек. Максимальное значение n – 2047.

Результат можно записать обратно без изменений с помощью addstr() (чтение и запись – это циклическая операция, которая сохраняет оформление каждой ячейки).

Добавлено в версии 3.16.0a0 (не выпущено).

Атрибуты¶Attributes

window.attroff(attr)¶

Удаляет атрибут attr из набора «фоновых» атрибутов, применяемых ко всем записям в текущее окно.

window.attron(attr)¶

Добавляет атрибут attr к набору «фоновых» атрибутов, применяемых ко всем записям в текущее окно.

window.attrset(attr)¶

Устанавливает набор «фоновых» атрибутов равным attr. Изначально этот набор равен 0 (без атрибутов).

window.attr_get()¶

Возвращает текущее оформление окна в виде кортежа (attrs, pair), где attrs – это набор атрибутов, а pair – номер цветовой пары.

В отличие от attron() и подобных методов, которые принимают упакованные атрибуты A_*, этот метод и другие методы attr_* работают с атрибутами WA_* и хранят номер цветовой пары отдельно, что позволяет использовать цветовые пары, которые вместе с атрибутами не помещаются в одно значение.

Добавлено в версии 3.16.0a0 (не выпущено).

window.attr_set(attr, pair=0)¶

Устанавливает оформление окна: атрибуты attr и цветовую пару pair.

Добавлено в версии 3.16.0a0 (не выпущено).

window.attr_on(attr)¶

Включает атрибуты attr, не затрагивая остальные.

Добавлено в версии 3.16.0a0 (не выпущено).

window.attr_off(attr)¶

Выключает атрибуты attr, не затрагивая остальные.

Добавлено в версии 3.16.0a0 (не выпущено).

window.color_set(pair)¶

Устанавливает цветовую пару окна в pair, оставляя остальные атрибуты без изменений.

Добавлено в версии 3.16.0a0 (не выпущено).

window.getattrs()¶

Возвращает текущие атрибуты окна.

Добавлено в версии 3.16.0a0 (не выпущена).

window.standout()¶

Включить атрибут A_STANDOUT.

window.standend()¶

Выключить атрибут выделения (standout). На некоторых терминалах это имеет побочный эффект выключения всех атрибутов.

window.chgat(attr)¶

window.chgat(num, attr)

window.chgat(y, x, attr)

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

Устанавливает атрибуты num символов в текущей позиции курсора или в позиции (y, x), если она указана. Если num не задан или равен -1, атрибут будет установлен для всех символов до конца строки. Эта функция перемещает курсор в позицию (y, x), если она указана. Изменённая строка будет помечена с помощью метода touchline(), чтобы её содержимое было перерисовано при следующем обновлении окна.

Предыстория¶Background

window.bkgd(ch[, attr])¶

Устанавливает фоновое свойство окна на символ ch с атрибутами attr. Затем изменение применяется ко всем позициям символов в этом окне:

• Атрибут каждого символа в окне изменяется на новый фоновый атрибут.

• Везде, где встречается прежний фоновый символ, он заменяется на новый фоновый символ.

Изменено в версии 3.16.0a0 (не выпущена): Широкие и комбинирующие символы, а также ячейки complexchar теперь принимаются.

window.bkgdset(ch[, attr])¶

Устанавливает фон окна. Фон окна состоит из символа и любой комбинации атрибутов. Часть атрибута фона комбинируется (логическим ИЛИ) со всеми непустыми символами, которые записываются в окно. Как символьная, так и атрибутная части фона комбинируются с пустыми символами. Фон становится свойством символа и перемещается вместе с символом при любых операциях прокрутки, вставки/удаления строк/символов.

Изменено в версии 3.16.0a0 (не выпущена): Широкие и комбинирующие символы, а также ячейки complexchar теперь принимаются.

window.getbkgd()¶

Возвращает текущую пару символ/атрибут фона указанного окна. Её компоненты можно извлечь аналогично inch(). Она не может представлять фон, установленный с широким символом или с цветовой парой вне диапазона color_pair(); для таких случаев используйте getbkgrnd().

window.getbkgrnd()¶

Возвращает текущий фон указанного окна в виде complexchar. В отличие от getbkgd(), возвращаемый объект содержит символ фона вместе с его атрибутами и цветовой парой, причём цветовая пара не ограничена значением, помещающимся в color_pair().

Добавлено в версии 3.16.0a0 (не выпущена).

Очистка и удаление¶Clearing and erasing

window.erase()¶

Очищает окно.

window.clear()¶

Как erase(), но также вызывает перерисовку всего окна при следующем вызове refresh().

window.clrtobot()¶

Стирает от курсора до конца окна: все строки ниже курсора удаляются, а затем выполняется эквивалент clrtoeol().

window.clrtoeol()¶

Стирает от курсора до конца строки.

Границы и линии¶Borders and lines

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

Рисует рамку по краям окна. Каждый параметр задаёт символ для конкретной части рамки; см. таблицу ниже для более подробной информации.

Примечание

Значение 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

Изменено в версии 3.16.0a0 (не выпущена): Широкие и комбинирующие символы, а также ячейки complexchar теперь принимаются. Один вызов не может смешивать их с целочисленными или байтовыми символами.

window.box([vertch, horch])¶

Аналогично border(), но оба ls и rs – это vertch, а оба ts и bs – это horch. Символы углов по умолчанию всегда используются этой функцией.

Изменено в версии 3.16.0a0 (не выпущена): Широкие и комбинирующие символы, а также ячейки complexchar теперь принимаются. Один вызов не может смешивать их с целочисленными или байтовыми символами.

window.hline(ch, n[, attr])¶

window.hline(y, x, ch, n[, attr])

Отображает горизонтальную линию, начинающуюся в (y, x), длиной n, состоящую из символа ch с атрибутами attr. Линия обрывается у правого края окна, если доступно меньше n ячеек.

Изменено в версии 3.16.0a0 (не выпущена): Широкие и комбинирующие символы, а также ячейки complexchar теперь принимаются.

window.vline(ch, n[, attr])¶

window.vline(y, x, ch, n[, attr])

Отображает вертикальную линию, начинающуюся в (y, x), длиной n, состоящую из символа ch с атрибутами attr.

Изменено в версии 3.16.0a0 (не выпущена): Широкие и комбинирующие символы, а также ячейки complexchar теперь принимаются.

Позиция курсора и геометрия окна¶Cursor position and window geometry

window.move(new_y, new_x)¶

Перемещает курсор в (new_y, new_x).

window.getyx()¶

Возвращает кортеж (y, x) с текущей позицией курсора относительно верхнего левого угла окна.

window.getbegyx()¶

Возвращает кортеж (y, x) с координатами верхнего левого угла.

window.getmaxyx()¶

Возвращает кортеж (y, x) из высоты и ширины окна.

window.getparyx()¶

Возвращает начальные координаты этого окна относительно родительского окна в виде кортежа (y, x). Возвращает (-1, -1), если у этого окна нет родителя.

window.getparent()¶

Возвращает родительское окно этого подокна или None, если это окно не является подокном.

Добавлено в версии 3.16.0a0 (не выпущена).

Создание и изменение размера окон¶Creating and resizing windows

window.subwin(begin_y, begin_x)¶

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

Возвращает подокно, левый верхний угол которого находится в экранных координатах (begin_y, begin_x), а ширина/высота равна ncols/nlines.

По умолчанию подокно будет простираться от указанной позиции до нижнего правого угла окна.

window.derwin(begin_y, begin_x)¶

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

Сокращение от «derive window», derwin() аналогично вызову subwin(), за исключением того, что begin_y и begin_x задаются относительно начала окна, а не всего экрана. Возвращает объект окна для производного окна.

window.subpad(begin_y, begin_x)¶

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

Возвращает подпанель, левый верхний угол которой находится в (begin_y, begin_x), а ширина/высота равна ncols/nlines. Координаты задаются относительно родительской панели (в отличие от subwin(), который использует экранные координаты). Этот метод доступен только для панелей, созданных с помощью newpad().

window.dupwin()¶

Возвращает новое окно, которое является точной копией исходного: оно имеет те же размер, позицию, содержимое и атрибуты. В отличие от окна, созданного с помощью subwin() или derwin(), копия независима от оригинала – у неё собственный буфер ячеек, поэтому последующие изменения в одном окне не влияют на другое.

Добавлено в версии 3.16.0a0 (не выпущена).

window.mvwin(new_y, new_x)¶

Перемещает окно так, чтобы его верхний левый угол находился в (new_y, new_x).

Перемещение окна так, чтобы какая-либо его часть оказалась за пределами экрана, является ошибкой: окно не перемещается и возбуждается curses.error.

window.mvderwin(y, x)¶

Перемещает окно внутри его родительского окна. Экранно-относительные параметры окна не изменяются. Эта процедура используется для отображения разных частей родительского окна в одной и той же физической позиции на экране.

window.resize(nlines, ncols)¶

Перераспределить память для окна curses, чтобы изменить его размеры до указанных значений. Если любой из размеров больше текущих, данные окна заполняются пробелами, в которые влито текущее оформление фона (заданное с помощью bkgdset()).

Обновление и перерисовка¶Refreshing and redrawing

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

Обновить отображение немедленно (синхронизировать фактический экран с предыдущими методами рисования/удаления).

Эти шесть аргументов можно указывать (и они становятся обязательными) только в том случае, если окно является панелью, созданной с помощью newpad(). Дополнительные параметры нужны для указания того, какая часть панели и экрана участвует. pminrow и pmincol задают верхний левый угол прямоугольника, отображаемого в панели. sminrow, smincol, smaxrow и smaxcol задают границы прямоугольника, отображаемого на экране. Нижний правый угол прямоугольника в панели вычисляется из координат экрана, так как прямоугольники должны быть одного размера. Оба прямоугольника должны полностью помещаться в соответствующих структурах. Отрицательные значения pminrow, pmincol, sminrow или smincol обрабатываются как нулевые.

window.noutrefresh()¶

window.noutrefresh(pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol)

Пометить для обновления, но подождать. Эта функция обновляет структуру данных, представляющую желаемое состояние окна, но не принуждает к обновлению физического экрана. Для этого нужно вызвать doupdate().

Шесть аргументов можно указывать (и они становятся обязательными) только в том случае, если окно является панелью, созданной с помощью newpad(); их смысл совпадает с refresh().

window.redrawln(beg, num)¶

Указать, что num строк экрана, начиная со строки beg, повреждены и должны быть полностью перерисованы при следующем вызове refresh().

window.redrawwin()¶

Пометить всё окно как изменённое, что приведёт к его полной перерисовке при следующем вызове refresh().

Параметры вывода¶Output options

window.clearok(flag)¶

Если flag равен True, следующий вызов refresh() полностью очистит окно.

window.idlok(flag)¶

Если flag равен True, curses попытается использовать аппаратные средства редактирования строк. В противном случае curses не будет их использовать.

window.idcok(flag)¶

Если flag равен False, curses больше не будет использовать аппаратную возможность терминала для вставки/удаления символов; если flag равен True, использование вставки и удаления символов включается. При первой инициализации curses вставка/удаление символов включены по умолчанию.

window.immedok(flag)¶

Если flag равен True, любое изменение изображения окна автоматически вызывает его обновление; больше не нужно вызывать refresh() вручную. Однако это может значительно снизить производительность из-за многократных вызовов wrefresh. Эта опция отключена по умолчанию.

window.leaveok(flag)¶

Если flag равен True, курсор после обновления остаётся на месте, а не перемещается в «позицию курсора». Это уменьшает перемещение курсора, где это возможно.

Если flag равен False, курсор всегда будет находиться в «позиции курсора» после обновления.

window.scrollok(flag)¶

Управляет тем, что происходит, когда курсор окна выходит за край окна или области прокрутки, будь то в результате перевода строки на нижней строке или ввода последнего символа последней строки. Если flag равен False, курсор остаётся на нижней строке. Если flag равен True, окно прокручивается на одну строку вверх. Обратите внимание: для получения физического эффекта прокрутки на терминале необходимо также вызвать idlok().

window.scroll([lines=1])¶

Прокрутить экран или область прокрутки. Прокрутка вверх на lines строк, если lines положительно, или вниз, если отрицательно. Прокрутка не действует, если она не была включена для окна с помощью scrollok().

window.setscrreg(top, bottom)¶

Установить область прокрутки от строки top до строки bottom. Все действия прокрутки будут происходить в этой области.

window.getscrreg()¶

Возвращает кортеж (top, bottom) с текущей областью прокрутки окна, как задано setscrreg().

Добавлено в версии 3.16.0a0 (не выпущена).

window.syncok(flag)¶

Если flag равен True, то syncup() вызывается автоматически при любом изменении в окне.

Параметры ввода¶Input options

window.keypad(flag)¶

Если flag равен True, escape-последовательности, генерируемые некоторыми клавишами (цифровая клавиатура, функциональные клавиши), будут интерпретироваться curses. Если flag равен False, escape-последовательности останутся во входном потоке как есть.

window.nodelay(flag)¶

Если flag равен True, getch() будет неблокирующим.

window.notimeout(flag)¶

Если flag равен True, для управляющих последовательностей не будет установлен тайм-аут.

Если flag равен False, через несколько миллисекунд управляющая последовательность не будет интерпретирована и останется во входном потоке как есть.

window.timeout(delay)¶

Устанавливает блокирующее или неблокирующее чтение для окна. Если delay отрицательный, используется блокирующее чтение (ожидание ввода неопределённо долго). Если delay равен нулю, используется неблокирующее чтение, и getch() вернёт -1, если ввода нет. Если delay положительный, то getch() будет ждать delay миллисекунд и вернёт -1, если по истечении этого времени ввода всё ещё нет.

Наложение и касание¶Overlapping and touch

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.touchline(start, count[, changed])¶

Считает, что count строк были изменены, начиная со строки start. Если указан changed, он определяет, помечаются ли затронутые строки как изменённые (changed=True) или неизменённые (changed=False).

window.touchwin()¶

Считает, что всё окно было изменено, в целях оптимизации отрисовки.

window.untouchwin()¶

Помечает все строки в окне как неизменённые с момента последнего вызова refresh().

window.syncup()¶

Помечает все позиции в родительских окнах данного окна, которые были изменены в окне.

window.syncdown()¶

Помечает каждую позицию в окне, которая была изменена в любом из его родительских окон. Эта процедура вызывается refresh(), поэтому почти никогда не требуется вызывать её вручную.

window.cursyncup()¶

Обновляет текущую позицию курсора всех родительских окон, чтобы она отражала текущую позицию курсора данного окна.

Преобразование координат¶Coordinate conversion

window.enclose(y, x)¶

Проверяет, находятся ли указанные координаты символьных ячеек относительно экрана внутри данного окна, возвращая True или False. Полезно для определения того, какое подмножество окон экрана содержит положение события мыши.

Изменено в версии 3.10: Ранее возвращалось 1 или 0 вместо True или False.

window.mouse_trafo(y, x, to_screen)¶

Преобразует координаты символьных ячеек между оконными и экранными (относительно stdscr). Если to_screen равно true, преобразует оконные координаты y, x в экранные; в противном случае преобразует в обратном направлении. Две системы координат различаются, когда на экране зарезервированы строки, например, для программных меток.

Возвращает преобразованные координаты в виде кортежа (y, x) или None, если они находятся за пределами окна.

Добавлено в версии 3.16.0a0 (не выпущена).

Прочее¶Other

window.encoding¶

Кодировка, используемая для кодирования аргументов методов (строки и символы Unicode). Атрибут encoding наследуется от родительского окна при создании дочернего окна, например с помощью window.subwin(). По умолчанию используется кодировка текущей локали (см. locale.getencoding()).

Добавлено в версии 3.3.

window.putwin(file)¶

Записать все данные, связанные с окном, в переданный файловый объект. Эту информацию можно будет позже получить с помощью функции getwin().

window.use(func, /, *args, **kwargs)¶

Вызывает func(window, *args, **kwargs), удерживая блокировку окна, и возвращает результат. Это обеспечивает автоматическую защиту окна от одновременного доступа из другого потока.

Доступность: если базовая библиотека curses предоставляет use_window().

Добавлено в версии 3.16.0a0 (не выпущена).

Запросы состояния¶State queries

window.is_cleared()¶

Возвращает текущее значение, установленное clearok().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_idcok()¶

Возвращает текущее значение, установленное idcok().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_idlok()¶

Возвращает текущее значение, установленное idlok().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_immedok()¶

Возвращает текущее значение, установленное immedok().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_keypad()¶

Возвращает текущее значение, установленное keypad().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_leaveok()¶

Возвращает текущее значение, установленное leaveok().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_linetouched(line)¶

Возвращает True, если указанная строка была изменена после последнего вызова refresh(); в противном случае возвращает False. Вызывает исключение curses.error, если line недопустима для данного окна.

window.is_nodelay()¶

Возвращает текущее значение, установленное nodelay().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_notimeout()¶

Возвращает текущее значение, установленное notimeout().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_pad()¶

Возвращает True, если окно является pad, созданным с помощью newpad().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_scrollok()¶

Возвращает текущее значение, установленное scrollok().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_subwin()¶

Возвращает True, если окно является подокном, созданным с помощью subwin() или derwin().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_syncok()¶

Возвращает текущее значение, установленное syncok().

Добавлено в версии 3.16.0a0 (не выпущена).

window.is_wintouched()¶

Возвращает True, если указанное окно было изменено после последнего вызова refresh(); в противном случае возвращает False.

Общие¶General

Модуль curses определяет следующие элементы данных:

curses.ERR¶

Некоторые процедуры curses, возвращающие целое число, такие как getch(), возвращают ERR в случае ошибки.

curses.OK¶

Некоторые процедуры curses, возвращающие целое число, такие как napms(), возвращают OK в случае успеха.

curses.version¶

Объект bytes, представляющий текущую версию модуля.

curses.ncurses_version¶

Именованный кортеж, содержащий три компонента версии библиотеки ncurses: major, minor и patch. Все значения – целые числа. К компонентам также можно обращаться по имени, так что curses.ncurses_version[0] эквивалентно curses.ncurses_version.major и так далее.

Доступность: если используется библиотека ncurses.

Добавлено в версии 3.8.

curses.COLORS¶

Максимальное количество цветов, которое поддерживает терминал. Определяется только после вызова start_color().

curses.COLOR_PAIRS¶

Максимальное количество цветовых пар, которое поддерживает терминал. Определяется только после вызова start_color().

curses.COLS¶

Ширина экрана, то есть количество столбцов. Определяется только после вызова initscr(). Обновляется с помощью update_lines_cols(), resizeterm() и resize_term().

curses.LINES¶

Высота экрана, то есть количество строк. Определяется только после вызова initscr(). Обновляется с помощью update_lines_cols(), resizeterm() и resize_term().

Атрибуты¶Attributes

Некоторые константы доступны для указания атрибутов ячеек символов. Точный набор доступных констант зависит от системы.

Методы attr_get(), attr_set(), attr_on() и attr_off() используют параллельный набор констант WA_*. Они имеют тот же смысл, что и соответствующие атрибуты A_* выше (WA_BOLD, такие как A_BOLD, и так далее), но относятся к типу attr_t, а не упаковываются в символ. В ncurses оба набора имеют одинаковые значения, но другие реализации curses могут присваивать им разные, поэтому используйте константы WA_* с методами attr_*. Доступные имена: WA_ATTRIBUTES, WA_NORMAL, WA_STANDOUT, WA_UNDERLINE, WA_REVERSE, WA_BLINK, WA_DIM, WA_BOLD, WA_ALTCHARSET, WA_INVIS, WA_PROTECT, WA_HORIZONTAL, WA_LEFT, WA_LOW, WA_RIGHT, WA_TOP, WA_VERTICAL и WA_ITALIC (каждая доступна только там, где это определено платформой).

Доступно несколько констант для извлечения соответствующих атрибутов, возвращаемых некоторыми методами.

Клавиши¶Keys

Клавиши обозначаются целочисленными константами с именами, начинающимися с KEY_. Точный набор доступных клавиш зависит от системы.

На VT100 и их программных эмуляциях, таких как эмуляторы терминалов X, обычно доступны как минимум четыре функциональные клавиши (KEY_F1, KEY_F2, KEY_F3, KEY_F4), а стрелки отображаются на KEY_UP, KEY_DOWN, KEY_LEFT и KEY_RIGHT очевидным образом. Если на вашей машине клавиатура PC, можно рассчитывать на стрелки и двенадцать функциональных клавиш (на старых клавиатурах PC может быть только десять); кроме того, стандартны следующие отображения цифровой клавиатуры:

Альтернативный набор символов¶Alternate character set

В следующей таблице перечислены символы из альтернативного набора символов. Они унаследованы от терминала VT100 и обычно доступны в программных эмуляциях, таких как X терминалы. Если графический символ недоступен, curses использует грубое приближение в виде печатных символов ASCII.