This document is for an old version of Python that is no longer supported. You should upgrade and read the Python 当前稳定版本的文档.

# 16.1. `select` — Waiting for I/O 完成

This module provides access to the `select()` and `poll()` functions available in most operating systems, `epoll()` available on Linux 2.5+ and `kqueue()` available on most BSD. Note that on Windows, it only works for sockets; on other operating systems, it also works for other file types (in particular, on Unix, it works on pipes). It cannot be used on regular files to determine whether a file has grown since it was last read.

该模块定义以下内容：

exception `select.``error`

  The exception raised when an error occurs. The accompanying value is a pair containing the numeric error code from `errno` and the corresponding string, as would be printed by the C function `perror()`.

`select.``epoll`([sizehint=-1])

  (Only supported on Linux 2.5.44 and newer.) Returns an edge polling object, which can be used as Edge or Level Triggered interface for I/O events; see section 边缘触发和水平触发的轮询 (epoll) 对象 below for the methods supported by epolling objects.

  2.6 新版功能.

`select.``poll`()

  （部分操作系统不支持）返回一个轮询对象，该对象支持注册和注销文件描述符，支持对描述符进行轮询以获取 I/O 事件。有关轮询对象支持的方法，请参阅下方 Poll 对象 部分。

`select.``kqueue`()

  （仅支持 BSD）返回一个内核队列对象，请参阅下方 Kqueue 对象 获取 kqueue 对象所支持的方法。

  2.6 新版功能.

`select.``kevent`(ident, filter=KQ_FILTER_READ, flags=KQ_EV_ADD, fflags=0, data=0, udata=0)

  （仅支持 BSD）返回一个内核事件对象，请参阅下方 Kevent 对象 获取 kevent 对象所支持的方法。

  2.6 新版功能.

`select.``select`(rlist, wlist, xlist[, timeout])

  这是 Unix `select()` 系统调用的直接接口。前三个参数是由“等待对象”组成的序列，“等待对象”可以是表示文件描述符的整数，也可以是定义了 `fileno()` 方法的对象（该方法没有参数，返回一个整数）：

  - rlist：等待，直到有内容可以读取

  - wlist：等待，直到可以开始写入

  - xlist：等待“异常情况”（请参阅当前系统的手册，以获取哪些情况称为异常情况）

  允许使用空序列，但是否接受三个空序列取决于平台。（目前已知在 Unix 上可以但 Windows 上不行。）可选的 timeout 参数指定超时时长，为浮点数，以秒为单位。如果省略了 timeout 参数，则该函数将阻塞，直到至少一个文件描述符准备就绪。超时值为零表示轮询且永不阻塞。

  返回值是三个列表，包含已就绪对象，返回的三个列表是前三个参数的子集。当超时时间已到且没有对象就绪时，返回三个空列表。

  Among the acceptable object types in the sequences are Python file objects (e.g. `sys.stdin`, or objects returned by `open()` or `os.popen()`), socket objects returned by `socket.socket()`. You may also define a wrapper class yourself, as long as it has an appropriate `fileno()` method (that really returns a file descriptor, not just a random integer).

  注解

  Windows 上不接受文件对象，但接受套接字。在 Windows 上，底层的 `select()` 函数由 WinSock 库提供，且不处理不是源自 WinSock 的文件描述符。

`select.``PIPE_BUF`

  Files reported as ready for writing by `select()`, `poll()` or similar interfaces in this module are guaranteed to not block on a write of up to `PIPE_BUF` bytes. This value is guaranteed by POSIX to be at least 512. Availability: Unix.

  2.7 新版功能.

## 16.1.1. 边缘触发和水平触发的轮询 (epoll) 对象

> http://linux.die.net/man/4/epoll

> 屏蔽事件

> 常数 | 含义
> --- | ---
> `EPOLLIN` | 可读
> `EPOLLOUT` | 可写
> `EPOLLPRI` | 紧急数据读取
> `EPOLLERR` | 在关联的文件描述符上有错误情况发生
> `EPOLLHUP` | 关联的文件描述符已挂起
> `EPOLLET` | 设置触发方式为边缘触发，默认为水平触发
> `EPOLLONESHOT` | 设置 one-shot 模式。触发一次事件后，该描述符会在轮询对象内部被禁用。
> `EPOLLRDNORM` | Equivalent to `EPOLLIN`
> `EPOLLRDBAND` | 可以读取优先数据带。
> `EPOLLWRNORM` | Equivalent to `EPOLLOUT`
> `EPOLLWRBAND` | 可以写入优先级数据。
> `EPOLLMSG` | 忽略

