selectors — 高级 I/O 多路复用¶
在 3.4 版本加入。
源代码: Lib/selectors.py
引言¶
此模块基于 select 模块原语构建，允许进行高级且高效的 I/O 多路复用。除非用户希望对所使用的操作系统级原语进行精确控制，否则建议使用此模块。
它定义了一个抽象基类 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 事件。它可以是以下模块常量的组合
- class selectors.SelectorKey¶
SelectorKey是一个namedtuple，用于将文件对象与其底层文件描述符、选定的事件掩码和附加数据关联起来。它由几个BaseSelector方法返回。- fileobj¶
已注册的文件对象。
- fd¶
底层文件描述符。
- events¶
必须在此文件对象上等待的事件。
- data¶
与此文件对象关联的可选不透明数据：例如，这可以用于存储每个客户端的会话 ID。
- class selectors.BaseSelector¶
BaseSelector用于等待多个文件对象上的 I/O 事件就绪。它支持文件流注册、注销，以及等待这些流上的 I/O 事件的方法，并带有一个可选的超时。它是一个抽象基类，因此不能被实例化。请改用DefaultSelector，或者如果您想专门使用某个实现，并且您的平台支持它，则可以使用SelectSelector、KqueueSelector等。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，调用将不会阻塞，并将报告当前就绪的文件对象。如果 timeout 为None，调用将阻塞直到受监控的文件对象变为就绪。这会返回一个
(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()对象使用的文件描述符。
示例¶
这是一个简单的 echo 服务器实现
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)