docs: clarify locust invocation norms #501
Merged
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
Push for the following norm: all module imports either reference installed modules, or modules beneath the "project root" (i.e. the CWD). To that end, remove any examples where the locustfile is not beneath the CWD. Also, provide some example project directory structures.
* fix formatting
cgoldberg
reviewed
Nov 9, 2016
| The locustfiles may import common libraries using, e.g. ``import commonlib_auth.py``. This approach does not | ||
| cleanly separate common libraries from locustfiles, however. | ||
|
|
||
| Subdirectories can be a cleaner approach, but locust cannot currenly cope with importing modules which live |
* clarify workaround with code snippet * fix typos * use double backticks correctly * consistently refer to "locust files" using two words
|
FYI, this new commit brings some typo fixes and other updates:
|
|
👍 |
|
@justiniso can you take a look? |
justiniso
reviewed
Dec 1, 2016
| The locustfiles may import common libraries using, e.g. ``import commonlib_auth``. This approach does not | ||
| cleanly separate common libraries from locust files, however. | ||
|
|
||
| Subdirectories can be a cleaner approach (see example below), but locust cannot currently cope with importing |
There was a problem hiding this comment.
but locust cannot currently cope with importing modules which live outside the locustfiles directory
I would make the problem statement more explicit:
but locust will only import modules relative to the directory in which the running locustfile is placed. If you wish to import from your the project root (i.e. the path of the location where you are running the locust command), make sure to .....
* clarify exactly why locust cannot cope with locustfiles in subdirectories which import libraries in a different subdirectories.
|
@justiniso see updated text |
|
Thanks! This now has two member approvals, please merge. |
|
bahhh i just realized i hadn't squashed :( so sorry... |
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.
this is an attempt to addresses #500
Push for the following norm: all module imports either reference
installed modules, or modules beneath the "project root" (i.e. the CWD).
To that end, remove any examples where the locustfile is not beneath the
CWD.
Also, provide some example project directory structures.