Skip to main content

用于从标准输入读取单个字符、按键(带有转义序列)或行的 Python 库。

项目描述

读键

pypi版本 支持的 Python 版本 执照

用于从标准输入读取单个字符、按键(带有转义序列)或行的 Python 库。

最初是magmax/python-readchar的一个分支,它被重写以修复一些错误并更好地支持 UNIX 和 Windows 系统。

用法

import readkeys

ch = readkeys.getch()  # get a single character
key = readkeys.getkey()  # get a single keypress
line = readkeys.getline()  # get a line of text
line2 = readkeys.getline(raw=False)  # Get a line of text and print out characters as they are typed, similar to built-in input.
flush = readkeys.flush()  # flush stdin

功能

getch

getch函数从标准输入读取单个字符字节。读取后不刷新缓冲区。

该函数具有以下类型签名: getch(NONBLOCK: bool = False, encoding: str = None, raw: bool = True) -> str

  • NONBLOCK: bool从标准输入读取时使用非阻塞模式,默认为 False。如果设置为 ,库可能会遇到无法预料的错误True
  • encoding: str指定用于解码标准输入缓冲区中的字节的编码(例如 utf-8)。如果未指定,则假定字符可以直接从标准输入中提取。
  • raw: bool在阅读之前将 tty 终端置于原始模式,请参阅tty.setraw。如果设置为False字符,它们仍然会在终端中出现,因为它们被键入。读取操作完成后,将保存并恢复更改为原始模式之前的设置。
    该选项在 Windows 系统上被忽略,因为它们使用完全不同的终端环境,并且需要不同的库来从 stdin: 读取字符msvcrt

getkey

getkey函数从标准输入读取单个按键,包括功能键的转义序列。例如,箭头键会以其完整的转义序列返回,而不会在缓冲区中留下任何内容(、0x1b5b41或)。0x1b5b420x1b5b430x1b5b44

该函数具有以下类型签名: getch(getch_fn: Callable[[], str] = None, encoding: str = "", raw: bool = True) -> str

  • getch_fn: Callable[[], str]如果通过,请使用 this 函数而不是内置函数getch从 stdin 读取单个字节。如果使用此选项,库可能会遇到无法预料的错误。
  • encoding: str指定用于解码标准输入缓冲区中的字节的编码(例如 utf-8)。见getch
  • raw: bool在阅读之前将 tty 终端置于原始模式。见getch

getline

getline函数从标准输入读取一整行字符,包括非标准键(例如箭头键)。它默认为原始模式,在屏幕上留下未打印的字符。

该函数具有以下类型签名: (getch_fn: Optional[Callable[[], str]] = None, encoding: str = None, raw: bool = True) -> str

  • getch_fn: Callable[[], str]如果通过,请使用 this 函数而不是内置函数getch从 stdin 读取单个字节。如果使用此选项,库可能会遇到无法预料的错误。
  • encoding: str指定用于解码标准输入缓冲区中的字节的编码(例如 utf-8)。见getch
  • raw: bool在阅读之前将 tty 终端置于原始模式。见getch

flush

flush函数从标准输入中删除任何剩余字节并将它们作为字符串返回。在使用getch.

该函数具有以下类型签名: flush() -> str

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

readkeys-1.0.2.tar.gz (8.6 kB 查看哈希

已上传 source

内置分布

readkeys-1.0.2-py3-none-any.whl (9.3 kB 查看哈希

已上传 py3