pytest
pytest copied to clipboard
Documentation Inaccuracy: faulthandler_timeout Seems to Work on Windows (pytest 8.3.5)
I noticed a possible inaccuracy in the documentation on this page:
The documentation states:
"Also the faulthandler_timeout=X configuration option can be used to dump the traceback of all threads if a test takes longer than X seconds to finish (not available on Windows)."
However, I tested this option on Windows 10 using pytest version 8.3.5, and it appears to work as expected—the tracebacks are indeed dumped when a test exceeds the timeout.
Could this line in the documentation be outdated or incorrect? Just wanted to bring it to your attention in case it needs updating.
This is quite interesting actually! The check was originally introduced back in 2015 targetting Windows, and then adjusted to do feature checking.
The feature checking was then dropped when integrating pytest-faulthandler into the core, and the warning you point out was partially removed.
Given that the note was removed in one location, I think it's only fair to remove it from the docs too. @Iwithyou2025 do you want to open a PR doing so?
Hi! Thanks for the clarification and context.
Sure, I’d be happy to open a PR to remove the outdated note from the docs. I’ll get on it soon!