select — Waiting for I/O completion

---

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.

Nota

El módulo selectors permite la multiplexación de E/S de alto nivel y eficiente, construida sobre las primitivas del módulo select. Se alienta a los usuarios a utilizar el módulo selectors en su lugar, a menos que quieran un control preciso sobre las primitivas utilizadas de nivel OS.

Availability: not WASI.

This module does not work or is not available on WebAssembly. See Plataformas WebAssembly for more information.

El módulo define lo siguiente:

exception select.error

Un alias en desuso de OSError.

Distinto en la versión 3.3: Siguiente PEP 3151, esta clase se convirtió en un alias de OSError.

select.devpoll()

(Solo se admite en Solaris y derivados). Retorna un objeto de sondeo /dev/poll; vea la sección Objetos de sondeo /dev/poll a continuación para conocer los métodos admitidos por los objetos devpoll.

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.

El nuevo descriptor del archivo es non-inheritable.

Added in version 3.3.

Distinto en la versión 3.4: El nuevo descriptor de archivo ahora no es heredable.

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

(Solo se admite en Linux 2.5.44 y versiones posteriores). Retorna un objeto de sondeo de borde, que se puede usar como interfaz de disparo de nivel o de borde para eventos de E/S.

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 está en desuso y se ignora por completo. Sin embargo, cuando se proporciona, su valor debe ser 0 o select.EPOLL_CLOEXEC, de lo contrario, se lanzará OSError.

Consulte la sección Objetos de sondeo de Edge y Level Trigger (epoll) a continuación para conocer los métodos admitidos por los objetos epolling.

Los objetos epoll admiten el protocolo context management: cuando se usa en una declaración with, el nuevo descriptor de archivo se cierra automáticamente al final del bloque.

El nuevo descriptor del archivo es non-inheritable.

Distinto en la versión 3.3: Se agregó el parámetro flags.

Distinto en la versión 3.4: Se agregó soporte para la declaración with. El nuevo descriptor de archivo ahora no es heredable.

Obsoleto desde la versión 3.4: El parámetro flags. select.EPOLL_CLOEXEC se usa por defecto ahora. Use os.set_inheritable() para hacer que el descriptor de archivo sea heredable.

select.poll()

(No es compatible con todos los sistemas operativos). Retorna un objeto de sondeo, que admite registrar y anular el registro de descriptores de archivo, y luego sondearlos para eventos de I/O; vea la sección Sondeo de objetos a continuación para conocer los métodos admitidos por los objetos de sondeo.

select.kqueue()

(Solo se admite en BSD). Retorna un objeto de cola del kernel; vea la sección Objetos Kqueue a continuación para conocer los métodos admitidos por los objetos kqueue.

El nuevo descriptor del archivo es non-inheritable.

Distinto en la versión 3.4: El nuevo descriptor de archivo ahora no es heredable.

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

(Solo se admite en BSD). Retorna un objeto de evento del kernel; vea la sección Objetos Kevent a continuación para conocer los métodos admitidos por los objetos kevent.

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

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 fileno() returning such an integer:

• rlist: espera hasta que esté listo para leer

• wlist: espera hasta que esté listo para escribir

• xlist: espera una «condición excepcional» (consulte la página del manual para ver lo que su sistema considera tal condición)

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 the function blocks until at least one file descriptor is ready. A time-out value of zero specifies a poll and never blocks.

El valor de retorno es un triple de listas de objetos que están listos: subconjuntos de los primeros tres argumentos. Cuando se alcanza el tiempo de espera sin que esté listo un descriptor de archivo, se retornan tres listas vacías.

Entre los tipos de objetos aceptables en los iterables se encuentran Python objetos de archivo (por ejemplo, sys.stdin, u objetos retornados por open() o os.popen() ), objetos de socket retornados por socket.socket(). También puede definir una clase wrapper usted mismo, siempre que tenga un método fileno() apropiado (que realmente retorne un descriptor de archivo, no solo un entero aleatorio).

Nota

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.

Distinto en la versión 3.5: La función ahora se vuelve a intentar con un tiempo de espera (timeout) recalculado cuando se interrumpe por una señal, excepto si el controlador de señal genera una excepción (ver PEP 475 para la justificación), en lugar de generar InterruptedError.

