18.3. select — Waiting for I/O 完成


    注解

    模块是在 select 模块原型的基础上进行高级且高效的 I/O 复用。推荐用户改用 模块,除非用户希望对 OS 级的函数原型进行精确控制。

    该模块定义以下内容:

    exception select.error

    一个被弃用的 OSError 的别名。

    在 3.3 版更改: 根据 ,这个类是 OSError 的别名。

    select.devpoll()

    (仅支持 Solaris 及其衍生版本)返回一个 /dev/poll 轮询对象,请参阅下方 获取 devpoll 对象所支持的方法。

    devpoll() 对象与实例化时允许的文件描述符数量有关,如果在程序中降低了此数值,devpoll() 调用将失败。如果程序提高了此数值,devpoll() 可能会返回一个不完整的活动文件描述符列表。

    新的文件描述符 non-inheritable.

    3.3 新版功能.

    在 3.4 版更改: 新的文件描述符现在是不可继承的。

    select.epoll(sizehint=-1, flags=0)

    (仅支持 Linux 2.5.44 或更高版本)返回一个轮询对象,该对象可作为 I/O 事件的边缘触发或水平触发接口。

    sizehint 指示 epoll 预计需要注册的事件数。它必须为正数,或为 -1 以使用默认值。它仅在 epoll_create1() 不可用的旧系统上有用,其他情况下它没有任何作用(尽管仍会检查其值)。

    flags 已经弃用且完全被忽略。但是,如果提供该值,则它必须是 0select.EPOLL_CLOEXEC,否则会抛出 OSError 异常。

    请参阅下方 获取 epoll 对象所支持的方法。

    epoll 对象支持上下文管理器:当在 with 语句中使用时,新建的文件描述符会在运行至语句块结束时自动销毁。

    新的文件描述符 .

    在 3.3 版更改: 增加了 flags 参数。

    在 3.4 版更改: 增加了对 with 语句的支持。新的文件描述符现在是不可继承的。

    3.4 版后已移除: flags 参数。现在默认采用 select.EPOLL_CLOEXEC 标志。使用 来让文件描述符可继承。

    select.poll()

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

    select.kqueue()

    (仅支持 BSD)返回一个内核队列对象,请参阅下方 获取 kqueue 对象所支持的方法。

    新的文件描述符 non-inheritable.

    在 3.4 版更改: 新的文件描述符现在是不可继承的。

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

    (仅支持 BSD)返回一个内核事件对象,请参阅下方 获取 kevent 对象所支持的方法。

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

    This is a straightforward interface to the Unix select() system call. The first three arguments are sequences of ‘waitable objects’: either integers representing file descriptors or objects with a parameterless method named fileno() returning such an integer:

    • rlist:等待,直到有内容可以读取

    • wlist:等待,直到可以开始写入

    Empty sequences are allowed, but acceptance of three empty sequences is platform-dependent. (It is known to work on Unix but not on Windows.) The optional timeout argument specifies a time-out as a floating point number in seconds. When the timeout argument is omitted the function blocks until at least one file descriptor is ready. A time-out value of zero specifies a poll and never blocks.

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

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

    注解

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

    在 3.5 版更改: 现在,当本函数被信号中断时,重试超时将从头开始计时,不会抛出 InterruptedError 异常。除非信号处理程序抛出异常(相关原理请参阅 )。

    select.PIPE_BUF

    当一个管道已经被 select()、 或本模块中的某个接口报告为可写入时,可以在不阻塞该管道的情况下写入的最小字节数。它不适用于套接字等其他类型的文件类对象。

    This value is guaranteed by POSIX to be at least 512. Availability: Unix.

    3.2 新版功能.

    Solaris 及其衍生版本具备 /dev/pollselect() 复杂度为 O(最高文件描述符),poll() 为 O(文件描述符数量),而 /dev/poll 为 O(活动的文件描述符)。

    /dev/poll 的行为与标准 poll() 对象十分类似。

    devpoll.close()

    关闭轮询对象的文件描述符。

    3.4 新版功能.

    devpoll.closed

    如果轮询对象已关闭,则返回 True

    3.4 新版功能.

    devpoll.fileno()

    返回轮询对象的文件描述符对应的数字。

    3.4 新版功能.

    devpoll.register(fd[, eventmask])

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

    eventmask 是可选的位掩码,用于指定要检查的事件类型。这些常量与 poll() 对象所用的相同。本参数的默认值是常量 POLLINPOLLPRIPOLLOUT 的组合。

    警告

    注册已注册过的文件描述符不会报错,但是结果是不确定的。正确的操作是先注销或直接修改它。与 poll() 相比,这是一个重要的区别。

    devpoll.modify(fd[, eventmask])

    此方法先执行 unregister() 后执行 。直接执行此操作效率(稍微)高一些。

    devpoll.unregister(fd)

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

    尝试删除从未注册过的文件描述符将被安全地忽略。

    devpoll.poll([timeout])

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

    在 3.5 版更改: 现在,当本函数被信号中断时,重试超时将从头开始计时,不会抛出 异常。除非信号处理程序抛出异常(相关原理请参阅 PEP 475)。

    epoll.close()

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

    epoll.closed

    如果 epoll 对象已关闭,则返回 True

    epoll.fileno()

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

    epoll.fromfd(fd)

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

    epoll.register(fd[, eventmask])

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

    epoll.modify(fd, eventmask)

    修改一个已注册的文件描述符。

    epoll.unregister(fd)

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

    epoll.poll(timeout=-1, maxevents=-1)

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

    在 3.5 版更改: 现在,当本函数被信号中断时,重试超时将从头开始计时,不会抛出 异常。除非信号处理程序抛出异常(相关原理请参阅 PEP 475)。

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

    poll.register(fd[, eventmask])

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

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

    常数

    含义

    POLLIN

    有要读取的数据

    POLLPRI

    有紧急数据需要读取

    POLLOUT

    准备输出:写不会阻塞

    POLLERR

    某种错误条件

    POLLHUP

    挂起

    POLLRDHUP

    流套接字对等体关闭连接,或关闭写入一半连接

    POLLNVAL

    无效的请求:描述符未打开

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

    poll.modify(fd, eventmask)

    修改一个已注册的文件描述符,等同于 register(fd, eventmask)。尝试修改未注册的文件描述符会抛出 异常,错误码为 ENOENT

    poll.unregister(fd)

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

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

    poll.poll([timeout])

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

    在 3.5 版更改: 现在,当本函数被信号中断时,重试超时将从头开始计时,不会抛出 InterruptedError 异常。除非信号处理程序抛出异常(相关原理请参阅 )。

    kqueue.close()

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

    kqueue.closed

    如果 kqueue 对象已关闭,则返回 True

    ()

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

    kqueue.fromfd(fd)

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

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

    Kevent 的低级接口

    • changelist must be an iterable of kevent object or None

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

    • timeout in seconds (floats possible)

    在 3.5 版更改: 现在,当本函数被信号中断时,重试超时将从头开始计时,不会抛出 InterruptedError 异常。除非信号处理程序抛出异常(相关原理请参阅 )。

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

    kevent.ident

    用于区分事件的标识值。其解释取决于筛选器,但该值通常是文件描述符。在构造函数中,该标识值可以是整数或带有 方法的对象。kevent 在内部存储整数。

    kevent.filter

    内核过滤器的名称。

    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_READKQ_FILTER_WRITE 过滤标志:

    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_FILTER_NETDEV 过滤器标志(在Mac OS X上不可用):

    常数

    含义

    KQ_NOTE_LINKUP

    链接已建立

    KQ_NOTE_LINKDOWN

    链接已断开

    KQ_NOTE_LINKINV

    链接状态无效

    kevent.data

    过滤特定数据。

    kevent.udata