Programação em Curses com Python
********************************

Autor:
   A.M. Kuchling, Eric S. Raymond

Versão:
   2.04


Resumo
^^^^^^

Este documento descreve como usar o módulo de extensão "curses" para
controlar visualizações em modo texto.


O que é curses?
===============

A biblioteca curses fornece formas que facilitam a impressão no
terminal e o tratamento de entrada via teclado para interfaces de
terminal baseadas em texto, tais como VT100s, o console Linux, e
emulatores de terminais fornecidos por vários programas. Terminais
visuais suportam vários códigos de controle para executar várias
operações comuns como mover o cursor, apagar áreas e rolagem de tela.
Diferentes terminais usam uma gama de diferentes códigos, e
frequentemente têm suas próprias peculiaridades.

No mundo dos displays gráficos, uma pergunta pode vir à tona "por que
isso, jovem?". É verdade que os terminais de exibição de caracteres
são uma tecnologia obsoleta, mas há nichos nos quais a capacidade de
fazer coisas sofisticadas com eles continua sendo valorizada. Um nicho
são os Unixes de baixa pegada de recursos ou embarcados, que não rodam
um servidor X, ou seja, não possuem interface gráfica. Outro nicho é o
de ferramentas como instaladores de sistemas operacionais e
configurações de kernels que podem precisar rodar antes que qualquer
suporte a interfaces gráficas esteja disponível.

A biblioteca curses fornece funcionalidade bastante básica,
proporcionando ao programador uma abstração de um monitor contendo
janelas de texto não sobrepostas. Os conteúdos de uma janela podem ser
modificados de diversas formas --- adicionando texto, apagando-o,
modificando sua aparência --- e a biblioteca curses irá descobrir
quais códigos de controle precisam ser enviados ao terminal para
produzir a saída correta. A biblioteca curses não fornece muitos
conceitos de interface de usuário como botões, caixas de seleção ou
diálogos; se você necessitar dessas funcionalidades, considere uma
biblioteca de interface de usuário como Urwid.

A biblioteca curses foi originalmente escrita para o BSD Unix; as
versões mais recentes do System V do Unix da AT&T adicionaram muitos
aprimoramentos e novas funções. A BSD curses não é mais mantida, tendo
sido substituída pela ncursess, que é uma implementação de código
aberto da interface da AT&T. Se você estiver usando um sistema
operacional de código aberto baseado em Unix, tal como Linux ou
FreeBSD, seu sistema provavelmente usa ncurses. Uma vez que a maioria
das versões comerciais do Unix são baseadas no código do System V,
todas as funções descritas aqui provavelmente estarão disponíveis. No
entanto, as versões antigas de curses carregadas por alguns Unixes
proprietários podem não prover tudo.

The Windows version of Python doesn't include the "curses" module.  A
ported version called UniCurses is available.


O módulo curses de Python
-------------------------

O módulo Python é um pacote bastante simples sobre as funções em C
fornecidas pela curses; se você já está familiarizado com a
programação de curses em C, é muito fácil de transferir esse
conhecimento para Python. A maior diferença é que a interface Python
torna as coisas mais simples por mesclar diferentes funções em C como
"addstr()", "mvaddstr()", e "mvwaddstr()" num único método "addstr()".
Você verá isso em mais detalhes posteriormente.

Este documento é uma introdução à escrita de programas em modo texto
com curses e Python. Isto não pretende ser um guia completo da API
curses; para isso, veja a seção ncurses no guia da biblioteca Python,
e o manual de ncurses. Isto, no entanto, lhe dará uma ideia básica.


Começando e terminando uma aplicação curses
===========================================

Antes de qualquer coisa, curses precisa ser inicializada. Isto é feito
chamando a função "initscr()", a qual irá determinar o tipo de
terminal, enviar quaisquer códigos de configuração necessários para o
terminal e criar várias estruturas de dados internas. Se for bem
sucedida, "initscr()" retorna um objeto janela representando a tela
inteira; isso é geralmente chamado "stdscr" depois do nome da variável
C correspondente.

   import curses
   stdscr = curses.initscr()

