Merge pull request #1422 from ajdavis/timeouts-not-deadlines

Timeouts not deadlines.
This commit is contained in:
Ben Darnell 2015-04-19 11:22:13 -04:00
commit 86a2cab291
2 changed files with 6 additions and 6 deletions

View File

@ -95,12 +95,12 @@ class Condition(_TimeoutGarbageCollector):
io_loop = ioloop.IOLoop.current()
# Wait up to 1 second for a notification.
yield condition.wait(deadline=io_loop.time() + 1)
yield condition.wait(timeout=io_loop.time() + 1)
...or a `datetime.timedelta` for a deadline relative to the current time::
...or a `datetime.timedelta` for a timeout relative to the current time::
# Wait up to 1 second.
yield condition.wait(deadline=datetime.timedelta(seconds=1))
yield condition.wait(timeout=datetime.timedelta(seconds=1))
The method raises `tornado.gen.TimeoutError` if there's no notification
before the deadline.
@ -433,13 +433,13 @@ class Lock(object):
self.__class__.__name__,
self._block)
def acquire(self, deadline=None):
def acquire(self, timeout=None):
"""Attempt to lock. Returns a Future.
Returns a Future, which raises `tornado.gen.TimeoutError` after a
timeout.
"""
return self._block.acquire(deadline)
return self._block.acquire(timeout)
def release(self):
"""Unlock.

View File

@ -448,7 +448,7 @@ class LockTests(AsyncTestCase):
lock = locks.Lock()
lock.acquire()
with self.assertRaises(gen.TimeoutError):
yield lock.acquire(deadline=timedelta(seconds=0.01))
yield lock.acquire(timeout=timedelta(seconds=0.01))
# Still locked.
self.assertFalse(lock.acquire().done())