:mod:`!select` --- Waiting for I/O completion

فهرست فصل‌ها دانلود آرشیوناشر

Python 3.14 Docs · نسخهٔ 3.14.10 · PSF License

:mod:!select --- Waiting for I/O completion

:synopsis: Wait for I/O completion on multiple streams.

--------------

This module provides access to the !select and !poll functions available in most operating systems, !devpoll available on Solaris and derivatives, !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.

The selectors module allows high-level and efficient I/O multiplexing, built upon the !select module primitives. Users are encouraged to use the selectors module instead, unless they want precise control over the OS-level primitives used.

The module defines the following:

A deprecated alias of OSError.

Following 3151, this class was made an alias of OSError.

Returns a `/dev/poll polling object; see section devpoll-objects` below for the methods supported by devpoll objects.

!devpoll objects are linked to the number of file descriptors allowed at the time of instantiation. If your program reduces this value, !devpoll will fail. If your program increases this value, !devpoll may return an incomplete list of active file descriptors.

The new file descriptor is non-inheritable <fd_inheritance>.

The new file descriptor is now non-inheritable.

Return an edge polling object, which can be used as Edge or Level Triggered interface for I/O events.

*sizehint* informs epoll about the expected number of events to be registered. It must be positive, or `-1 to use the default. It is only used on older systems where !epoll_create1` is not available; otherwise it has no effect (though its value is still checked).

*flags* is deprecated and completely ignored. However, when supplied, its value must be `0 or select.EPOLL_CLOEXEC, otherwise OSError` is raised.

See the epoll-objects section below for the methods supported by epolling objects.

`epoll objects support the context management protocol: when used in a with` statement, the new file descriptor is automatically closed at the end of the block.

The new file descriptor is non-inheritable <fd_inheritance>.

Added the *flags* parameter.

Support for the with statement was added. The new file descriptor is now non-inheritable.

The *flags* parameter. `select.EPOLL_CLOEXEC is used by default now. Use os.set_inheritable` to make the file descriptor inheritable.

Returns a polling object, which supports registering and unregistering file descriptors, and then polling them for I/O events; see section poll-objects below for the methods supported by polling objects.

Returns a kernel queue object; see section kqueue-objects below for the methods supported by kqueue objects.

The new file descriptor is non-inheritable <fd_inheritance>.

The new file descriptor is now non-inheritable.

Returns a kernel event object; see section kevent-objects below for the methods supported by kevent objects.

This is a straightforward interface to the Unix !select system call. The first three arguments are iterables of 'waitable objects': either integers representing file descriptors or objects with a parameterless method named ~io.IOBase.fileno returning such an integer:

  • *rlist*: wait until ready for reading
  • *wlist*: wait until ready for writing
  • *xlist*: wait for an "exceptional condition" (see the manual page for what

your system considers such a condition)

Empty iterables are allowed, but acceptance of three empty iterables 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 or `None`, the function blocks until at least one file descriptor is ready. A time-out value of zero specifies a poll and never blocks.

The return value is a triple of lists of objects that are ready: subsets of the first three arguments. When the time-out is reached without a file descriptor becoming ready, three empty lists are returned.

single: socket() (in module socket) single: popen() (in module os)