Geralmente aplicações curses desativam o envio automático de teclas
para a tela, para que seja possível ler teclas e exibí-las somente sob
certas circunstâncias. Isto requer a chamada da função "noecho()".

   curses.noecho()

Aplicações também irão comumente precisar reagir a teclas
instantaneamente, sem requisitar que a tecla Enter seja pressionada;
isto é chamado de modo cbreak, ao contrário do modo de entrada
buferizada usual.

   curses.cbreak()

Terminais geralmente retornam teclas especiais, como as teclas de
cursor ou de navegação como Page Up e Home, como uma sequência de
escape mutibyte. Enquanto você poderia escrever sua aplicação para
esperar essas sequências e processá-las de acordo, curses pode fazer
isto para você, retornando um valor especial como "curses.KEY_LEFT".
Para permitir que curses faça esse trabalho, você precisará habilitar
o modo keypad.

   stdscr.keypad(True)

Finalizar uma aplicação curses é mais fácil do que iniciar uma. Você
precisará executar:

   curses.nocbreak()
   stdscr.keypad(False)
   curses.echo()

para reverter as configurações de terminal usadas pela bilioteca
curses. Então, chame a função "endwin()" para restaurar o terminal
para seu modo de operação original.

   curses.endwin()

Um problema comum ao depurar uma aplicação curses é deixar seu
terminal bagunçado quando a aplicação para sem restaurar o terminal ao
seu estado anterior. Em Python isto comumente acontece quando seu
código está com problemas e levanta uma exceção não capturada. As
teclas não são mais enviadas para a tela quando você as digita, por
exemplo, o que torna difícil utilizar o shell.

No Python você pode evitar essas complicações e fazer depurações de
forma mais simples importando a função "curses.wrapper()" e
utilizando-a desta forma:

   from curses import wrapper

   def main(stdscr):
       # Clear screen
       stdscr.clear()

       # This raises ZeroDivisionError when i == 10.
       for i in range(0, 11):
           v = i-10
           stdscr.addstr(i, 0, '10 divided by {} is {}'.format(v, 10/v))

       stdscr.refresh()
       stdscr.getkey()

   wrapper(main)

A função "wrapper()" pega um objeto chamável e faz as inicializações
descritas acima, também inicializando cores se o suporte a cores
estiver presente. "wrapper()" então executa seu objeto chamável
fornecido. Uma vez que ele retorna, "wrapper()" irá restaurar o estado
original do terminal. O objeto chamável é chamado dentro de uma
"try"..."except" que captura exceções, restaura o estado do terminal,
e então re-eleva o estado do terminal, e então re-eleva a exceção.
Portanto, seu terminal não será deixado num estado engraçado numa
exceção e você poderá ler as mensagens e rastreamentos da exceção.


Janelas e Pads
==============

Janelas são a abstração mais básica em curses. Uma objeto janela
representa uma área retangular da tela, e provê métodos para exibir
texto, apagá-lo, e permitir ao usuário inserir strings, e assim por
diante.

O objeto "stdscr" retornado pela função "initscr()" é um objeto janela
que cobre a tela inteira. Muitos programas podem precisar apenas desta
janela única, mas você poderia desejar dividir a tela em janelas
menores, a fim de redefini-las ou limpá-las separadamente. A função
"newwin()" cria uma nova janela de um dado tamanho, retornando o novo
objeto janela.

   begin_x = 20; begin_y = 7
   height = 5; width = 40
   win = curses.newwin(height, width, begin_y, begin_x)

Note que o sistema de coordenadas utilizado na curses é incomum.
Coordenadas geralmente são passadas na ordem *y,x*, e o canto
superior-esquerdo da janela é a coordenada (0,0). Isto quebra a
convenção normal para tratar coordenadas onde a coordenada *x* vem
primeiro. Isto é uma diferença infeliz da maioria das aplicações
computacionais, mas tem sido parte da curses desde que ela foi
inicialmente escrita, e agora é tarde demais para mudar isso.

Sua aplicação pode determinar o tamanho da tela usando as variáveis
"curses.LINES" e "curses.COLS" para obter os tamanhos *y* e *x*.
Coordenadas válidas vão variar de "(0,0)" até "(curses.LINES - 1,
curses.COLS - 1)".