select.PIPE_BUF

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(), poll() or another interface in this module. This doesn’t apply to other kind of file-like objects such as sockets.

Este valor es garantizado por POSIX para ser menor a 512.

Availability: Unix

Added in version 3.2.

Objetos de sondeo /dev/poll

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.

devpoll.close()

Cierra el descriptor de archivo del objeto de sondeo.

Added in version 3.4.

devpoll.closed

True si el objeto de sondeo está cerrado.

Added in version 3.4.

devpoll.fileno()

Retorna el número de descriptor de archivo del objeto de sondeo.

Added in version 3.4.

devpoll.register(fd[, eventmask])

Registra un descriptor de archivo con el objeto de sondeo. Las futuras llamadas al método poll() comprobarán si el descriptor del archivo tiene algún evento I/O pendiente. fd puede ser un entero o un objeto con un método fileno() que retorna un entero. Los objetos de archivo implementan Fileno(), por lo que también pueden usarse como argumento.

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

Advertencia

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().

devpoll.modify(fd[, eventmask])

Este método hace un unregister() seguido de a register(). Es (un poco) más eficiente que hacer lo mismo explícitamente.

devpoll.unregister(fd)

Elimina un descriptor de archivo que está siendo rastreado por un objeto de sondeo. Al igual que el método register(), fd puede ser un entero o un objeto con un método fileno() que retorna un entero.

Al intentar eliminar un descriptor de archivo que nunca se registró se ignora de forma segura.

devpoll.poll([timeout])

Sondea el conjunto de descriptores de archivos registrados y retorna una lista posiblemente vacía que contiene tuplas de dos elementos (fd, event) para los descriptores que tienen eventos o errores para informar. fd es el descriptor de archivo, y event es una máscara de bits con bits configurados para los eventos informados para ese descriptor — POLLIN para entrada en espera, POLLOUT para indicar que se puede escribir en el descriptor, y así sucesivamente. Una lista vacía indica que se agotó el tiempo de espera de la llamada y que ningún descriptor de archivo tuvo eventos para informar. Si se proporciona timeout, especifica el período de tiempo en milisegundos que el sistema esperará por los eventos antes de regresar. Si se omite timeout, -1 o None, la llamada se bloqueará hasta que haya un evento para este objeto de sondeo.

Distinto en la versión 3.5: La función ahora se vuelve a intentar con un tiempo de espera (timeout) recalculado cuando se interrumpe por una señal, excepto si el controlador de señal genera una excepción (ver PEP 475 para la justificación), en lugar de generar InterruptedError.

Objetos de sondeo de Edge y Level Trigger (epoll)

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

eventmask

Constante	Significado
EPOLLIN	Disponible para lectura
EPOLLOUT	Disponible para escritura
EPOLLPRI	Urgente para lectura
EPOLLERR	La condición de error ocurrió en la asociación. fd
EPOLLHUP	Se colgó en la asociación. fd
EPOLLET	Establece el comportamiento en Edge Trigger, el valor predeterminado es Level Trigger
EPOLLONESHOT	Establece el comportamiento en one-shot. Después de que se retira un evento, el fd se deshabilita internamente
EPOLLEXCLUSIVE	Despierta solo un objeto epoll cuando el fd asociado tiene un evento. El valor predeterminado (si este flag no está configurado) es activar todos los objetos epoll que sondean en un fd.
EPOLLRDHUP	Socket de flujo de conexión cerrada por pares o apagado escribiendo la mitad de la conexión.
EPOLLRDNORM	Equivalente a EPOLLIN
EPOLLRDBAND	La banda de datos de prioridad se puede leer.
EPOLLWRNORM	Equivalente a EPOLLOUT
EPOLLWRBAND	Se pueden escribir datos de prioridad.
EPOLLMSG	Ignorado.

Added in version 3.6: EPOLLEXCLUSIVE fue agregado. Solo es compatible con Linux Kernel 4.5 o posterior.

epoll.close()

Cierra el descriptor del archivo de control del objeto epoll.

epoll.closed

