termios — POSIX 风格 tty 控制


此模块提供了一个用于 tty I/O 控制的 POSIX 调用接口。有关这些调用的完整说明,请参阅 termios(3) Unix 手册页。它仅适用于在安装期间配置了 POSIX termios 风格 tty I/O 控制的 Unix 版本。

可用性: Unix。

此模块中的所有函数都将文件描述符 fd 作为其第一个参数。这可以是整数文件描述符,例如 sys.stdin.fileno() 返回的文件描述符,也可以是 文件对象,例如 sys.stdin 本身。

此模块还定义了使用此处提供的函数所需的所有常量;这些常量与 C 中的对应常量同名。有关使用这些终端控制接口的更多信息,请参阅系统文档。

该模块定义了以下函数

termios.tcgetattr(fd)

返回一个包含文件描述符 fd 的 tty 属性的列表,如下所示: [iflag, oflag, cflag, lflag, ispeed, ospeed, cc] 其中 cc 是 tty 特殊字符的列表(每个字符都是长度为 1 的字符串,但索引为 VMINVTIME 的项目除外,当定义这些字段时,它们是整数)。标志和速度的解释以及 cc 数组中的索引必须使用 termios 模块中定义的符号常量。

termios.tcsetattr(fd, when, attributes)

根据attributes(与 tcgetattr() 返回的列表类似)为文件描述符fd设置 tty 属性。when 参数决定何时更改属性

termios.TCSANOW

立即更改属性。

termios.TCSADRAIN

在传输所有排队输出后更改属性。

termios.TCSAFLUSH

在传输所有排队输出并丢弃所有排队输入后更改属性。

termios.tcsendbreak(fd, duration)

在文件描述符fd上发送中断。零duration发送 0.25-0.5 秒的中断;非零duration具有系统相关含义。

termios.tcdrain(fd)

等到写入文件描述符fd的所有输出均已传输。

termios.tcflush(fd, queue)

丢弃文件描述符fd上的排队数据。queue选择器指定哪个队列:TCIFLUSH表示输入队列,TCOFLUSH表示输出队列,TCIOFLUSH表示两个队列。

termios.tcflow(fd, action)

暂停或恢复文件描述符fd上的输入或输出。action参数可以是TCOOFF(暂停输出),TCOON(重新启动输出),TCIOFF(暂停输入)或TCION(重新启动输入)。

termios.tcgetwinsize(fd)

返回一个元组 (ws_row, ws_col),其中包含文件描述符 fd 的 tty 窗口大小。需要 termios.TIOCGWINSZtermios.TIOCGSIZE

在版本 3.11 中添加。

termios.tcsetwinsize(fd, winsize)

将文件描述符 fd 的 tty 窗口大小设置为 winsize,它是一个包含两项的元组 (ws_row, ws_col),类似于 tcgetwinsize() 返回的元组。至少需要定义其中一对 (termios.TIOCGWINSZ, termios.TIOCSWINSZ); (termios.TIOCGSIZE, termios.TIOCSSIZE)。

在版本 3.11 中添加。

另请参见

模块 tty

用于常见终端控制操作的便捷函数。

示例

下面是一个函数,它提示输入密码,同时关闭回显。请注意使用单独的 tcgetattr() 调用和 tryfinally 语句,以确保无论发生什么情况,旧的 tty 属性都能准确恢复

def getpass(prompt="Password: "):
    import termios, sys
    fd = sys.stdin.fileno()
    old = termios.tcgetattr(fd)
    new = termios.tcgetattr(fd)
    new[3] = new[3] & ~termios.ECHO          # lflags
    try:
        termios.tcsetattr(fd, termios.TCSADRAIN, new)
        passwd = input(prompt)
    finally:
        termios.tcsetattr(fd, termios.TCSADRAIN, old)
    return passwd