Quando você chamar um método para exibir ou apagar texto, o efeito não
é exibido imediatamente na tela. Em vez disso você deve chamar o
método "refresh()" dos objetos janela para atualizar a tela.

Isto é porque curses foi escrita originalmente com conexões de
terminal lentas de 300-baud em mente; com esses terminais, minimizar o
tempo necessário para redesenhar a tela era muito importante. Em vez
disso curses acumula mudanças para a tela e as exibe da maneira mais
eficiente quando você chamar "refresh()". Por exemplo, se seu programa
exibir algum texto numa janela e então limpar a janela, não há a
necessidade de enviar o texto original porque eles nunca estão
visíveis.

Na prática, dizer a curses explicitamente para redefinir uma janela
não complica muito a programação com curses. A maioria dos programas
entra em uma onda de atividade, e então pausa aguardando por uma tecla
pressionada ou alguma outra ação da parte do usuário. Tudo o que você
tem de fazer é ter certeza de que a tela foi redefinida antes da pausa
para aguardar a entrada do usuário, ao chamar primeiro
"stdscr.refresh()" ou o método "refresh()" de alguma outra janela
relevante.

Um pad é um caso especial de janela; ele pode ser mais largo que a
tela atual, e apenas uma porção do pad exibido por vez. Criar um pad
requer sua altura e largura, enquanto atualizar o pad requer dar as
coordenadas da área na tela onde uma subseção do pad será exibida.

   pad = curses.newpad(100, 100)
   # These loops fill the pad with letters; addch() is
   # explained in the next section
   for y in range(0, 99):
       for x in range(0, 99):
           pad.addch(y,x, ord('a') + (x*x+y*y) % 26)

   # Displays a section of the pad in the middle of the screen.
   # (0,0) : coordinate of upper-left corner of pad area to display.
   # (5,5) : coordinate of upper-left corner of window area to be filled
   #         with pad content.
   # (20, 75) : coordinate of lower-right corner of window area to be
   #          : filled with pad content.
   pad.refresh( 0,0, 5,5, 20,75)

A chamada "refresh()" exibe uma seção do bloco no retângulo estendendo
da coordenada (5,5) para a coordenada (20,75) na tela; o canto
superior esquerdo da seção exibida é a coordenada (0,0) no bloco. Além
dessa diferença, blocos são exatamente como janelas comuns e suportam
os mesmos métodos.

Se você tiver muitas janelas e blocos na tela há um modo mais
eficiente de atualizar a tela e prevenir piscadas irritantes como se
parte da tela fosse atualizada. "refresh()" na realidade faz duas
coisas:

1. Chama o método "noutrefresh()" de cada janela para atualizar uma
   estrutura de dados subjacente representando o estado desejado da
   tela.

2. Chama a função "doupdate()" para modificar a tela física para
   corresponder com o estado desejado presente na estrutura de dados.

Em vez disso você pode chamar "noutrefresh()" sobre um número de
janelas para atualizar a estrutura de dados, e então chamar
"doupdate()" para atualizar a tela.


Exibindo texto
==============

Do ponto de vista de um programador C, curses à vezes pode parecer
como um labirinto sinuoso de funções, todas ligeiramente diferentes.
Por exemplo, "addstr()" exibe uma string na localização atual do
cursor na janela "stdscr", enquanto "mvaddstr()" move para uma dada
coordenada y,x primeiro antes de exibir a string. "waddstr()" é como
"addstr()", mas permite especificar uma janela para utilizar em vez de
usar "stdscr" por padrão. "mvwaddstr()" permite especificar tanto uma
janela quanto uma coordenada.

Felizmente, a interface do Python oculta todos estes detalhes.
"stdscr" é um objeto de janela como qualquer outro, e métodos como
"addstr()" aceitam múltiplas formas de argumentos.

