|
| 1 | +"""selectors - CPython compatible selectors module for MicroPython |
| 2 | +
|
| 3 | +Thin layer over MicroPython's select.poll(), usable like the CPython module: |
| 4 | +
|
| 5 | + import selectors |
| 6 | + sel = selectors.DefaultSelector() |
| 7 | + sel.register(sock, selectors.EVENT_READ, data) |
| 8 | + for key, mask in sel.select(timeout): |
| 9 | + ... |
| 10 | +
|
| 11 | +Differences from CPython: |
| 12 | +- objects are keyed by identity, not by file descriptor (bare-metal |
| 13 | + sockets have no fileno()); SelectorKey.fd is fileno() when available, |
| 14 | + else -1 |
| 15 | +- get_map() returns a plain dict keyed by file object (treat it as |
| 16 | + read-only) |
| 17 | +- only PollSelector is provided, DefaultSelector is an alias for it |
| 18 | +
|
| 19 | +MIT license; Copyright (c) 2026 Pavel Revak <pavelrevak@gmail.com> |
| 20 | +""" |
| 21 | + |
| 22 | +import select as _select |
| 23 | +from collections import namedtuple as _namedtuple |
| 24 | + |
| 25 | +EVENT_READ = 1 << 0 |
| 26 | +EVENT_WRITE = 1 << 1 |
| 27 | + |
| 28 | +_EVENTS_ALL = EVENT_READ | EVENT_WRITE |
| 29 | +_POLLIN = _select.POLLIN |
| 30 | +_POLLOUT = _select.POLLOUT |
| 31 | + |
| 32 | +SelectorKey = _namedtuple("SelectorKey", ["fileobj", "fd", "events", "data"]) |
| 33 | + |
| 34 | + |
| 35 | +def _fileobj_to_fd(fileobj): |
| 36 | + """Return the file descriptor of fileobj, -1 if it has none""" |
| 37 | + if isinstance(fileobj, int): |
| 38 | + fd = fileobj |
| 39 | + else: |
| 40 | + try: |
| 41 | + fd = int(fileobj.fileno()) |
| 42 | + except (AttributeError, TypeError, ValueError, OSError): |
| 43 | + return -1 |
| 44 | + if fd < 0: |
| 45 | + raise ValueError("Invalid file descriptor: %d" % fd) |
| 46 | + return fd |
| 47 | + |
| 48 | + |
| 49 | +def _check_events(events): |
| 50 | + if not events or events & ~_EVENTS_ALL: |
| 51 | + raise ValueError("Invalid events: %r" % (events,)) |
| 52 | + |
| 53 | + |
| 54 | +def _poll_mask(events): |
| 55 | + mask = 0 |
| 56 | + if events & EVENT_READ: |
| 57 | + mask |= _POLLIN |
| 58 | + if events & EVENT_WRITE: |
| 59 | + mask |= _POLLOUT |
| 60 | + return mask |
| 61 | + |
| 62 | + |
| 63 | +class BaseSelector: |
| 64 | + """Selector abstract base class""" |
| 65 | + |
| 66 | + def register(self, fileobj, events, data=None): |
| 67 | + raise NotImplementedError |
| 68 | + |
| 69 | + def unregister(self, fileobj): |
| 70 | + raise NotImplementedError |
| 71 | + |
| 72 | + def modify(self, fileobj, events, data=None): |
| 73 | + self.unregister(fileobj) |
| 74 | + return self.register(fileobj, events, data) |
| 75 | + |
| 76 | + def select(self, timeout=None): |
| 77 | + raise NotImplementedError |
| 78 | + |
| 79 | + def close(self): |
| 80 | + pass |
| 81 | + |
| 82 | + def get_map(self): |
| 83 | + raise NotImplementedError |
| 84 | + |
| 85 | + def get_key(self, fileobj): |
| 86 | + """Return the key registered for fileobj. |
| 87 | +
|
| 88 | + Raises KeyError if not registered, RuntimeError if closed. |
| 89 | + """ |
| 90 | + mapping = self.get_map() |
| 91 | + if mapping is None: |
| 92 | + raise RuntimeError("Selector is closed") |
| 93 | + if fileobj not in mapping: |
| 94 | + raise KeyError("%r is not registered" % (fileobj,)) |
| 95 | + return mapping[fileobj] |
| 96 | + |
| 97 | + def __enter__(self): |
| 98 | + return self |
| 99 | + |
| 100 | + def __exit__(self, *args): |
| 101 | + self.close() |
| 102 | + |
| 103 | + |
| 104 | +class PollSelector(BaseSelector): |
| 105 | + """Selector based on MicroPython select.poll()""" |
| 106 | + |
| 107 | + def __init__(self): |
| 108 | + self._poll = _select.poll() |
| 109 | + self._map = {} |
| 110 | + |
| 111 | + def _lookup(self, fileobj): |
| 112 | + if self._map is None or fileobj not in self._map: |
| 113 | + raise KeyError("%r is not registered" % (fileobj,)) |
| 114 | + return self._map[fileobj] |
| 115 | + |
| 116 | + def register(self, fileobj, events, data=None): |
| 117 | + if self._map is None: |
| 118 | + raise ValueError("Selector is closed") |
| 119 | + _check_events(events) |
| 120 | + if fileobj in self._map: |
| 121 | + raise KeyError("%r is already registered" % (fileobj,)) |
| 122 | + key = SelectorKey(fileobj, _fileobj_to_fd(fileobj), events, data) |
| 123 | + try: |
| 124 | + self._poll.register(fileobj, _poll_mask(events)) |
| 125 | + except (TypeError, OSError): # not a stream object |
| 126 | + # no chaining: MicroPython warns on 'raise ... from' |
| 127 | + raise ValueError("Invalid file object: %r" % (fileobj,)) |
| 128 | + self._map[fileobj] = key |
| 129 | + return key |
| 130 | + |
| 131 | + def unregister(self, fileobj): |
| 132 | + key = self._lookup(fileobj) |
| 133 | + del self._map[fileobj] |
| 134 | + try: |
| 135 | + self._poll.unregister(fileobj) |
| 136 | + except OSError: |
| 137 | + pass # object may already be closed |
| 138 | + return key |
| 139 | + |
| 140 | + def modify(self, fileobj, events, data=None): |
| 141 | + key = self._lookup(fileobj) |
| 142 | + _check_events(events) |
| 143 | + if events != key.events: |
| 144 | + self._poll.modify(fileobj, _poll_mask(events)) |
| 145 | + elif data is key.data: |
| 146 | + return key |
| 147 | + key = SelectorKey(fileobj, key.fd, events, data) |
| 148 | + self._map[fileobj] = key |
| 149 | + return key |
| 150 | + |
| 151 | + def select(self, timeout=None): |
| 152 | + """Wait for registered objects to become ready or timeout expire. |
| 153 | +
|
| 154 | + timeout: None blocks, <= 0 polls, else seconds (float allowed). |
| 155 | + Returns a list of (key, events) tuples. |
| 156 | + """ |
| 157 | + if self._map is None: |
| 158 | + raise ValueError("Selector is closed") |
| 159 | + if timeout is None: |
| 160 | + timeout_ms = -1 |
| 161 | + elif timeout <= 0: |
| 162 | + timeout_ms = 0 |
| 163 | + else: |
| 164 | + # round up, so a short timeout does not turn into a busy poll |
| 165 | + timeout_ms = int(timeout * 1000) |
| 166 | + if timeout_ms < timeout * 1000: |
| 167 | + timeout_ms += 1 |
| 168 | + ready = [] |
| 169 | + for fileobj, revents in self._poll.ipoll(timeout_ms): |
| 170 | + key = self._map.get(fileobj) |
| 171 | + if key is None: |
| 172 | + continue |
| 173 | + # error/hangup flags wake both directions, like CPython |
| 174 | + events = 0 |
| 175 | + if revents & ~_POLLIN: |
| 176 | + events |= EVENT_WRITE |
| 177 | + if revents & ~_POLLOUT: |
| 178 | + events |= EVENT_READ |
| 179 | + ready.append((key, events & key.events)) |
| 180 | + return ready |
| 181 | + |
| 182 | + def close(self): |
| 183 | + self._map = None |
| 184 | + self._poll = None |
| 185 | + |
| 186 | + def get_map(self): |
| 187 | + return self._map |
| 188 | + |
| 189 | + |
| 190 | +DefaultSelector = PollSelector |
0 commit comments