Rooba
/
mitogen
mirror of https://github.com/mitogen-hq/mitogen.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

select: add missing get(block=..) parameter.

This commit is contained in:
David Wilson 2018-05-25 00:26:21 +01:00
parent ddf28987a0
commit 4bf3d01104
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api.rst
View File

@ -151,7 +151,7 @@ contexts.
Result processing happens concurrently to new results arriving, so Result processing happens concurrently to new results arriving, so
:py:meth:`all` should always be faster. :py:meth:`all` should always be faster.
.. py:method:: get (timeout=None) .. py:method:: get (timeout=None, block=True)
Fetch the next available value from any receiver, or raise Fetch the next available value from any receiver, or raise
:py:class:`mitogen.core.TimeoutError` if no value is available within :py:class:`mitogen.core.TimeoutError` if no value is available within
@ -162,7 +162,9 @@ contexts.
:param float timeout: :param float timeout:
Timeout in seconds. Timeout in seconds.
:param bool block:
If :py:data:`False`, immediately raise
:py:class:`mitogen.core.TimeoutError` if the select is empty.
:return: :return:
:py:class:`mitogen.core.Message` :py:class:`mitogen.core.Message`
:raises mitogen.core.TimeoutError: :raises mitogen.core.TimeoutError:

4
mitogen/select.py
View File

@ -113,12 +113,12 @@ class Select(object):
empty_msg = 'Cannot get(), Select instance is empty' empty_msg = 'Cannot get(), Select instance is empty'
def get(self, timeout=None): def get(self, timeout=None, block=True):
if not self._receivers: if not self._receivers:
raise Error(self.empty_msg) raise Error(self.empty_msg)
while True: while True:
recv = self._latch.get(timeout=timeout) recv = self._latch.get(timeout=timeout, block=block)
try: try:
msg = recv.get(block=False) msg = recv.get(block=False)
if self._oneshot: if self._oneshot: