# `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.

Примітка

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.

Availability: not WASI.

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

Модуль визначає наступне:

exception select.error

  Застарілий псевдонім `OSError`.

  Змінено в версії 3.3: Після PEP 3151 цей клас отримав псевдонім `OSError`.

select.devpoll()

  (Підтримується лише в Solaris і похідних.) Повертає об’єкт опитування `/dev/poll`; дивіться розділ /dev/poll Опитування об’єктів нижче щодо методів, які підтримуються об’єктами 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.

  Новий файловий дескриптор не успадковується.

  Added in version 3.3.

  Змінено в версії 3.4: Новий файловий дескриптор тепер не успадковується.

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

  (Підтримується лише в Linux 2.5.44 і новіших версіях.) Повертає об’єкт опитування краю, який можна використовувати як інтерфейс Edge або Level Triggered для подій введення/виведення.

  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 застаріло та повністю ігнорується. Однак, коли надається, його значення має бути `0` або `select.EPOLL_CLOEXEC`, інакше `OSError` викликається.

  Перегляньте розділ Опитування (epoll) об’єктів тригера краю та рівня нижче, щоб дізнатися про методи, які підтримуються об’єктами електронного опитування.

  Об’єкти `epoll` підтримують протокол керування контекстом: при використанні в операторі `with` новий дескриптор файлу автоматично закривається в кінці блоку.

  Новий файловий дескриптор не успадковується.

  Змінено в версії 3.3: Додано параметр flags.

  Змінено в версії 3.4: Додано підтримку оператора `with`. Новий файловий дескриптор тепер не успадковується.

  Застаріло починаючи з версії 3.4: Параметр flags. `select.EPOLL_CLOEXEC` зараз використовується за умовчанням. Використовуйте `os.set_inheritable()`, щоб зробити дескриптор файлу спадковим.

select.poll()

  (Підтримується не всіма операційними системами.) Повертає об’єкт опитування, який підтримує реєстрацію та скасування реєстрації дескрипторів файлів, а потім опитування їх для подій введення/виведення; дивіться розділ Об’єкти опитування нижче щодо методів, які підтримуються об’єктами опитування.

select.kqueue()

  (Підтримується лише в BSD.) Повертає об’єкт черги ядра; перегляньте розділ Об’єкти Kqueue нижче, щоб дізнатися про методи, які підтримуються об’єктами kqueue.

  Новий файловий дескриптор не успадковується.

  Змінено в версії 3.4: Новий файловий дескриптор тепер не успадковується.

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

  (Підтримується лише в BSD.) Повертає об’єкт події ядра; дивіться розділ Об’єкти Kevent нижче щодо методів, які підтримуються об’єктами kevent.

select.select(rlist, wlist, xlist, timeout=None)

  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: дочекатися готовності до читання

  - wlist: дочекатися готовності до запису

  - xlist: зачекайте на «виняткову умову» (перегляньте сторінку посібника щодо того, що ваша система вважає такою умовою)

  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 in seconds; it may be a non-integer to specify fractions of 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.

  Повернене значення — це трійка списків готових об’єктів: підмножини перших трьох аргументів. Коли час очікування досягнуто, а дескриптор файлу не готовий, повертаються три порожні списки.

  Серед прийнятних типів об’єктів у ітераціях є файлові об’єкти Python (наприклад, `sys.stdin` або об’єкти, повернуті `open()` або `os.popen()`), сокет об’єкти, які повертає `socket.socket()`. Ви також можете визначити клас wrapper самостійно, за умови, що він має відповідний метод `fileno()` (який дійсно повертає дескриптор файлу, а не просто випадкове ціле число).

  Примітка

  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.

  Змінено в версії 3.5: Функція тепер виконується повторно з переобчисленим тайм-аутом, якщо її перериває сигнал, за винятком випадків, коли обробник сигналу викликає виняток (перегляньте PEP 475 для обґрунтування), замість того, щоб викликати `InterruptedError`.

  Змінено в версії 3.15: Accepts any real number as timeout, not only integer or float.

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.

  POSIX гарантує, що це значення буде не менше 512.

  Availability: Unix

  Added in version 3.2.

## `/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()

  Закрийте файловий дескриптор об’єкта опитування.

  Added in version 3.4.

devpoll.closed

  `True`, якщо об’єкт опитування закрито.

  Added in version 3.4.

devpoll.fileno()

  Повертає номер дескриптора файлу об’єкта опитування.

  Added in version 3.4.

