msvcrt — Rutinas útiles del entorno de ejecución MS VC++

Estas funciones dan acceso a ciertas capacidades útiles en plataformas Windows. Algunos módulos de más alto nivel usan estas funciones para crear las implementaciones en Windows de sus servicios. Por ejemplo, el módulo getpass usa esto en la implementación de la función getpass().

Más información sobre estas funciones se pueden encontrar en la documentación de la API de la plataforma.

El módulo implementa las variantes tanto de caracteres normales como amplios de la API E/S de la consola (se codifican en más de 8 bits, pudiendo llegar hasta 32). La API normal se ocupa solamente de caracteres ASCII y es de uso limitado a aplicaciones internacionales. La API para caracteres amplios se recomienda usar siempre que sea posible.

Distinto en la versión 3.3: Las operaciones en este módulo lanzan ahora OSError donde antes se lanzaba IOError.

Operaciones con archivos

msvcrt.locking(fd, mode, nbytes)

Bloquea parte de un archivo basado en el descriptor del archivo fd del entorno de ejecución C. Lanza una excepción OSError si falla. La región que ha sido bloqueada se extiende desde la posición del archivo actual hasta nbytes bytes y puede que continúe aún habiendo llegado al final del archivo. mode tiene que ser una de las constantes LK_* que están enumeradas más abajo. Se pueden bloquear varias regiones de un mismo archivo pero no se pueden superponer. Las regiones adyacentes no se combinan; tienen que ser desbloqueadas manualmente.

Lanza un evento de auditoría msvcrt.locking con los argumentos fd, mode, nbytes.

msvcrt.LK_LOCK
msvcrt.LK_RLCK

Bloquea los bytes especificados. Si no se pueden bloquear, el programa lo intenta de nuevo tras 1 segundo. Si, tras 10 intentos, no puede bloquear los bytes, se lanza una excepción OSError.

msvcrt.LK_NBLCK
msvcrt.LK_NBRLCK

Bloquea los bytes especificados. Si no se pueden bloquear, lanza una excepción OSError.

msvcrt.LK_UNLCK

Desbloquea los bytes especificados que han sido previamente bloqueados.

msvcrt.setmode(fd, flags)

Establece el modo traducción del final de línea del descriptor de un archivo fd. Si se establece como modo texto, flags debería ser os.O_TEXT; para establecerlo como modo binario, debería ser os.O_BINARY.

msvcrt.open_osfhandle(handle, flags)

Crea un descriptor de archivo en el entorno de ejecución de C desde el manejador de archivo handle. El parámetro flags debe ser un OR bit a bit de os.O_APPEND, os.O_RDONLY, y os.O_TEXT. El descriptor de archivo retornado se puede utilizar como parámetro para os.fdopen() para crear un objeto archivo.

Lanza un evento de auditoría msvcrt.open_osfhandle con los argumentos handle, flags.

msvcrt.get_osfhandle(fd)

Retorna el manejador de archivo para un descriptor de archivo fd. Lanza una excepción OSError si fd no se reconoce.

Lanza un evento de auditoría msvcrt.get_osfhandle con el argumento fd.

Consola E/S

msvcrt.kbhit()

Retorna True si hay una pulsación de tecla está esperando para ser leída.

msvcrt.getch()

Lee una pulsación de la tecla y retorna el carácter resultante como una cadena de caracteres de bytes. Nada se muestra en la consola. Esta llamada se bloqueará si una pulsación de la tecla aún no está disponible, pero no esperará a que se presione Enter. Si la tecla pulsada era una tecla de función especial, esto retornará '\000' o 'xe0'; la siguiente llamada retornará el código de la tecla pulsada. La pulsación de la tecla Control-C no se puede leer con esta función.

msvcrt.getwch()

Variante de carácter amplio de getch(), retornando un valor Unicode.

msvcrt.getche()

Similar a la función getch(), pero la pulsación de la tecla se imprime si representa un carácter imprimible.

msvcrt.getwche()

Variante de carácter amplio de getche(), retornando un valor Unicode.

msvcrt.putch(char)

Imprime la cadena de caracteres de bytes char a la consola sin almacenamiento en buffer.

msvcrt.putwch(unicode_char)

Variante de carácter amplio de putch(), admitiendo un valor Unicode.

msvcrt.ungetch(char)

Provoca que la cadena de caracteres de bytes char sea «colocada de nuevo» en el buffer de la consola, será el siguiente carácter que lea la función getch() o getche().

msvcrt.ungetwch(unicode_char)

Variante de carácter amplio de ungetch(), admitiendo un valor Unicode.

Otras funciones

msvcrt.heapmin()

Fuerza a la pila malloc() a que se limpie y retorne los bloques sin usar al sistema operativo. En el caso de que ocurriera algún fallo, se lanzaría una excepción OSError.