typehints/stdlib/select.pyi [17:116]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - __author__ = "Howard C Lovatt" __copyright__ = "Howard C Lovatt, 2020 onwards." __license__ = "MIT https://opensource.org/licenses/MIT (as used by MicroPython)." __version__ = "7.3.0" # Version set by https://github.com/hlovatt/tag2ver from typing import Iterable, Any, Final, Iterator from uio import IOBase POLLIN: Final[int] = ... """Data available for reading.""" POLLOUT: Final[int] = ... """More data can be written.""" POLLHUP: Final[int] = ... """Socket is no longer connected.""" POLLERR: Final[int] = ... """Socket got an asynchronous error.""" def poll() -> "Poll": """ Create an instance of the Poll class. """ def select( rlist: Iterable[Any], wlist: Iterable[Any], xlist: Iterable[Any], timeout: int = -1, /, ) -> list[tuple[Any, int, Any, ...]]: """ Wait for activity on a set of objects. This function is provided by some MicroPython ports for compatibility and is not efficient. Usage of :class:`Poll` is recommended instead. """ class Poll: """ The name, `Poll`, used for typing is not the same as the runtime name, `poll` (note lowercase `p`). The reason for this difference is that the runtime uses `poll` as both a class name and as a method name and this is not possible within code written entirely in Python and therefore not possible within typing code. """ def register(self, obj: IOBase, eventmask: int = POLLIN | POLLOUT, /) -> None: """ Register `stream` *obj* for polling. *eventmask* is logical OR of: * ``select.POLLIN`` - data available for reading * ``select.POLLOUT`` - more data can be written Note that flags like ``select.POLLHUP`` and ``select.POLLERR`` are *not* valid as input eventmask (these are unsolicited events which will be returned from `poll()` regardless of whether they are asked for). This semantics is per POSIX. *eventmask* defaults to ``select.POLLIN | select.POLLOUT``. It is OK to call this function multiple times for the same *obj*. Successive calls will update *obj*'s eventmask to the value of *eventmask* (i.e. will behave as `modify()`). """ def unregister(self, obj: IOBase, /) -> None: """ Unregister *obj* from polling. """ def modify(self, obj: IOBase, eventmask: int, /) -> None: """ Modify the *eventmask* for *obj*. If *obj* is not registered, `OSError` is raised with error of ENOENT. """ def poll(self, timeout: int = -1, /) -> list[tuple[Any, int, Any, ...]]: """ Wait for at least one of the registered objects to become ready or have an exceptional condition, with optional timeout in milliseconds (if *timeout* arg is not specified or -1, there is no timeout). Returns list of (``obj``, ``event``, ...) tuples. There may be other elements in tuple, depending on a platform and version, so don't assume that its size is 2. The ``event`` element specifies which events happened with a stream and is a combination of ``select.POLL*`` constants described above. Note that flags ``select.POLLHUP`` and ``select.POLLERR`` can be returned at any time (even if were not asked for), and must be acted on accordingly (the corresponding stream unregistered from poll and likely closed), because otherwise all further invocations of `poll()` may return immediately with these flags set for this stream again. In case of timeout, an empty list is returned. .. admonition:: Difference to CPython :class: attention Tuples returned may contain more than 2 elements as described above. """ def ipoll( self, timeout: int = -1, flags: int = 0, / ) -> Iterator[tuple[Any, int, Any, ...]]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - typehints/stdlib/uselect.pyi [17:116]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - __author__ = "Howard C Lovatt" __copyright__ = "Howard C Lovatt, 2020 onwards." __license__ = "MIT https://opensource.org/licenses/MIT (as used by MicroPython)." __version__ = "7.3.0" # Version set by https://github.com/hlovatt/tag2ver from typing import Iterable, Any, Final, Iterator from uio import IOBase POLLIN: Final[int] = ... """Data available for reading.""" POLLOUT: Final[int] = ... """More data can be written.""" POLLHUP: Final[int] = ... """Socket is no longer connected.""" POLLERR: Final[int] = ... """Socket got an asynchronous error.""" def poll() -> "Poll": """ Create an instance of the Poll class. """ def select( rlist: Iterable[Any], wlist: Iterable[Any], xlist: Iterable[Any], timeout: int = -1, /, ) -> list[tuple[Any, int, Any, ...]]: """ Wait for activity on a set of objects. This function is provided by some MicroPython ports for compatibility and is not efficient. Usage of :class:`Poll` is recommended instead. """ class Poll: """ The name, `Poll`, used for typing is not the same as the runtime name, `poll` (note lowercase `p`). The reason for this difference is that the runtime uses `poll` as both a class name and as a method name and this is not possible within code written entirely in Python and therefore not possible within typing code. """ def register(self, obj: IOBase, eventmask: int = POLLIN | POLLOUT, /) -> None: """ Register `stream` *obj* for polling. *eventmask* is logical OR of: * ``select.POLLIN`` - data available for reading * ``select.POLLOUT`` - more data can be written Note that flags like ``select.POLLHUP`` and ``select.POLLERR`` are *not* valid as input eventmask (these are unsolicited events which will be returned from `poll()` regardless of whether they are asked for). This semantics is per POSIX. *eventmask* defaults to ``select.POLLIN | select.POLLOUT``. It is OK to call this function multiple times for the same *obj*. Successive calls will update *obj*'s eventmask to the value of *eventmask* (i.e. will behave as `modify()`). """ def unregister(self, obj: IOBase, /) -> None: """ Unregister *obj* from polling. """ def modify(self, obj: IOBase, eventmask: int, /) -> None: """ Modify the *eventmask* for *obj*. If *obj* is not registered, `OSError` is raised with error of ENOENT. """ def poll(self, timeout: int = -1, /) -> list[tuple[Any, int, Any, ...]]: """ Wait for at least one of the registered objects to become ready or have an exceptional condition, with optional timeout in milliseconds (if *timeout* arg is not specified or -1, there is no timeout). Returns list of (``obj``, ``event``, ...) tuples. There may be other elements in tuple, depending on a platform and version, so don't assume that its size is 2. The ``event`` element specifies which events happened with a stream and is a combination of ``select.POLL*`` constants described above. Note that flags ``select.POLLHUP`` and ``select.POLLERR`` can be returned at any time (even if were not asked for), and must be acted on accordingly (the corresponding stream unregistered from poll and likely closed), because otherwise all further invocations of `poll()` may return immediately with these flags set for this stream again. In case of timeout, an empty list is returned. .. admonition:: Difference to CPython :class: attention Tuples returned may contain more than 2 elements as described above. """ def ipoll( self, timeout: int = -1, flags: int = 0, / ) -> Iterator[tuple[Any, int, Any, ...]]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -