Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion Lib/imaplib.py
Original file line number Diff line number Diff line change
Expand Up @@ -1986,13 +1986,20 @@ def _pop(self, timeout, default=('', None)):
if __debug__ and imap.debug >= 4:
imap._mesg(f'idle _pop({timeout}) reading')

deadline = None
if timeout is not None:
if timeout <= 0:
return default
timeout = float(timeout) # Required by socket.settimeout()
deadline = time.monotonic() + timeout

try:
imap._get_response(timeout) # Reads line, calls _append_untagged()
while not imap._idle_responses:
if deadline is not None:
timeout = deadline - time.monotonic()
if timeout <= 0:
return default
imap._get_response(timeout) # Reads line, calls _append_untagged()
except IMAP4._responsetimeout:
if __debug__ and imap.debug >= 4:
imap._mesg(f'idle _pop({timeout}) done')
Expand Down
46 changes: 46 additions & 0 deletions Lib/test/test_imaplib.py
Original file line number Diff line number Diff line change
Expand Up @@ -938,6 +938,52 @@ def test_idle_denied(self):
with client.idle() as idler:
pass

def test_idle_tagged_response(self):
# An earlier command's tagged response may arrive during IDLE.
class IdleTaggedHandler(SimpleIMAPHandler):
capabilities = 'IDLE'

def cmd_NOOP(self, tag, args):
self.noop_tag = tag

def cmd_IDLE(self, tag, args):
self._send_textline('+ idling')
self._send_tagged(self.noop_tag, 'OK', 'NOOP completed')
self._send_line(b'* 1 EXISTS')
r = yield
if r == b'DONE\r\n':
self._send_tagged(tag, 'OK', 'Idle completed')
else:
self._send_tagged(tag, 'BAD', 'Expected DONE')
client, _ = self._setup(IdleTaggedHandler)
client.login('user', 'pass')
noop_tag = client._command('NOOP')
with client.idle() as idler:
self.assertEqual(next(idler), ('EXISTS', [b'1']))
self.assertEqual(client._get_tagged_response(noop_tag),
('OK', [b'NOOP completed']))

def test_idle_pop_timeout_after_tagged_response(self):
class FakeIMAP:
def __init__(self):
self.state = 'IDLING'
self.debug = 0
self._idle_responses = []
self.timeouts = []

def _get_response(self, timeout):
self.timeouts.append(timeout)

imap = FakeIMAP()
idler = imaplib.Idler.__new__(imaplib.Idler)
idler._imap = imap
with mock.patch.object(imaplib.time, 'monotonic',
side_effect=(0, 0.06, 0.1)):
response = idler._pop(0.1)
self.assertEqual(response, ('', None))
self.assertEqual(len(imap.timeouts), 1)
self.assertAlmostEqual(imap.timeouts[0], 0.04)

def test_idle_iter(self):
client, _ = self._setup(IdleCmdHandler)
client.login('user', 'pass')
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix :exc:`IndexError` in :mod:`imaplib` IDLE iteration when a tagged
response for an earlier command arrives before an untagged response.
Loading