devpoll.register(fd[, eventmask])

  Зареєструйте дескриптор файлу з об’єктом опитування. Подальші виклики методу `poll()` перевірятимуть, чи є в дескрипторі файлу будь-які незавершені події введення/виведення. fd може бути або цілим числом, або об’єктом із методом `fileno()`, який повертає ціле число. Файлові об’єкти реалізують `fileno()`, тому їх також можна використовувати як аргумент.

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

  Попередження

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

  Цей метод виконує `unregister()`, а потім `register()`. Це (трохи) ефективніше, ніж робити те саме явно.

devpoll.unregister(fd)

  Видаліть дескриптор файлу, який відстежується об’єктом опитування. Як і метод `register()`, fd може бути цілим числом або об’єктом із методом `fileno()`, який повертає ціле число.

  Спроба видалити дескриптор файлу, який ніколи не був зареєстрований, безпечно ігнорується.

devpoll.poll([timeout])

  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.

  Змінено в версії 3.5: Функція тепер виконується повторно з переобчисленим тайм-аутом, якщо її перериває сигнал, за винятком випадків, коли обробник сигналу викликає виняток (перегляньте PEP 475 для обґрунтування), замість того, щоб викликати `InterruptedError`.

  Змінено в версії 3.15: Accepts any real number as timeout, not only integer or float.

## Опитування (epoll) об’єктів тригера краю та рівня

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

> маска події

> Постійний | Значення
> --- | ---
> `EPOLLIN` | Доступний для читання
> `EPOLLOUT` | Доступний для запису
> `EPOLLPRI` | Термінові дані для читання
> `EPOLLERR` | Сталася помилка на доц. fd
> `EPOLLHUP` | Зависання сталося на доц. fd
> `EPOLLET` | Встановіть поведінку Edge Trigger, за замовчуванням це Level Trigger
> `EPOLLONESHOT` | Встановіть одноразову поведінку. Після вилучення однієї події fd внутрішньо вимикається
> `EPOLLEXCLUSIVE` | Розбудити лише один об’єкт epoll, якщо пов’язаний fd має подію. За замовчуванням (якщо цей прапорець не встановлено) всі об’єкти epoll запитуються на fd.
> `EPOLLRDHUP` | Потоковий сокет закрив однорангове з’єднання або завершив запис половини з’єднання.
> `EPOLLRDNORM` | Еквівалент `EPOLLIN`
> `EPOLLRDBAND` | Смугу пріоритетних даних можна зчитувати.
> `EPOLLWRNORM` | Еквівалент `EPOLLOUT`
> `EPOLLWRBAND` | Пріоритетні дані можуть бути записані.
> `EPOLLMSG` | Ігнорується.
> `EPOLLWAKEUP` | Prevents sleep during event waiting.

> Added in version 3.6: `EPOLLEXCLUSIVE` додано. Він підтримується лише ядром Linux 4.5 або новішої версії.

> Added in version 3.14: `EPOLLWAKEUP` was added. It’s only supported by Linux Kernel 3.5 or later.

epoll.close()

  Закрийте дескриптор керуючого файлу об’єкта epoll.

epoll.closed

  `True`, якщо об’єкт epoll закрито.

epoll.fileno()

  Повертає номер дескриптора файлу елемента керування fd.

epoll.fromfd(fd)

  Створіть об’єкт epoll із заданого файлового дескриптора.

epoll.register(fd[, eventmask])

  Зареєструйте дескриптор fd з об’єктом epoll.

epoll.modify(fd, eventmask)

  Змінити зареєстрований файловий дескриптор.

epoll.unregister(fd)

  Видаліть зареєстрований дескриптор файлу з об’єкта epoll.

  Змінено в версії 3.9: Метод більше не ігнорує помилку `EBADF`.

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

  Wait for events. If timeout is given, it specifies the length of time in seconds (may be non-integer) which the system will wait for events before returning.

  Змінено в версії 3.5: Функція тепер виконується повторно з переобчисленим тайм-аутом, якщо її перериває сигнал, за винятком випадків, коли обробник сигналу викликає виняток (перегляньте PEP 475 для обґрунтування), замість того, щоб викликати `InterruptedError`.

  Змінено в версії 3.15: Accepts any real number as timeout, not only integer or float.

## Об’єкти опитування

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

  Зареєструйте дескриптор файлу з об’єктом опитування. Подальші виклики методу `poll()` перевірятимуть, чи є в дескрипторі файлу будь-які незавершені події введення/виведення. fd може бути або цілим числом, або об’єктом із методом `fileno()`, який повертає ціле число. Файлові об’єкти реалізують `fileno()`, тому їх також можна використовувати як аргумент.

  eventmask — це необов’язкова бітова маска, що описує тип подій, які ви хочете перевірити, і може бути комбінацією констант `POLLIN`, `POLLPRI` і `POLLOUT`, описаних у таблицю нижче. Якщо не вказано, значення за умовчанням перевірятиме всі 3 типи подій.

  Постійний | Значення
  --- | ---
  `POLLIN` | Є дані для читання
  `POLLPRI` | Є термінові дані для читання
  `POLLOUT` | Готовий до виведення: запис не блокуватиметься
  `POLLERR` | Якась помилка
  `POLLHUP` | Повісив
  `POLLRDHUP` | Закрите однорангове з’єднання потокового сокета або завершіть запис половини з’єднання
  `POLNVAL` | Недійсний запит: дескриптор не відкрито

  Реєстрація дескриптора файлу, який уже зареєстровано, не є помилкою та має той самий ефект, що й одноразова реєстрація дескриптора.

