Set timed_out attrib on reports for logging customization

In case the test timed out, set `report.timed_out = True`. That makes it
easier to customize the output in case of timeouts.
This commit also adds a small section to the README including a small
example.

Author: ep12

README.rst

@@ -215,6 +215,33 @@ debugging frameworks modules OR if pytest itself drops you into a pdb
 session using ```--pdb``` or similar.
 
 
+Logging Customization
+=====================
+
+This plugin sets a new ``timed_out`` attribute on report objects via
+the ``pytest_runtest_makereport`` hook. This way logging can be
+customized in your ``conftest.py`` by implementing
+``pytest_report_teststatus``::
+
+    @pytest.hookimpl(tryfirst=True)
+    def pytest_report_teststatus(report, **kwargs):
+        """Adapted from
+        https://github.com/pytest-dev/pytest/blob/38d8deb74d95077ebf189440ca047e14f8197da1/src/_pytest/runner.py#L202
+        """
+        d = "%.2f" % getattr(report, "duration", -1.0)
+        if report.passed:
+            return "passed", "P", "PASSED (%s)" % d
+        if getattr(report, "timed_out", False):
+            return "failed", "T", "TIMEOUT (%s)" % d
+        if report.failed:
+            return "failed", "F", "FAILED (%s)" % d
+        return None
+
+This will print ``T`` (or ``TIMEOUT (5.00)`` if verbose) in case a test
+times out. You might want to restrict this to the *call* phase because
+the above code would print three symbols (lines) per test; one for each of
+the three test phases *setup*, *call* and *teardown* (use ``report.when``).
+
 Changelog
 =========
 

pytest_timeout.py

@@ -136,6 +136,25 @@ def pytest_report_header(config):
         ]
 
 
+@pytest.hookimpl(hookwrapper=True)
+def pytest_runtest_makereport(item, call):
+    """Set report.timed_out after it is generated by pytest_runtest_makereport.
+
+    This method is a wrapper that sets timed_out if the call has a matching excinfo
+    value. Note that in that case report.failed and report.timed_out are true (both!).
+    """
+    r = yield
+    if not hasattr(r, "get_result"):
+        return
+    report = r.get_result()
+    timed_out = False
+    if hasattr(call.excinfo, "value"):
+        msg = getattr(call.excinfo.value, "msg", None)
+        if isinstance(msg, str) and msg.startswith("Timeout >"):
+            timed_out = True
+    report.timed_out = timed_out
+
+
 @pytest.hookimpl(tryfirst=True)
 def pytest_exception_interact(node):
     """Stop the timeout when pytest enters pdb in post-mortem mode."""