|
| 1 | +# select Module |
| 2 | + |
| 3 | +The `select` module provides low-level I/O multiplexing primitives that wait for file |
| 4 | +descriptors to become ready for reading or writing. |
| 5 | + |
| 6 | +## Complexity Reference |
| 7 | + |
| 8 | +| Operation | Time | Space | Notes | |
| 9 | +|-----------|------|-------|-------| |
| 10 | +| `select.select()` | O(n) | O(n) | n = total fds passed; scans all sets | |
| 11 | +| `poll.register()` / `poll.unregister()` / `poll.modify()` | O(1) avg | O(1) | Per fd; Python bookkeeping + OS registration | |
| 12 | +| `poll.poll()` | O(n) | O(k) | n = registered fds, k = ready fds | |
| 13 | +| `epoll.register()` / `epoll.unregister()` / `epoll.modify()` | O(1) avg | O(1) | Per fd; OS-dependent | |
| 14 | +| `epoll.poll()` | O(k) typical | O(k) | k = ready fds; OS-dependent | |
| 15 | +| `kqueue.control()` | O(m + k) | O(k) | m = changelist length; k = ready events | |
| 16 | + |
| 17 | +!!! warning "Platform availability" |
| 18 | + `poll`, `epoll`, and `kqueue` are not available on all platforms. |
| 19 | + Always guard with `hasattr(select, "poll")`, `hasattr(select, "epoll")`, |
| 20 | + or `hasattr(select, "kqueue")`. |
| 21 | + |
| 22 | +## Waiting with select() |
| 23 | + |
| 24 | +```python |
| 25 | +import select |
| 26 | +import socket |
| 27 | + |
| 28 | +# Create a connected socket pair (cross-platform in Python 3.5+) |
| 29 | +left, right = socket.socketpair() |
| 30 | + |
| 31 | +# Send data so right becomes readable |
| 32 | +left.sendall(b"ping") |
| 33 | + |
| 34 | +# Wait for readability - O(n) where n = len(rlist) + len(wlist) + len(xlist) |
| 35 | +rlist, wlist, xlist = select.select([right], [], [], 1.0) |
| 36 | +if rlist: |
| 37 | + data = right.recv(4096) |
| 38 | + print(data) # b'ping' |
| 39 | + |
| 40 | +left.close() |
| 41 | +right.close() |
| 42 | +``` |
| 43 | + |
| 44 | +## Polling with poll() |
| 45 | + |
| 46 | +```python |
| 47 | +import select |
| 48 | +import socket |
| 49 | + |
| 50 | +if hasattr(select, "poll"): |
| 51 | + left, right = socket.socketpair() |
| 52 | + poller = select.poll() |
| 53 | + |
| 54 | + # Register for read events - O(1) average |
| 55 | + poller.register(right, select.POLLIN) |
| 56 | + |
| 57 | + left.sendall(b"hello") |
| 58 | + |
| 59 | + # Wait for events - O(n) for n registered fds |
| 60 | + events = poller.poll(1000) # timeout in ms |
| 61 | + for fd, event in events: # O(k) for k ready |
| 62 | + if event & select.POLLIN: |
| 63 | + print(right.recv(4096)) # b'hello' |
| 64 | + |
| 65 | + poller.unregister(right) # O(1) average |
| 66 | + left.close() |
| 67 | + right.close() |
| 68 | +``` |
| 69 | + |
| 70 | +## Using epoll (Linux) |
| 71 | + |
| 72 | +```python |
| 73 | +import select |
| 74 | +import socket |
| 75 | + |
| 76 | +if hasattr(select, "epoll"): |
| 77 | + left, right = socket.socketpair() |
| 78 | + ep = select.epoll() |
| 79 | + |
| 80 | + # Register read interest - O(1) average |
| 81 | + ep.register(right, select.EPOLLIN) |
| 82 | + |
| 83 | + left.sendall(b"event") |
| 84 | + |
| 85 | + # Wait for ready fds - typically O(k) |
| 86 | + events = ep.poll(1.0) |
| 87 | + for fd, event in events: |
| 88 | + if event & select.EPOLLIN: |
| 89 | + print(right.recv(4096)) # b'event' |
| 90 | + |
| 91 | + ep.unregister(right) # O(1) average |
| 92 | + ep.close() |
| 93 | + left.close() |
| 94 | + right.close() |
| 95 | +``` |
| 96 | + |
| 97 | +## Using kqueue (BSD/macOS) |
| 98 | + |
| 99 | +```python |
| 100 | +import select |
| 101 | +import socket |
| 102 | + |
| 103 | +if hasattr(select, "kqueue"): |
| 104 | + left, right = socket.socketpair() |
| 105 | + kq = select.kqueue() |
| 106 | + |
| 107 | + # Register a read event - O(1) average |
| 108 | + kev = select.kevent(right, filter=select.KQ_FILTER_READ, flags=select.KQ_EV_ADD) |
| 109 | + kq.control([kev], 0, 0) |
| 110 | + |
| 111 | + left.sendall(b"kq") |
| 112 | + |
| 113 | + # Wait for events - O(m + k) where m = changelist length |
| 114 | + events = kq.control([], 1, 1.0) |
| 115 | + if events: |
| 116 | + print(right.recv(4096)) # b'kq' |
| 117 | + |
| 118 | + kq.close() |
| 119 | + left.close() |
| 120 | + right.close() |
| 121 | +``` |
| 122 | + |
| 123 | +## Notes and Best Practices |
| 124 | + |
| 125 | +!!! warning "select() scalability limits" |
| 126 | + `select.select()` must scan all fds each call and may be limited by the |
| 127 | + platform's FD set size. For large numbers of connections, prefer `selectors` |
| 128 | + or an `epoll`/`kqueue`-based approach. |
| 129 | + |
| 130 | +## Related Modules |
| 131 | + |
| 132 | +- [selectors Module](selectors.md) |
| 133 | +- [socket Module](socket.md) |
| 134 | +- [asyncio Module](asyncio.md) |
0 commit comments