Prohibits the locustfile from being named 'locust.py' #546
Conversation
This file contains 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
justiniso
reviewed
Feb 20, 2017
| if not locustfile: | ||
| logger.error("Could not find any locustfile! Ensure file ends in '.py' and see --help for available options.") | ||
| sys.exit(1) | ||
|
|
||
| if locustfile == "locust.py": | ||
| logger.error("The locustfile must not be named `locust.py`. Please rename the file and try again.") |
There was a problem hiding this comment.
Error message could be more helpful with: Did you mean locustfile.py?
There was a problem hiding this comment.
@justiniso thanks!
however, the file can be named something else when you use the -f option. do you think your message implies it must be named locustfile.py?
There was a problem hiding this comment.
No I mean if someone is naming their file locust.py, seems like they don't have many locustfiles and are just looking for whatever "default" name works, in which case locustfile.py suits that need. But I guess it can be misinterpreted. Let's leave it then.
justiniso
approved these changes
Feb 20, 2017
AngelosTheodosiadis
pushed a commit
to datarobot/locust
that referenced
this pull request
Jan 15, 2020
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.
Fixes #138
This PR prohibits naming your locustfile
locust.py, which previously caused Locust to exit with a misleading message ("No Locust class found").The new behavior is to exit with a more helpful error message explaining not to name the file
locust.py.The issue was occuring because the locustfile gets imported as a Python module (with the .py extension removed). So naming it
locust.pycaused a namespace clash with the internallocustmodule, which would get re-imported instead of the locustfile.Note: This only fixes the common case where you have named it
locust.py. There are also other reserved names that can not be used as locustfile names. We might want to add something to the docs to explain this.