poll.modify(fd, eventmask)

  Змінює вже зареєстрований fd. Це має той самий ефект, що й `register(fd, eventmask)`. Спроба змінити дескриптор файлу, який ніколи не був зареєстрований, викликає виняток `OSError` з errno `ENOENT`.

poll.unregister(fd)

  Видаліть дескриптор файлу, який відстежується об’єктом опитування. Як і метод `register()`, fd може бути цілим числом або об’єктом із методом `fileno()`, який повертає ціле число.

  Спроба видалити дескриптор файлу, який ніколи не був зареєстрований, викликає виняток `KeyError`.

poll.poll([timeout])

  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.

  Змінено в версії 3.5: Функція тепер виконується повторно з переобчисленим тайм-аутом, якщо її перериває сигнал, за винятком випадків, коли обробник сигналу викликає виняток (перегляньте PEP 475 для обґрунтування), замість того, щоб викликати `InterruptedError`.

  Змінено в версії 3.15: Accepts any real number as timeout, not only integer or float. If `ppoll()` function is available, timeout has a resolution of `1` ns (`1e-6` ms) instead of `1` ms.

## Об’єкти Kqueue

kqueue.close()

  Закрийте дескриптор керуючого файлу об’єкта kqueue.

kqueue.closed

  `True`, якщо об’єкт kqueue закрито.

kqueue.fileno()

  Повертає номер дескриптора файлу елемента керування fd.

kqueue.fromfd(fd)

  Створіть об’єкт kqueue із заданого файлового дескриптора.

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

  Низькорівневий інтерфейс для kevent

  - список змін має бути ітерованим об’єктами kevent або `None`

  - max_events має бути 0 або додатним цілим числом

  - timeout in seconds (non-integers are possible); the default is `None`, to wait forever

  Змінено в версії 3.5: Функція тепер виконується повторно з переобчисленим тайм-аутом, якщо її перериває сигнал, за винятком випадків, коли обробник сигналу викликає виняток (перегляньте PEP 475 для обґрунтування), замість того, щоб викликати `InterruptedError`.

  Змінено в версії 3.15: Accepts any real number as timeout, not only integer or float.

## Об’єкти Kevent

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

kevent.ident

  Значення, що використовується для ідентифікації події. Інтерпретація залежить від фільтра, але зазвичай це дескриптор файлу. У конструкторі ident може бути або int, або об’єктом із методом `fileno()`. kevent зберігає ціле число всередині.

kevent.filter

  Назва фільтра ядра.

  Постійний | Значення
  --- | ---
  `KQ_FILTER_READ` | Бере дескриптор і повертає, коли є дані, доступні для читання
  `KQ_FILTER_WRITE` | Бере дескриптор і повертає щоразу, коли є дані для запису
  `KQ_FILTER_AIO` | запити AIO
  `KQ_FILTER_VNODE` | Повертається, коли відбувається одна або кілька запитаних подій, які переглядаються в fflag
  `KQ_FILTER_PROC` | Слідкуйте за подіями в ідентифікаторі процесу
  `KQ_FILTER_NETDEV` | Стежити за подіями на мережевому пристрої [недоступно в macOS]
  `KQ_FILTER_SIGNAL` | Повертається щоразу, коли спостережуваний сигнал надходить до процесу
  `KQ_FILTER_TIMER` | Встановлює довільний таймер

kevent.flags

  Дія фільтра.

  Постійний | Значення
  --- | ---
  `KQ_EV_ADD` | Додає або змінює подію
  `KQ_EV_DELETE` | Вилучає подію з черги
  `KQ_EV_ENABLE` | Permitscontrol() to повертає подію
  `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` позначки фільтра:

  Постійний | Значення
  --- | ---
  `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` позначки фільтра (недоступні в macOS):

  Постійний | Значення
  --- | ---
  `KQ_NOTE_LINKUP` | посилання працює
  `KQ_NOTE_LINKDOWN` | посилання не працює
  `KQ_NOTE_LINKINV` | стан посилання недійсний

kevent.data

  Фільтр конкретних даних.

kevent.udata

  Визначене користувачем значення.