Funciones de apoyo

El módulo cli cuenta con una serie de funciones de apoyo que son llamadas por los métodos de las clases principales, pero también pueden usarse independientemente.

Los ejemplos que acompañan a cada función asumen que el módulo fue importado de la siguiente manera:

from cli import *

clear

Limpia la pantalla de texto.

clear()

cursoron | cursoroff

Enciende o apaga el cursor, respectivamente.

Cuando por algún motivo se requiera ocultar el cursor:

cursoroff()

Cuando se requiera mostrar nuevamente el cursor:

cursoron()

getkey

Detiene la ejecución del programa hasta que el usuario presione una tecla.

getkey()

Devuelve el caracter correspondiente a la tecla presionada.

tecla = getkey()

En el caso de que la tecla presionada sea una compleja, por ejemplo, una tecla de función (F1..F12) el caracter devuelto corresponderá al primer caracter de la cadena resultante. Sucesivas llamadas a getkey devolverán los demás caracteres.

out

Recibe una cadena, la envía a la salida estándar (stdout) y limpia el buffer.

out("Esto saldrá impreso en pantalla.")

Un detalle importante a tener en cuenta es que out, a diferencia de print, no imprime el caracter newline (\n, Enter) al final de la cadena:

out("Hola")
out("Mundo")

Dará como resultado:

HolaMundo

En cambio:

out("Hola\n")
out("Mundo")

Dará como resultado:

Hola
Mundo

La función out es ideal para ser usada en reemplazo de su equivalente print, ya que ésta ocasiona problemas de compatibilidad entre las versiones 2 y 3 de Python.

En Python 2, print es una sentencia, mientras que en Python 3 es una función. Al usar una función como out para todo lo relacionado a impresión, se logra (al menos en este apartado) la compatibilidad de código entre ambas versiones.

Otra ventaja de out frente a print es su mayor velocidad en la impresión de grandes cantidades de cadenas.

pedir

Interrumpe la ejecución del programa hasta que el usuario ingrese una cadena de caracteres.

nombre = pedir("¿Cuál es tu nombre?")

La función pedir es ideal para ser usada en reemplazo de su equivalente raw_input, ya que ésta ocasiona problemas de compatibilidad entre las versiones 2 y 3 de Python.

En Python 3 no existe la función raw_input, sólo input que en Python 2 se usa para ingresar valores numéricos. Al usar una función como pedir para todo lo relacionado al ingreso de datos por teclado, se logra (al menos en este apartado) la compatibilidad de código entre ambas versiones.