+-----------------------------------+-------------------------------------------------+
| Forma                             | Descrição                                       |
|===================================|=================================================|
| *str* ou *ch*                     | Mostra a string *str* ou caractere *ch* na      |
|                                   | posição atual.                                  |
+-----------------------------------+-------------------------------------------------+
| *str* ou *ch*, *attr*             | Mostra a string *str* ou caractere *ch*, usando |
|                                   | o atributo *attr* na posição atual.             |
+-----------------------------------+-------------------------------------------------+
| *y*, *x*, *str* ou *ch*           | Move para a posição *y,x* dentro da janela, e   |
|                                   | exibe *str* ou *ch*                             |
+-----------------------------------+-------------------------------------------------+
| *y*, *x*, *str* ou *ch*, *attr*   | Mover para a posição *y,x* dentro da janela, e  |
|                                   | exibir *str* ou *ch*, usando o atributo *attr*  |
+-----------------------------------+-------------------------------------------------+

Atributos permitem exibir texto de formas destacadas como negrito,
sublinhado, código invertido, ou colorido. Elas serão explicadas em
mais detalhes na próxima subseção.

O método "addstr()" recebe uma string ou bytestring Python como valor
a ser exibido. os conteúdos de bytestrings são enviados ao terminal
tal como estão. Strings são codificadas em bytes usando o valor do
atributo "encoding" da janela; esta predefinição corresponde à
codificação padrão do sistema como retornado por
"locale.getpreferredencoding()".

Os métodos "addch()" pegam um caractere, que pode ser tanto uma string
de comprimento 1, um bytestring de comprimento 1, ou um inteiro.

Constantes são providas para caracteres de extensão; estas constantes
são inteiros maiores que 255. Por exemplo, "ACS_PLMINUS" é um símbolo
de +/-, e "ACS_ULCORNER" é o canto superior esquerdo de uma caixa
(útil para desenhar bordas). Você pode usar o caractere Unicode
apropriado.

Janelas lembram onde o cursor estava após a última operação, então se
você omitir as coordenadas *y,x*, a string ou caractere serão exibidos
onde quer que a última operação foi deixada. Você também pode mover o
cursos com o método "move(y,x)". Porque alguns terminais sempre exibem
um cursos piscando, você pode querer garantir que o cursor está
posicionado em algum local onde ele não será uma distração; pode ser
confuso ter o cursor piscando em um local aparentemente aleatório.

Se sua aplicação não necessita de forma alguma de um cursor piscando,
você pode chamar "curs_set(False)" para torná-lo invisível. Para
compatibilidade com versões anteriores de curses, há a função
"leaveok(bool)" que é um sinônimo para "curs_set()". Quando *bool* é
verdadeiro, a biblioteca curses tentará suprimir o cursor piscando, e
você não precisará se preocupar ao deixá-lo em localizações incomuns.


Atributos e Cor
---------------

Caracteres podem ser exibidos de diferentes formas. Linhas de status
em aplicações baseadas em texto são tradicionalmente exibidas em vídeo
reverso, ou um visualizador de texto pode precisar destacar certas
palavras. Para isso, a curses permite que você especifique um atributo
para cada célula na tela.

Um atributo é um inteiro em que cada bit representa um atributo
diferente. Você sempre pode tentar exibir texto com múltiplos bits de
atributo ligados ao mesmo tempo, mas a curses não garante que todas as
combinações possíveis estarão disponíveis, ou que elas são todas
visualmente distintas. Isso depende da abilidade do terminal sendo
usado, de forma que é mais seguro se ater aos atributos mais comumente
disponíveis, listados aqui.

+------------------------+----------------------------------------+
| Atributo               | Descrição                              |
|========================|========================================|
| "A_BLINK"              | Texto piscante                         |
+------------------------+----------------------------------------+
| "A_BOLD"               | Texto em negrito ou brilho extra       |
+------------------------+----------------------------------------+
| "A_DIM"                | Texto em brilho médio                  |
+------------------------+----------------------------------------+
| "A_REVERSE"            | Texto em vídeo reverso                 |
+------------------------+----------------------------------------+
| "A_STANDOUT"           | O modo mais destacado disponível       |
+------------------------+----------------------------------------+
| "A_UNDERLINE"          | Texto sublinhado                       |
+------------------------+----------------------------------------+

