msvcrt — 来自 MS VC++ 运行时的实用例程

---

这些函数提供了对 Windows 平台上一些实用功能的访问。一些更高级别的模块使用这些函数来构建其服务的 Windows 实现。例如，getpass 模块在其 getpass() 函数的实现中使用了此模块。

有关这些函数的更多文档，请参阅平台 API 文档。

该模块实现了控制台 I/O API 的普通字符和宽字符变体。普通 API 仅处理 ASCII 字符，对于国际化应用程序的用途有限。应尽可能使用宽字符 API。

在 3.3 版本中更改: 此模块中的操作现在引发 OSError，之前引发的是 IOError。

文件操作

msvcrt.locking(fd, mode, nbytes)

根据 C 运行时的文件描述符 fd 锁定文件的一部分。失败时引发 OSError。文件的锁定区域从当前文件位置开始延伸 nbytes 字节，并可能超出文件末尾。mode 必须是下面列出的 LK_* 常量之一。文件中可以同时锁定多个区域，但不能重叠。相邻区域不会合并；它们必须单独解锁。

使用参数 fd、mode、nbytes 引发 审计事件 msvcrt.locking。

msvcrt.LK_LOCK

msvcrt.LK_RLCK

锁定指定的字节。如果无法锁定字节，则程序会在 1 秒后立即重试。如果经过 10 次尝试仍无法锁定字节，则会引发 OSError。

msvcrt.LK_NBLCK

msvcrt.LK_NBRLCK

锁定指定的字节。如果无法锁定字节，则会引发 OSError。

msvcrt.LK_UNLCK

解锁指定的字节，这些字节必须先前已锁定。

msvcrt.setmode(fd, flags)

设置文件描述符 fd 的行尾转换模式。要将其设置为文本模式，flags 应为 os.O_TEXT；对于二进制模式，应为 os.O_BINARY。

msvcrt.open_osfhandle(handle, flags)

从文件句柄 handle 创建 C 运行时文件描述符。flags 参数应为 os.O_APPEND、os.O_RDONLY、os.O_TEXT 和 os.O_NOINHERIT 的按位 OR。返回的文件描述符可以用作 os.fdopen() 的参数以创建文件对象。

默认情况下，文件描述符是可继承的。传递 os.O_NOINHERIT 标志使其不可继承。

使用参数 handle、flags 引发 审计事件 msvcrt.open_osfhandle。

msvcrt.get_osfhandle(fd)

返回文件描述符 fd 的文件句柄。如果无法识别 fd，则引发 OSError。

使用参数 fd 引发 审计事件 msvcrt.get_osfhandle。

控制台 I/O

msvcrt.kbhit()

如果有一个按键等待读取，则返回非零值。否则，返回 0。

msvcrt.getch()

读取一个按键并返回结果字符作为字节字符串。控制台上不会回显任何内容。如果按键尚不可用，此调用将阻塞，但不会等待按下 Enter 键。如果按下的键是特殊功能键，则此函数将返回 '\000' 或 '\xe0'；下一个调用将返回键代码。无法使用此函数读取 Control-C 按键。

msvcrt.getwch()

getch() 的宽字符变体，返回 Unicode 值。

msvcrt.getche()

类似于 getch()，但如果按键代表一个可打印字符，则会回显该按键。

msvcrt.getwche()

getche() 的宽字符变体，返回一个 Unicode 值。

msvcrt.putch(char)

将字节字符串 char 打印到控制台，不进行缓冲。

msvcrt.putwch(unicode_char)

putch() 的宽字符变体，接受一个 Unicode 值。

msvcrt.ungetch(char)

使字节字符串 char “推回”到控制台缓冲区中；它将是 getch() 或 getche() 读取的下一个字符。

msvcrt.ungetwch(unicode_char)

ungetch() 的宽字符变体，接受一个 Unicode 值。

其他函数

msvcrt.heapmin()

强制 malloc() 堆清理自身并将未使用的块返回给操作系统。 如果失败，这将引发 OSError。

msvcrt.set_error_mode(mode)

更改 C 运行时为可能结束程序的错误写入错误消息的位置。 mode 必须是下面列出的 OUT_* 常量之一或 REPORT_ERRMODE。 如果发生错误，则返回旧设置或 -1。 仅在 Python 的调试版本 中可用。

msvcrt.OUT_TO_DEFAULT

错误接收器由应用程序的类型确定。 仅在 Python 的调试版本 中可用。

msvcrt.OUT_TO_STDERR

错误接收器是标准错误。 仅在 Python 的调试版本 中可用。

msvcrt.OUT_TO_MSGBOX

错误接收器是一个消息框。 仅在 Python 的调试版本 中可用。

msvcrt.REPORT_ERRMODE

报告当前的错误模式值。 仅在 Python 的调试版本 中可用。

msvcrt.CrtSetReportMode(type, mode)

指定 MS VC++ 运行时中 _CrtDbgReport() 生成的特定报告类型的目标位置。 type 必须是下面列出的 CRT_* 常量之一。 mode 必须是下面列出的 CRTDBG_* 常量之一。 仅在 Python 的调试版本 中可用。

msvcrt.CrtSetReportFile(type, file)

在使用 CrtSetReportMode() 指定 CRTDBG_MODE_FILE 后，您可以指定接收消息文本的文件句柄。 type 必须是下面列出的 CRT_* 常量之一。 file 应该是您想要指定的文件句柄。 仅在 Python 的调试版本 中可用。

msvcrt.CRT_WARN

不需要立即关注的警告、消息和信息。

msvcrt.CRT_ERROR

错误、无法恢复的问题以及需要立即关注的问题。

msvcrt.CRT_ASSERT

断言失败。

msvcrt.CRTDBG_MODE_DEBUG

将消息写入调试器的输出窗口。

msvcrt.CRTDBG_MODE_FILE

将消息写入用户提供的文件句柄。 应调用 CrtSetReportFile() 来定义要用作目标位置的特定文件或流。

msvcrt.CRTDBG_MODE_WNDW

创建一个消息框来显示消息以及 Abort、Retry 和 Ignore 按钮。

msvcrt.CRTDBG_REPORT_MODE

返回指定 type 的当前 mode。

msvcrt.CRT_ASSEMBLY_VERSION

来自 crtassem.h 头文件的 CRT 程序集版本。

msvcrt.VC_ASSEMBLY_PUBLICKEYTOKEN

来自 crtassem.h 头文件的 VC 程序集公钥令牌。

msvcrt.LIBRARIES_ASSEMBLY_NAME_PREFIX

来自 crtassem.h 头文件的库程序集名称前缀。