Add missing event hook parameter documentation#3344
Merged
cyberw merged 1 commit intolocustio:masterfrom Feb 9, 2026
Merged
Conversation
Document the keyword arguments for test_start, test_stopping, test_stop, and cpu_warning event hooks. Also add the missing "Event arguments:" header to worker_connect. Fixes locustio#3338 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
|
Nice! |
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
2 participants
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
environmentparameter documentation totest_start,test_stopping,test_stop, andcpu_warningevent hookscpu_usageparameter documentation to thecpu_warningevent hookworker_connectfor consistency with other documented hooksFixes #3338
Details
Several event hooks in
locust/event.pywere missing their keyword argument documentation, which caused confusion for users (e.g., thetest_stophandler expectingenvironmentbut the docs not mentioning it). This PR documents the parameters by cross-referencing the actualfire()calls inrunners.py,web.py, anddebug.py.Events updated:
test_startenvironmenttest_stoppingenvironmenttest_stopenvironmentcpu_warningenvironment,cpu_usageworker_connectTest plan
ast.parse()🤖 Generated with Claude Code