Assim, pra exibir uma linha de status em vídeo reverso na linha no
topo da tela, você poderia escrever:

   stdscr.addstr(0, 0, "Current mode: Typing mode",
                 curses.A_REVERSE)
   stdscr.refresh()

A biblioteca curses também permite o uso de cores nos terminais que as
provêem. Destes, o terminal mais comum é provavelmente o console
Linux, seguido pelos xterms com cores.

Para usar cores, você deve chamar a função "start_color()" logo depois
de chamar "initscr()", para inicializar a paleta de cores padrão (a
função "curses.wrapper()" faz isso automaticamente.) Uma vez feito
isso, a função "has_colors()" retorna True se o terminal em uso de
fato suportar cores. (Nota: a curses usa a grafia Americana 'color' ao
invés da grafia Britânica/Canadense 'colour.' Se você estiver
acostumado com a grafia Britânica, você terá que se resignar a
escrever com a grafia trocada ao chamar essas funções.)

A biblioteca curses mantém uma quantidade finita de pares de cores,
contendo uma cor de primeiro plano (ou de texto) e uma de fundo. Você
pode obter o valor do atributo correspondente a um par de cores com a
função "color_pair()"; esse valor pode ser combinado com OU (OR) bit a
bit com outros atributos como "A_REVERSE", mas, novamente, não é
garantido que tais combinações vão funcionar em todos os terminais.

Um exemplo, exibindo uma linha de texto com o par de cores 1:

   stdscr.addstr("Pretty text", curses.color_pair(1))
   stdscr.refresh()

Como dito anteriormente, um par de cores consiste de uma cor de
primeiro plano e uma cor de fundo. A função "init_pair(n, f, b)" muda
a definição do par de cores *n* para a cor de primeiro plano *f* e cor
de fundo *b*. O par 0 é pré-definido como branco sobre preto, e não
pode ser mudado.

As cores são numeradas, e a "start_color()" inicializa 8 cores básicas
ao ativar o modo colorido. São elas: 0:preto, 1:vermelho, 2:verde,
3:amarelo, 4:azul, 5:magenta, 6:ciano e 7:branco. O módulo "curses"
define constantes nomeadas para cada uma dessas cores:
"curses.COLOR_BLACK", "curses.COLOR_RED", e assim por diante.

Vamos juntar tudo isso. Para redefinir a cor 1 como texto vermelho
sobre fundo branco, você chamaria:

   curses.init_pair(1, curses.COLOR_RED, curses.COLOR_WHITE)

Quando você redefine um par de cores, qualquer texto que já tenha sido
exibido usando esse par de cores vai mudar para a nova definição. Você
pode também exibir mais texto nessa nova cor com:

   stdscr.addstr(0,0, "RED ALERT!", curses.color_pair(1))

Terminais super sofisticados podem trocar as definições das cores em
si para um dado valor RGB. Isso permite que você troque a cor 1, que
geralmente é vermelha, para roxo ou azul ou qualquer outra cor que
você queira. Infelizmente, o terminal Linux não provê essa
funcionalidade, de forma que eu não consigo testá-la para fornecer
exemplos. Você pode verificar se o seu terminal tem esse recurso
chamando a função "can_change_color()", que retorna "True" se o
recurso existir. Se por ventura o seu terminal for talentoso assim,
consulte as páginas man do seu sistema para mais informações.


Entrada de usuário
==================

The C curses library offers only very simple input mechanisms.
Python's "curses" module adds a basic text-input widget.  (Other
libraries such as Urwid have more extensive collections of widgets.)

Há dois métodos para capturar entrada de uma janela:

* O "getch()" atualiza a tela e então espera o usuário apertar alguma
  tecla, exibindo o valor dela caso "echo()" tenha sido chamada
  anteriormente. Opcionalmente, você pode especificar a coordenada
  onde o cursor deve ser posicionado antes de pausar.

* O "getkey()" faz a mesma coisa, mas converte o inteiro para string.
  Caracteres individuais são retorndos como strings de 1 caractere, e
  teclas especiais como teclas funcionais retornam strings maiores
  contendo nomes de teclas como "KEY_UP" ou "^G".