`epoll.``close`()

  关闭用于控制 epoll 对象的那个文件描述符。

`epoll.``fileno`()

  返回用于控制 epoll 对象的文件描述符对应的数字。

`epoll.``fromfd`(fd)

  根据给定的文件描述符创建 epoll 对象。

`epoll.``register`(fd[, eventmask])

  在 epoll 对象中注册一个文件描述符。

  注解

  Registering a file descriptor that’s already registered raises an IOError – contrary to Poll 对象’s register.

`epoll.``modify`(fd, eventmask)

  Modify a register file descriptor.

`epoll.``unregister`(fd)

  从 epoll 对象中删除一个已注册的文件描述符。

`epoll.``poll`([timeout=-1[, maxevents=-1]])

  等待事件发生，timeout 是浮点数，单位为秒。

## 16.1.2. Poll 对象

大多数 Unix 系统支持 `poll()` 系统调用，为服务器提供了更好的可伸缩性，使服务器可以同时服务于大量客户端。`poll()` 的伸缩性更好，因为该调用内部仅列出所关注的文件描述符，而 `select()` 会构造一个 bitmap，在其中将所关注的描述符所对应的 bit 打开，然后重新遍历整个 bitmap。因此 `select()` 复杂度是 O（最高文件描述符），而 `poll()` 是 O（文件描述符数量）。

`poll.``register`(fd[, eventmask])

  在轮询对象中注册文件描述符。这样，将来调用 `poll()` 方法时将检查文件描述符是否有未处理的 I/O 事件。fd 可以是整数，也可以是带有 `fileno()` 方法的对象（该方法返回一个整数）。文件对象已经实现了 `fileno()`，因此它们也可以用作参数。

  eventmask 是可选的位掩码，用于指定要检查的事件类型，它可以是常量 `POLLIN`、`POLLPRI` 和 `POLLOUT` 的组合，如下表所述。如果未指定本参数，默认将会检查所有 3 种类型的事件。

  常数 | 含义
  --- | ---
  `POLLIN` | 有要读取的数据
  `POLLPRI` | 有紧急数据需要读取
  `POLLOUT` | 准备输出：写不会阻塞
  `POLLERR` | 某种错误条件
  `POLLHUP` | 挂起
  `POLLNVAL` | 无效的请求：描述符未打开

  注册已注册过的文件描述符不会报错，且等同于只注册一次该描述符。

`poll.``modify`(fd, eventmask)

  Modifies an already registered fd. This has the same effect as `register(fd, eventmask)`. Attempting to modify a file descriptor that was never registered causes an `IOError` exception with errno `ENOENT` to be raised.

  2.6 新版功能.

`poll.``unregister`(fd)

  删除轮询对象正在跟踪的某个文件描述符。与 `register()` 方法类似，fd 可以是整数，也可以是带有 `fileno()` 方法的对象（该方法返回一个整数）。

  尝试删除从未注册过的文件描述符会抛出 `KeyError` 异常。

`poll.``poll`([timeout])

  轮询已注册的文件描述符的集合，并返回一个列表，列表可能为空，也可能有多个 `(fd, event)` 二元组，其中包含了要报告事件或错误的描述符。fd 是文件描述符，event 是一个位掩码，表示该描述符所报告的事件 — `POLLIN` 表示可以读取，`POLLOUT` 表示该描述符可以写入，依此类推。空列表表示调用超时，没有任何文件描述符报告事件。如果指定了 timeout，它将指定系统等待事件时，等待多长时间后返回（以毫秒为单位）。如果 timeout 为空、负数 或 `None`，则本调用将阻塞，直到轮询对象发生事件为止。

## 16.1.3. Kqueue 对象

`kqueue.``close`()

  关闭用于控制 kqueue 对象的文件描述符。

`kqueue.``fileno`()

  返回用于控制 epoll 对象的文件描述符对应的数字。

