selectors — 高级 I/O 多路复用

3.4 版本新增。

源代码: Lib/selectors.py


简介

此模块允许高级和高效的 I/O 多路复用,它构建于 select 模块的原语之上。除非用户想要精确控制所使用的操作系统级原语,否则建议使用此模块代替。

它定义了一个 BaseSelector 抽象基类,以及几个具体的实现(KqueueSelector, EpollSelector…),这些实现可用于等待多个文件对象上的 I/O 就绪通知。在以下内容中,“文件对象”是指任何具有 fileno() 方法的对象,或原始文件描述符。参见 文件对象

DefaultSelector 是当前平台上可用的最有效实现的别名:这应该是大多数用户的默认选择。

注意

支持的文件对象的类型取决于平台:在 Windows 上,支持套接字,但不支持管道,而在 Unix 上,两者都支持(也可能支持其他类型,如 FIFO 或特殊文件设备)。

参见

select

低级 I/O 多路复用模块。

可用性:非 WASI。

此模块在 WebAssembly 上不起作用或不可用。有关更多信息,请参阅 WebAssembly 平台

类层次结构

BaseSelector
+-- SelectSelector
+-- PollSelector
+-- EpollSelector
+-- DevpollSelector
+-- KqueueSelector

在以下内容中,events 是一个按位掩码,指示应在给定文件对象上等待哪些 I/O 事件。它可以是模块常量的组合,如下所示

常量

含义

selectors.EVENT_READ

可用于读取

selectors.EVENT_WRITE

可用于写入

class selectors.SelectorKey

SelectorKey 是一个 namedtuple,用于将文件对象与其底层文件描述符、选定的事件掩码和附加的数据相关联。它由几个 BaseSelector 方法返回。

fileobj

已注册的文件对象。

fd

底层文件描述符。

events

必须在此文件对象上等待的事件。

data

与此文件对象关联的可选不透明数据:例如,这可以用来存储每个客户端的会话 ID。

class selectors.BaseSelector

BaseSelector 用于等待多个文件对象上的 I/O 事件就绪。它支持文件流的注册、注销和一个在这些流上等待 I/O 事件的方法,并带有可选的超时。它是一个抽象基类,因此不能实例化。请改用 DefaultSelector,或者如果希望专门使用某个实现,并且你的平台支持,请使用 SelectSelectorKqueueSelector 等。BaseSelector 及其具体实现支持 上下文管理器 协议。

abstractmethod register(fileobj, events, data=None)

注册一个文件对象以进行选择,监视它的 I/O 事件。

fileobj 是要监视的文件对象。它可以是整数文件描述符,也可以是具有 fileno() 方法的对象。events 是要监视的事件的按位掩码。data 是一个不透明的对象。

这将返回一个新的 SelectorKey 实例,或者在事件掩码或文件描述符无效的情况下引发 ValueError,或者在文件对象已注册的情况下引发 KeyError

abstractmethod unregister(fileobj)

从选择中注销文件对象,将其从监视中删除。文件对象应在关闭之前注销。

fileobj 必须是之前注册的文件对象。

这将返回关联的 SelectorKey 实例,或者如果 fileobj 未注册,则引发 KeyError。如果 fileobj 无效(例如,它没有 fileno() 方法或其 fileno() 方法具有无效的返回值),它将引发 ValueError

modify(fileobj, events, data=None)

更改已注册文件对象的监视事件或附加数据。

这等效于 BaseSelector.unregister(fileobj),后跟 BaseSelector.register(fileobj, events, data),但可以更有效地实现。

这将返回一个新的 SelectorKey 实例,或者在事件掩码或文件描述符无效的情况下引发 ValueError,或者在文件对象未注册的情况下引发 KeyError

abstractmethod select(timeout=None)

等待直到一些已注册的文件对象准备就绪,或超时过期。

如果 timeout > 0,则指定最大等待时间,以秒为单位。如果 timeout <= 0,则调用不会阻塞,并将报告当前准备就绪的文件对象。如果 timeoutNone,则调用将阻塞,直到受监视的文件对象准备就绪。

这将返回一个 (key, events) 元组列表,每个准备就绪的文件对象一个。

key 是与就绪文件对象对应的 SelectorKey 实例。events 是该文件对象上就绪的事件的位掩码。

注意

如果当前进程收到信号,则此方法可以在任何文件对象就绪或超时时间过去之前返回:在这种情况下,将返回一个空列表。

在 3.5 版本中更改: 如果信号处理程序没有引发异常,则选择器现在会在被信号中断时使用重新计算的超时时间重试(有关基本原理,请参阅PEP 475),而不是在超时之前返回一个空事件列表。

close()

关闭选择器。

必须调用此方法以确保释放所有底层资源。选择器一旦关闭,就不得再使用。

get_key(fileobj)

返回与已注册文件对象关联的键。

这将返回与此文件对象关联的 SelectorKey 实例,如果该文件对象未注册,则引发 KeyError 异常。

abstractmethod get_map()

返回文件对象到选择器键的映射。

这将返回一个 Mapping 实例,该实例将已注册的文件对象映射到它们关联的 SelectorKey 实例。

class selectors.DefaultSelector

默认的选择器类,使用当前平台上可用的最有效实现。这应该是大多数用户的默认选择。

class selectors.SelectSelector

基于 select.select() 的选择器。

class selectors.PollSelector

基于 select.poll() 的选择器。

class selectors.EpollSelector

基于 select.epoll() 的选择器。

fileno()

这将返回底层 select.epoll() 对象使用的文件描述符。

class selectors.DevpollSelector

基于 select.devpoll() 的选择器。

fileno()

这将返回底层 select.devpoll() 对象使用的文件描述符。

在 3.5 版本中添加。

class selectors.KqueueSelector

基于 select.kqueue() 的选择器。

fileno()

这将返回底层 select.kqueue() 对象使用的文件描述符。

示例

这是一个简单的回声服务器实现

import selectors
import socket

sel = selectors.DefaultSelector()

def accept(sock, mask):
    conn, addr = sock.accept()  # Should be ready
    print('accepted', conn, 'from', addr)
    conn.setblocking(False)
    sel.register(conn, selectors.EVENT_READ, read)

def read(conn, mask):
    data = conn.recv(1000)  # Should be ready
    if data:
        print('echoing', repr(data), 'to', conn)
        conn.send(data)  # Hope it won't block
    else:
        print('closing', conn)
        sel.unregister(conn)
        conn.close()

sock = socket.socket()
sock.bind(('localhost', 1234))
sock.listen(100)
sock.setblocking(False)
sel.register(sock, selectors.EVENT_READ, accept)

while True:
    events = sel.select()
    for key, mask in events:
        callback = key.data
        callback(key.fileobj, mask)