Set timed_out attrib on reports for logging customization

README.rst

@@ -215,6 +215,40 @@ 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``).
+Remark: If a ``report`` has the ``timed_out`` attribute, it can have three
+values: ``True`` or ``False`` if the test ran and a timeout appeared or did
+not appear. If the value is ``None``, the item might have been run with
+timeout being disabled or something unexpected has happened. This way all
+checks are reliable, and ``report.timed_out`` still works, because
+``bool(None)`` is ``False``.
+
+
 Changelog
 =========
 

pytest_timeout.py

@@ -99,6 +99,7 @@ def pytest_runtest_protocol(item):
     teardown, then this hook installs the timeout.  Otherwise
     pytest_runtest_call is used.
     """
+    item.pytest_timeout__timed_out = None
     func_only = get_func_only_setting(item)
     if func_only is False:
         timeout_setup(item)
@@ -136,6 +137,20 @@ 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()
+    report.timed_out = getattr(item, "pytest_timeout__timed_out", None)
+
+
 @pytest.hookimpl(tryfirst=True)
 def pytest_exception_interact(node):
     """Stop the timeout when pytest enters pdb in post-mortem mode."""
@@ -227,6 +242,7 @@ def timeout_teardown(item):
     cancel = getattr(item, "cancel_timeout", None)
     if cancel:
         cancel()
+    item.pytest_timeout__timed_out = False
 
 
 def get_env_settings(config):
@@ -366,6 +382,7 @@ def timeout_sigalrm(item, timeout):
     if is_debugging():
         return
     __tracebackhide__ = True
+    item.pytest_timeout__timed_out = True
     nthreads = len(threading.enumerate())
     if nthreads > 1:
         write_title("Timeout", sep="+")
@@ -383,6 +400,7 @@ def timeout_timer(item, timeout):
     """
     if is_debugging():
         return
+    item.pytest_timeout__timed_out = True  # for consistency
     try:
         capman = item.config.pluginmanager.getplugin("capturemanager")
         if capman:

test_pytest_timeout.py

@@ -482,3 +482,36 @@ def custom_trace(*args):
     module.custom_trace = custom_trace
 
     assert pytest_timeout.is_debugging(custom_trace)
+
+
+def test_logging_customization(testdir):
+    testdir.makepyfile(
+        conftest="""
+        import pytest
+
+        @pytest.hookimpl(hookwrapper=True)
+        def pytest_runtest_makereport(item, call):
+            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
+            assert bool(getattr(report, "timed_out", None)) == timed_out
+    """
+    )
+    testdir.makepyfile(
+        """
+        import time
+
+        def test_times_out():
+            time.sleep(2)
+
+        def test_does_not_time_out():
+            time.sleep(0.1)
+    """
+    )
+    testdir.runpytest("--timeout=1", "-ss")