`kqueue.``fromfd`(fd)

  根据给定的文件描述符创建 kqueue 对象。

`kqueue.``control`(changelist, max_events[, timeout]) → eventlist

  Kevent 的低级接口

  - changelist 必须是一个可迭代对象，迭代出 kevent 对象，否则置为 `None`。

  - max_events 必须是 0 或一个正整数。

  - timeout 单位为秒（一般为浮点数），默认为 `None`，即永不超时。

## 16.1.4. Kevent 对象

https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2

`kevent.``ident`

  Value used to identify the event. The interpretation depends on the filter but it’s usually the file descriptor. In the constructor ident can either be an int or an object with a fileno() function. kevent stores the integer internally.

`kevent.``filter`

  内核过滤器的名称。

  常数 | 含义
  --- | ---
  `KQ_FILTER_READ` | 获取描述符，并在有数据可读时返回
  `KQ_FILTER_WRITE` | 获取描述符，并在有数据可写时返回
  `KQ_FILTER_AIO` | AIO 请求
  `KQ_FILTER_VNODE` | 当在 fflag 中监视的一个或多个请求事件发生时返回
  `KQ_FILTER_PROC` | 监视进程ID上的事件
  `KQ_FILTER_NETDEV` | 观察网络设备上的事件[在Mac OS X上不可用]
  `KQ_FILTER_SIGNAL` | 每当监视的信号传递到进程时返回
  `KQ_FILTER_TIMER` | 建立一个任意的计时器

`kevent.``flags`

  筛选器操作。

  常数 | 含义
  --- | ---
  `KQ_EV_ADD` | 添加或修改事件
  `KQ_EV_DELETE` | 从队列中删除事件
  `KQ_EV_ENABLE` | Permitscontrol() 返回事件
  `KQ_EV_DISABLE` | 禁用事件
  `KQ_EV_ONESHOT` | 在第一次发生后删除事件
  `KQ_EV_CLEAR` | 检索事件后重置状态
  `KQ_EV_SYSFLAGS` | 内部事件
  `KQ_EV_FLAG1` | 内部事件
  `KQ_EV_EOF` | 筛选特定EOF条件
  `KQ_EV_ERROR` | 请参阅返回值

`kevent.``fflags`

  筛选特定标志。

  `KQ_FILTER_READ` 和 `KQ_FILTER_WRITE` 过滤标志：

  常数 | 含义
  --- | ---
  `KQ_NOTE_LOWAT` | 套接字缓冲区的低水线

  `KQ_FILTER_VNODE` 过滤标志：

  常数 | 含义
  --- | ---
  `KQ_NOTE_DELETE` | 已调用 unlink()
  `KQ_NOTE_WRITE` | 发生写入
  `KQ_NOTE_EXTEND` | 文件已扩展
  `KQ_NOTE_ATTRIB` | 属性已更改
  `KQ_NOTE_LINK` | 链接计数已更改
  `KQ_NOTE_RENAME` | 文件已重命名
  `KQ_NOTE_REVOKE` | 对文件的访问权限已被撤销

  `KQ_FILTER_PROC` filter flags:

  常数 | 含义
  --- | ---
  `KQ_NOTE_EXIT` | 进程已退出
  `KQ_NOTE_FORK` | 该进程调用了 fork()
  `KQ_NOTE_EXEC` | 进程已执行新进程
  `KQ_NOTE_PCTRLMASK` | 内部过滤器标志
  `KQ_NOTE_PDATAMASK` | 内部过滤器标志
  `KQ_NOTE_TRACK` | 跨 fork() 执行进程
  `KQ_NOTE_CHILD` | 在 NOTE_TRACK 的子进程上返回
  `KQ_NOTE_TRACKERR` | 无法附加到子对象

  `KQ_FILTER_NETDEV` 过滤器标志（在Mac OS X上不可用）：

  常数 | 含义
  --- | ---
  `KQ_NOTE_LINKUP` | 链接已建立
  `KQ_NOTE_LINKDOWN` | 链接已断开
  `KQ_NOTE_LINKINV` | 链接状态无效

`kevent.``data`

  过滤特定数据。

`kevent.``udata`

  用户定义的值。