Among the acceptable object types in the iterables are Python :term:file objects <file object> (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 ~io.IOBase.fileno` method (that really returns a file descriptor, not just a random integer).

File objects on Windows are not acceptable, but sockets are. On Windows, the underlying !select function is provided by the WinSock library, and does not handle file descriptors that don't originate from WinSock.

The function is now retried with a recomputed timeout when interrupted by a signal, except if the signal handler raises an exception (see 475 for the rationale), instead of raising InterruptedError.

The minimum number of bytes which can be written without blocking to a pipe when the pipe has been reported as ready for writing by ~select.select, !poll or another interface in this module. This doesn't apply to other kinds of file-like objects such as sockets.

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

`/dev/poll` polling objects

Solaris and derivatives have `/dev/poll. While !select is *O*\ (*highest file descriptor*) and !poll is *O*\ (*number of file descriptors*), /dev/poll` is *O*\ (*active file descriptors*).

`/dev/poll behaviour is very close to the standard !poll` object.

Close the file descriptor of the polling object.

`True` if the polling object is closed.

Return the file descriptor number of the polling object.

Register a file descriptor with the polling object. Future calls to the poll method will then check whether the file descriptor has any pending I/O events. *fd* can be either an integer, or an object with a ~io.IOBase.fileno method that returns an integer. File objects implement !fileno, so they can also be used as the argument.

*eventmask* is an optional bitmask describing the type of events you want to check for. The constants are the same as with !poll object. The default value is a combination of the constants POLLIN, POLLPRI, and POLLOUT.

Registering a file descriptor that's already registered is not an error, but the result is undefined. The appropriate action is to unregister or modify it first. This is an important difference compared with !poll.

This method does an unregister followed by a register. It is (a bit) more efficient than doing the same explicitly.

Remove a file descriptor being tracked by a polling object. Just like the register method, *fd* can be an integer or an object with a ~io.IOBase.fileno method that returns an integer.

Attempting to remove a file descriptor that was never registered is safely ignored.

Polls the set of registered file descriptors, and returns a possibly empty list containing `(fd, event) 2-tuples for the descriptors that have events or errors to report. *fd* is the file descriptor, and *event* is a bitmask with bits set for the reported events for that descriptor --- POLLIN for waiting input, POLLOUT to indicate that the descriptor can be written to, and so forth. An empty list indicates that the call timed out and no file descriptors had any events to report. If *timeout* is given, it specifies the length of time in milliseconds which the system will wait for events before returning. If *timeout* is omitted, -1, or None`, the call will block until there is an event for this poll object.

The function is now retried with a recomputed timeout when interrupted by a signal, except if the signal handler raises an exception (see 475 for the rationale), instead of raising InterruptedError.

Edge and level trigger polling (epoll) objects

https://linux.die.net/man/4/epoll

The *eventmask* is a bit mask using the following constants:

+-------------------------+------------------------------------------------+

ConstantMeaning

+=========================+================================================+

EPOLLINAvailable for read.

+-------------------------+------------------------------------------------+

EPOLLOUTAvailable for write.

+-------------------------+------------------------------------------------+

EPOLLPRIUrgent data for read.

+-------------------------+------------------------------------------------+

EPOLLERRError condition happened on the associated fd.

+-------------------------+------------------------------------------------+

EPOLLHUPHang up happened on the associated fd.

+-------------------------+------------------------------------------------+

EPOLLETSet Edge Trigger behavior, the default is
Level Trigger behavior.

+-------------------------+------------------------------------------------+

EPOLLONESHOTSet one-shot behavior. After one event is
pulled out, the fd is internally disabled.

+-------------------------+------------------------------------------------+

EPOLLEXCLUSIVEWake only one epoll object when the
associated fd has an event. The default (if
this flag is not set) is to wake all epoll
objects polling on an fd.

+-------------------------+------------------------------------------------+

EPOLLRDHUPStream socket peer closed connection or shut
down writing half of connection.

+-------------------------+------------------------------------------------+

EPOLLRDNORMEquivalent to EPOLLIN

+-------------------------+------------------------------------------------+

EPOLLRDBANDPriority data band can be read.

+-------------------------+------------------------------------------------+

EPOLLWRNORMEquivalent to EPOLLOUT.

+-------------------------+------------------------------------------------+

EPOLLWRBANDPriority data may be written.

+-------------------------+------------------------------------------------+

EPOLLMSGIgnored.

+-------------------------+------------------------------------------------+

EPOLLWAKEUPPrevents sleep during event waiting.

+-------------------------+------------------------------------------------+

EPOLLEXCLUSIVE was added. It's only supported by Linux Kernel 4.5 or later.

EPOLLWAKEUP was added. It's only supported by Linux Kernel 3.5 or later.

Close the control file descriptor of the epoll object.

`True` if the epoll object is closed.

Return the file descriptor number of the control fd.

Create an epoll object from a given file descriptor.

Register a file descriptor *fd* with the epoll object.

Modify a registered file descriptor *fd*.

Remove a registered file descriptor from the epoll object.

The method no longer ignores the ~errno.EBADF error.

Wait for events. timeout in seconds (float)

The function is now retried with a recomputed timeout when interrupted by a signal, except if the signal handler raises an exception (see 475 for the rationale), instead of raising InterruptedError.

Polling objects

The !poll system call, supported on most Unix systems, provides better scalability for network servers that service many, many clients at the same time. !poll scales better because the system call only requires listing the file descriptors of interest, while !select builds a bitmap, turns on bits for the fds of interest, and then afterward the whole bitmap has to be linearly scanned again. !select is *O*\ (*highest file descriptor*), while !poll is *O*\ (*number of file descriptors*).

Register a file descriptor with the polling object. Future calls to the poll method will then check whether the file descriptor has any pending I/O events. *fd* can be either an integer, or an object with a ~io.IOBase.fileno method that returns an integer. File objects implement !fileno, so they can also be used as the argument.

*eventmask* is an optional bitmask describing the type of events you want to check for, and can be a combination of the constants POLLIN, POLLPRI, and POLLOUT, described in the table below. If not specified, the default value used will check for all 3 types of events.

+-------------------+-------------------------------------------+

ConstantMeaning

+===================+===========================================+

POLLINThere is data to read.

+-------------------+-------------------------------------------+

POLLPRIThere is urgent data to read.

+-------------------+-------------------------------------------+

POLLOUTReady for output: writing will not block.

+-------------------+-------------------------------------------+

POLLERRError condition of some sort.

+-------------------+-------------------------------------------+

POLLHUPHung up.

+-------------------+-------------------------------------------+

POLLRDHUPStream socket peer closed connection, or
shut down writing half of connection.

+-------------------+-------------------------------------------+

POLLNVALInvalid request: descriptor not open.

+-------------------+-------------------------------------------+

Registering a file descriptor that's already registered is not an error, and has the same effect as registering the descriptor exactly once.

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 OSError exception with errno ENOENT` to be raised.

Remove a file descriptor being tracked by a polling object. Just like the register method, *fd* can be an integer or an object with a ~io.IOBase.fileno method that returns an integer.

Attempting to remove a file descriptor that was never registered causes a KeyError exception to be raised.

Polls the set of registered file descriptors, and returns a possibly empty list containing `(fd, event) 2-tuples for the descriptors that have events or errors to report. *fd* is the file descriptor, and *event* is a bitmask with bits set for the reported events for that descriptor --- POLLIN for waiting input, POLLOUT to indicate that the descriptor can be written to, and so forth. An empty list indicates that the call timed out and no file descriptors had any events to report. If *timeout* is given, it specifies the length of time in milliseconds which the system will wait for events before returning. If *timeout* is omitted, negative, or None`, the call will block until there is an event for this poll object.

The function is now retried with a recomputed timeout when interrupted by a signal, except if the signal handler raises an exception (see 475 for the rationale), instead of raising InterruptedError.

Kqueue objects

Close the control file descriptor of the kqueue object.

`True` if the kqueue object is closed.

Return the file descriptor number of the control fd.

Create a kqueue object from a given file descriptor.

Low level interface to kevent

  • changelist must be an iterable of kevent objects or `None`
  • max_events must be 0 or a positive integer
  • timeout in seconds (floats possible); the default is `None`,

to wait forever

The function is now retried with a recomputed timeout when interrupted by a signal, except if the signal handler raises an exception (see 475 for the rationale), instead of raising InterruptedError.

Kevent objects

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

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 ~io.IOBase.fileno method. kevent stores the integer internally.

Name of the kernel filter.

+---------------------------+---------------------------------------------+

ConstantMeaning

+===========================+=============================================+

KQ_FILTER_READTakes a descriptor and returns whenever
there is data available to read.

+---------------------------+---------------------------------------------+

KQ_FILTER_WRITETakes a descriptor and returns whenever
there is data available to write.

+---------------------------+---------------------------------------------+

KQ_FILTER_AIOAIO requests.

+---------------------------+---------------------------------------------+

KQ_FILTER_VNODEReturns when one or more of the requested
events watched in *fflag* occurs.

+---------------------------+---------------------------------------------+

KQ_FILTER_PROCWatch for events on a process ID.

+---------------------------+---------------------------------------------+

KQ_FILTER_NETDEVWatch for events on a network device
(not available on macOS).

+---------------------------+---------------------------------------------+

KQ_FILTER_SIGNALReturns whenever the watched signal is
delivered to the process.

+---------------------------+---------------------------------------------+

KQ_FILTER_TIMEREstablishes an arbitrary timer.

+---------------------------+---------------------------------------------+

Filter action.

+---------------------------+----------------------------------------------+

ConstantMeaning

+===========================+==============================================+

KQ_EV_ADDAdds or modifies an event.

+---------------------------+----------------------------------------------+

KQ_EV_DELETERemoves an event from the queue.

+---------------------------+----------------------------------------------+

KQ_EV_ENABLEPermits control() to return the event.

+---------------------------+----------------------------------------------+

KQ_EV_DISABLEDisables event.

+---------------------------+----------------------------------------------+

KQ_EV_ONESHOTRemoves event after first occurrence.

+---------------------------+----------------------------------------------+

KQ_EV_CLEARReset the state after an event is retrieved.

+---------------------------+----------------------------------------------+

KQ_EV_SYSFLAGSInternal event.

+---------------------------+----------------------------------------------+

KQ_EV_FLAG1Internal event.

+---------------------------+----------------------------------------------+

KQ_EV_EOFFilter-specific EOF condition.

+---------------------------+----------------------------------------------+

KQ_EV_ERRORSee return values.

+---------------------------+----------------------------------------------+

Filter-specific flags.

KQ_FILTER_READ and KQ_FILTER_WRITE filter flags:

+----------------------------+--------------------------------------------+

ConstantMeaning

+============================+============================================+

KQ_NOTE_LOWATLow water mark of a socket buffer.

+----------------------------+--------------------------------------------+

KQ_FILTER_VNODE filter flags:

+----------------------------+--------------------------------------------+

ConstantMeaning

+============================+============================================+

KQ_NOTE_DELETE*unlink()* was called.

+----------------------------+--------------------------------------------+

KQ_NOTE_WRITEA write occurred.

+----------------------------+--------------------------------------------+

KQ_NOTE_EXTENDThe file was extended.

+----------------------------+--------------------------------------------+

KQ_NOTE_ATTRIBAn attribute was changed.

+----------------------------+--------------------------------------------+

KQ_NOTE_LINKThe link count has changed.

+----------------------------+--------------------------------------------+

KQ_NOTE_RENAMEThe file was renamed.

+----------------------------+--------------------------------------------+

KQ_NOTE_REVOKEAccess to the file was revoked.

+----------------------------+--------------------------------------------+

KQ_FILTER_PROC filter flags:

+----------------------------+--------------------------------------------+

ConstantMeaning

+============================+============================================+

KQ_NOTE_EXITThe process has exited.

+----------------------------+--------------------------------------------+

KQ_NOTE_FORKThe process has called *fork()*.

+----------------------------+--------------------------------------------+

KQ_NOTE_EXECThe process has executed a new process.

+----------------------------+--------------------------------------------+

KQ_NOTE_PCTRLMASKInternal filter flag.

+----------------------------+--------------------------------------------+

KQ_NOTE_PDATAMASKInternal filter flag.

+----------------------------+--------------------------------------------+

KQ_NOTE_TRACKFollow a process across *fork()*.

+----------------------------+--------------------------------------------+

KQ_NOTE_CHILDReturned on the child process for
*NOTE_TRACK*.

+----------------------------+--------------------------------------------+

KQ_NOTE_TRACKERRUnable to attach to a child.

+----------------------------+--------------------------------------------+

KQ_FILTER_NETDEV filter flags (not available on macOS):

+----------------------------+--------------------------------------------+

ConstantMeaning

+============================+============================================+

KQ_NOTE_LINKUPLink is up.

+----------------------------+--------------------------------------------+

KQ_NOTE_LINKDOWNLink is down.

+----------------------------+--------------------------------------------+

KQ_NOTE_LINKINVLink state is invalid.

+----------------------------+--------------------------------------------+

Filter-specific data.

User-defined value.