Improve Type Hinting for Wait Time Functions#3374
Merged
cyberw merged 5 commits intolocustio:masterfrom Mar 18, 2026
Merged
Conversation
- Annotates 'between', 'constant', and 'constant_pacing' - Adds Callable and User types to return signatures - Improves IDE autocompletion for wait_time configurations
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
✨ Summary
This PR enhances type safety across Locust's wait time utilities by introducing explicit type hints and resolving related issues flagged by Mypy.
🧠 What’s Included
1. Type Hint Improvements
Added precise type annotations to functions in:
locust/user/wait_time.pyEnsures better static analysis and developer experience when working with wait time utilities.
2. Circular Import Fixes
TYPE_CHECKING.3. Internal State Tracking Fix 🛠️
Introduced:
in:
locust/user/task.pylocust/user/users.pyThis mirrors the existing pattern:
Prevents Mypy errors when using
constant_pacingand similar wait strategies.4. Functional Improvement in
constant_pacingFully typed internal function:
Explicit tracking of:
_cp_last_run_cp_last_wait_time🧪 Validation
✅ All tests passed
✅ All checks passed
🔗 Workflow