True si el objeto epoll está cerrado.

epoll.fileno()

Retorna el número de descriptor de archivo del control fd.

epoll.fromfd(fd)

Crea un objeto epoll a partir de un descriptor de archivo dado.

epoll.register(fd[, eventmask])

Registra un descriptor fd con el objeto epoll.

epoll.modify(fd, eventmask)

Modifica un descriptor de archivo registrado.

epoll.unregister(fd)

Elimina un descriptor de archivo registrado del objeto epoll.

Distinto en la versión 3.9: El método ya no ignora el error EBADF.

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

Espera los eventos. tiempo de espera (timeout) en segundos (float)

Distinto en la versión 3.5: La función ahora se vuelve a intentar con un tiempo de espera (timeout) recalculado cuando se interrumpe por una señal, excepto si el controlador de señal genera una excepción (ver PEP 475 para la justificación), en lugar de generar InterruptedError.

Sondeo de objetos

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).

poll.register(fd[, eventmask])

Registra un descriptor de archivo con el objeto de sondeo. Las futuras llamadas al método poll() comprobarán si el descriptor del archivo tiene algún evento I/O pendiente. fd puede ser un entero o un objeto con un método fileno() que retorna un entero. Los objetos de archivo implementan Fileno(), por lo que también pueden usarse como argumento.

eventmask es una máscara de bits opcional que describe el tipo de eventos que se desea verificar y puede ser una combinación de las constantes POLLIN, POLLPRI, y POLLOUT, descrito en la mesa de abajo. Si no se especifica, el valor predeterminado utilizado verificará los 3 tipos de eventos.

Constante	Significado
POLLIN	Hay datos para leer
POLLPRI	Hay datos urgentes para leer
POLLOUT	Lista para la salida: la escritura no bloqueará
POLLERR	Condición de error de algún tipo
POLLHUP	Colgado
POLLRDHUP	Socket de flujo de conexión cerrada por pares, o apagado escribiendo la mitad de la conexión
POLLNVAL	Solicitud no válida: descriptor no abierto

Al registrar un descriptor de archivo que ya está registrado no es un error y tiene el mismo efecto que registrar el descriptor exactamente una vez.

poll.modify(fd, eventmask)

Modifica un fd ya registrado. Esto tiene el mismo efecto que register(fd, eventmask). Si se intenta modificar un descriptor de archivo que nunca se registró, se genera una excepción OSError con errno ENOENT.

poll.unregister(fd)

Elimina un descriptor de archivo que está siendo rastreado por un objeto de sondeo. Al igual que el método register(), fd puede ser un entero o un objeto con un método fileno() que retorna un entero.

Intenta eliminar un descriptor de archivo que nunca se registró provoca una excepción KeyError.

poll.poll([timeout])

Sondea el conjunto de descriptores de archivos registrados y retorna una lista posiblemente vacía que contiene tuplas de 2 elementos (fd, event) para los descriptores que tienen eventos o errores para informar. fd es el descriptor de archivo, y event es una máscara de bits con bits configurados para los eventos informados para ese descriptor — POLLIN para entrada en espera, POLLOUT para indicar que se puede escribir en el descriptor, y así sucesivamente. Una lista vacía indica que se agotó el tiempo de espera de la llamada y que ningún descriptor de archivo tuvo eventos para informar. Si se proporciona timeout, especifica el período de tiempo en milisegundos que el sistema esperará por los eventos antes de regresar. Si se omite timeout, es negativo o None, la llamada se bloqueará hasta que haya un evento para este objeto de sondeo.

Distinto en la versión 3.5: La función ahora se vuelve a intentar con un tiempo de espera (timeout) recalculado cuando se interrumpe por una señal, excepto si el controlador de señal genera una excepción (ver PEP 475 para la justificación), en lugar de generar InterruptedError.

Objetos Kqueue

kqueue.close()

Cierra el descriptor del archivo de control del objeto kqueue.

kqueue.closed

True si el objeto kqueue está cerrado.

kqueue.fileno()

Retorna el número de descriptor de archivo del control fd.

kqueue.fromfd(fd)

Crea un objeto kqueue a partir de un descriptor de archivo dado.

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