It's possible to not wait for the user using the "nodelay()" window
method. After "nodelay(True)", "getch()" and "getkey()" for the window
become non-blocking. To signal that no input is ready, "getch()"
returns "curses.ERR" (a value of -1) and "getkey()" raises an
exception. There's also a "halfdelay()" function, which can be used to
(in effect) set a timer on each "getch()"; if no input becomes
available within a specified delay (measured in tenths of a second),
curses raises an exception.

The "getch()" method returns an integer; if it's between 0 and 255, it
represents the ASCII code of the key pressed.  Values greater than 255
are special keys such as Page Up, Home, or the cursor keys. You can
compare the value returned to constants such as "curses.KEY_PPAGE",
"curses.KEY_HOME", or "curses.KEY_LEFT".  The main loop of your
program may look something like this:

   while True:
       c = stdscr.getch()
       if c == ord('p'):
           PrintDocument()
       elif c == ord('q'):
           break  # Exit the while loop
       elif c == curses.KEY_HOME:
           x = y = 0

O módulo "curses.ascii" fornece funçõe de teste de pertencimento que
levam como argumento tanto inteiros quanto strings de 1 caractere;
elas podem ser úteis para escrever testes mais legíveis para tais
laços. Ele também fornece funções de conversão que levam como
argumento tanto inteiros quanto strings de 1 caractere, e retornam
objetos do mesmo tipo. Por exemplo, "curses.ascii.ctrl()" retorna o
caractere de controle correspondente ao argumento.

Também há um método para pegar uma string inteira, "getstr()". Ele não
costuma ser usado porque a sua funcionalidade é um pouco limitada: as
únicas teclas de edição disponíveis são o Backspace e o Enter, que
termina a string. Ele pode opcionalmente limitado a um número fixo de
caracteres.

   curses.echo()            # Enable echoing of characters

   # Get a 15-character string, with the cursor on the top line
   s = stdscr.getstr(0,0, 15)

O módulo "curses.textpad" fornece uma caixa de texto que provê um
conjunto de atalhos de teclado estilo Emacs. Vários métodos da classe
"Textbox" provêem dição com validação de entrada e recuperação dos
resultados da edição com ou sem espaços em branco no final.

   import curses
   from curses.textpad import Textbox, rectangle

   def main(stdscr):
       stdscr.addstr(0, 0, "Enter IM message: (hit Ctrl-G to send)")

       editwin = curses.newwin(5,30, 2,1)
       rectangle(stdscr, 1,0, 1+5+1, 1+30+1)
       stdscr.refresh()

       box = Textbox(editwin)

       # Let the user edit until Ctrl-G is struck.
       box.edit()

       # Get resulting contents
       message = box.gather()

Consulte a documentação de biblioteca do "curses.textpad" para mais
detalhes.


Para mais informações
=====================

Este COMOFAZER não cobre alguns tópicos avançados, como ler o conteúdo
da tela ou capturar eventos de mouse de uma instância xterm, mas a
página de biblioteca Python para o módulo "curses" está agora
razoavelmente completa. Ela deve ser o seu próximo destino.

If you're in doubt about the detailed behavior of the curses
functions, consult the manual pages for your curses implementation,
whether it's ncurses or a proprietary Unix vendor's.  The manual pages
will document any quirks, and provide complete lists of all the
functions, attributes, and "ACS_*" characters available to you.

Devido à API da curses ser tão grande, algumas funções não são
providas pela interface Python. Muitas vezes isso não é por
dificuldade de implementação, e sim porque ninguém precisou delas
ainda. Além disso, o Python ainda não suporta a biblioteca de menus
associada à ncurses. Patches que adicionem suporte a essas
funcionalidades seriam bem-vindos; veja o Guia do Desenvolvedor do
Python para aprender melhor sobre como submeter patches ao Python.

* Writing Programs with NCURSES: a lengthy tutorial for C programmers.

* Página man do ncurses

* The ncurses FAQ

* "Use curses... don't swear": vídeo de uma palestra na PyCon 2013
  sobre controle de terminais usando curses ou Urwid.

* "Console Applications with Urwid": video of a PyCon CA 2012 talk
  demonstrating some applications written using Urwid.
