Skip to content

Document waitUntil timeout parameter #672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jean2002mug wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Document waitUntil timeout parameter #672

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ed4200
docs: document waitUntil timeout parameter
Jean2002mug Oct 4, 2026
1d0a4ab
Apply suggestion from @nicoddemus
nicoddemus Oct 7, 2026
8421af7
Update docs/wait_until.rst
nicoddemus Oct 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/wait_until.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,10 @@ assertion:
def check_label():
assert window.status.text() == "Please input a number"

qtbot.waitUntil(check_label)
qtbot.waitUntil(check_label, timeout=2000)

The optional ``timeout`` parameter specifies how long to wait, in milliseconds,
before raising a timeout error (defaults to ``5000``).

``qtbot.waitUntil`` will periodically call ``check_label`` until it no longer raises
``AssertionError`` or a timeout is reached. If a timeout is reached, a
Expand All @@ -58,8 +60,8 @@ is raised from the last assertion error and the test will fail:
E - OK
E + Please input a number
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
> qtbot.waitUntil(check_label)
E pytestqt.exceptions.TimeoutError: waitUntil timed out in 1000 milliseconds
> qtbot.waitUntil(check_label, timeout=2000)
E pytestqt.exceptions.TimeoutError: waitUntil timed out in 2000 milliseconds


A second way to use ``qtbot.waitUntil`` is to pass a callback which returns ``True`` when the
Expand Down