Interfaz de bajo nivel para kevent

• la lista de cambios (changelist) debe ser iterable de objetos kevent o None

• max_events debe ser 0 o un entero positivo

• tiempo de espera (timeout) en segundos (posible con floats); el valor predeterminado es None, para esperar para siempre

Distinto en la versión 3.5: La función ahora se vuelve a intentar con un tiempo de espera (timeout) recalculado cuando se interrumpe por una señal, excepto si el controlador de señal genera una excepción (ver PEP 475 para la justificación), en lugar de generar InterruptedError.

Objetos Kevent

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

kevent.ident

Valor utilizado para identificar el evento. La interpretación depende del filtro, pero generalmente es el descriptor de archivo. En el constructor, ident puede ser un int o un objeto con un método fileno(). kevent almacena el entero internamente.

kevent.filter

Nombre del filtro del kernel.

Constante	Significado
KQ_FILTER_READ	Toma un descriptor y retorna cada vez que hay datos disponibles para leer
KQ_FILTER_WRITE	Toma un descriptor y retorna cada vez que hay datos disponibles para escribir
KQ_FILTER_AIO	Solicitudes de AIO
KQ_FILTER_VNODE	Retorna cuando ocurre uno o más de los eventos solicitados observados en fflag
KQ_FILTER_PROC	Vigila los eventos en un id de proceso
KQ_FILTER_NETDEV	Vigila los eventos en un dispositivo de red [no disponible en macOS]
KQ_FILTER_SIGNAL	Retorna cada vez que la señal observada se entrega al proceso
KQ_FILTER_TIMER	Establece un temporizador arbitrario

kevent.flags

Acción de filtro.

Constante	Significado
KQ_EV_ADD	Agrega o modifica un evento
KQ_EV_DELETE	Elimina un evento de la cola
KQ_EV_ENABLE	Permitscontrol() para retornar el evento
KQ_EV_DISABLE	Disablesevent
KQ_EV_ONESHOT	Elimina evento después de la primera aparición
KQ_EV_CLEAR	Restablece el estado después de recuperar un evento
KQ_EV_SYSFLAGS	evento interno
KQ_EV_FLAG1	evento interno
KQ_EV_EOF	Filtrar la condición específica de EOF
KQ_EV_ERROR	Ver valores de retorno

kevent.fflags

Filtrar flags específicas.

KQ_FILTER_READ y KQ_FILTER_WRITE bandera de filtro:

Constante	Significado
KQ_NOTE_LOWAT	marca de agua baja de un socket buffer

KQ_FILTER_VNODE bandera de filtro:

Constante	Significado
KQ_NOTE_DELETE	unlink() fue llamado
KQ_NOTE_WRITE	una escritura ha ocurrido
KQ_NOTE_EXTEND	el archivo fue extendido
KQ_NOTE_ATTRIB	un atributo fue cambiado
KQ_NOTE_LINK	el recuento de enlaces ha cambiado
KQ_NOTE_RENAME	el archivo fue renombrado
KQ_NOTE_REVOKE	se revocó el acceso al archivo

KQ_FILTER_PROC bandera de filtro:

Constante	Significado
KQ_NOTE_EXIT	el proceso ha terminado (exited)
KQ_NOTE_FORK	el proceso ha llamado a fork()
KQ_NOTE_EXEC	el proceso ha ejecutado un nuevo proceso
KQ_NOTE_PCTRLMASK	flag de filtro interno
KQ_NOTE_PDATAMASK	flag de filtro interno
KQ_NOTE_TRACK	sigue un proceso a través de fork()
KQ_NOTE_CHILD	retornado en el proceso hijo para NOTE_TRACK
KQ_NOTE_TRACKERR	incapaz de adjuntar a un proceso hijo

Indicadores de filtro KQ_FILTER_NETDEV (no disponible en macOS):

Constante	Significado
KQ_NOTE_LINKUP	el enlace está funcionando
KQ_NOTE_LINKDOWN	el enlace está caído
KQ_NOTE_LINKINV	el estado del enlace es invalido

kevent.data

Filtrar datos específicos.

kevent.udata

Valor definido por el usuario.