Introduce expired property (#16)

* Introduce expired property

* Update README

* Update CHANGES

Author: asvetlov

CHANGES.rst

@@ -7,6 +7,8 @@ CHANGES
 * Don't suppress nested exception on timeout. Exception context points
   on cancelled line with suspended `await` (#13)
 
+* Introduce `.timeout` property (#16)
+
 1.2.1 (2017-05-02)
 ------------------
 

README.rst

@@ -16,8 +16,8 @@ because ``timeout`` doesn't create a new task.
 The ``timeout(timeout, *, loop=None)`` call returns a context manager
 that cancels a block on *timeout* expiring::
 
-       with timeout(1.5):
-           yield from inner()
+   with timeout(1.5):
+       await inner()
 
 1. If ``inner()`` is executed faster than in ``1.5`` seconds nothing
    happens.
@@ -27,6 +27,20 @@ that cancels a block on *timeout* expiring::
 
 *timeout* parameter could be ``None`` for skipping timeout functionality.
 
+
+Context manager has ``.expired`` property for check if timeout happens
+exactly in context manager::
+
+   with timeout(1.5) as cm:
+       await inner()
+   print(cm.expired)
+
+The property is ``True`` is ``inner()`` execution is cancelled by
+timeout context manager.
+
+If ``inner()`` call explicitly raises ``TimeoutError`` ``cm.expired``
+is ``False``.
+
 Installation
 ------------
 

async_timeout/__init__.py

@@ -50,7 +50,12 @@ def __exit__(self, exc_type, exc_val, exc_tb):
         self._task = None
 
     def _cancel_task(self):
-        self._cancelled = self._task.cancel()
+        self._task.cancel()
+        self._cancelled = True
+
+    @property
+    def expired(self):
+        return self._cancelled
 
 
 def current_task(loop):

tests/test_timeout.py

@@ -199,8 +199,31 @@ def outer():
 
 @asyncio.coroutine
 def test_timeout_suppress_exception_chain(loop):
-
     with pytest.raises(asyncio.TimeoutError) as ctx:
         with timeout(0.01, loop=loop):
             yield from asyncio.sleep(10, loop=loop)
     assert not ctx.value.__suppress_context__
+
+
+@asyncio.coroutine
+def test_timeout_expired(loop):
+    with pytest.raises(asyncio.TimeoutError):
+        with timeout(0.01, loop=loop) as cm:
+            yield from asyncio.sleep(10, loop=loop)
+    assert cm.expired
+
+
+@asyncio.coroutine
+def test_timeout_inner_timeout_error(loop):
+    with pytest.raises(asyncio.TimeoutError):
+        with timeout(0.01, loop=loop) as cm:
+            raise asyncio.TimeoutError
+    assert not cm.expired
+
+
+@asyncio.coroutine
+def test_timeout_inner_other_error(loop):
+    with pytest.raises(RuntimeError):
+        with timeout(0.01, loop=loop) as cm:
+            raise RuntimeError
+    assert not cm.expired