Adding Python Django test docs #7516
Merged
Conversation
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
Member
eleanorjboyd
left a comment
eleanorjboyd
left a comment
There was a problem hiding this comment.
looks great thank you! Added few comments
docs/python/testing.md
Outdated
| - Create a file named `.env` at the root of your project. | ||
| - Add `MANAGE_PY_PATH='path-string-to-manange.py-path'` to the `.env` file, replacing `path-string-to-manange.py-path` with the path to your application's `manage.py` file (Note: you can copy the path by right clicking on the file and selecting **Copy Path**). | ||
| - Add the following to your `settings.json` file `"python.envFile": "${workspaceFolder}/.env”` to incorporate this file in your environment (edit path as necessary if `.env` is not at root). | ||
|
|
Member
There was a problem hiding this comment.
some users have run into the problem that we populate python.testing.unittestArgs if they go through the UI setup flow right now and these args don't work for Django. Could we add somewhere to edit that variable to remove args and add any Django necessary args
Member
Author
There was a problem hiding this comment.
Moved this reminder up to the steps
docs/python/testing.md
Outdated
| In the case your tests are not discovered, try the following troubleshooting steps: | ||
|
|
||
| - Add `"python.testing.unittestArgs": []` in `settings.json` | ||
| - Look at the Python Output Panel for any error messages that may have triggered. |
Member
There was a problem hiding this comment.
do we want to remind people how to change logging verbosity or is that elsewhere in our docs?
cwebster-99
commented
Aug 20, 2024
cwebster-99
commented
Aug 20, 2024
cwebster-99
commented
Aug 20, 2024
cwebster-99
commented
Aug 20, 2024
luabud
reviewed
Aug 20, 2024
luabud
reviewed
Aug 20, 2024
luabud
reviewed
Aug 20, 2024
luabud
reviewed
Aug 20, 2024
Co-authored-by: Luciana Abud <45497113+luabud@users.noreply.github.com>
luabud
reviewed
Aug 20, 2024
luabud
reviewed
Aug 27, 2024
luabud
reviewed
Aug 27, 2024
ntrogh
requested changes
Aug 27, 2024
Contributor
ntrogh
left a comment
ntrogh
left a comment
There was a problem hiding this comment.
Added some minor text suggestions.
Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com>
ntrogh
requested changes
Aug 29, 2024
Contributor
ntrogh
left a comment
ntrogh
left a comment
There was a problem hiding this comment.
Looking good! I added a few final text suggestions.
Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com>
cwebster-99
commented
Sep 4, 2024
docs/python/testing.md
Outdated
| > **Tip**: you can copy the path by right clicking on the file in the Explorer view and selecting **Copy Path**. | ||
| 4. Add Django test arguments to `"python.testing.unittestArgs": []` in the `settings.json` [file](/docs/getstarted/settings.md#settingsjson) as needed, and remove any arguments that are not compatible with Django. | ||
|
|
||
| > **Note**: By default, the Python extension looks for and loads `.env` files at the project root. If your `.env` file is not at the project root or you are using [VS Code variable substitution](https://code.visualstudio.com/docs/editor/variables-reference), add `"python.envFile": "${workspaceFolder}/<path-to-.env>"` to your `settings.json` [file](/docs/getstarted/settings.md#settingsjson), so the Python extension can load the environment variables in this file when running and discovering tests. See our [Python environment variables](https://code.visualstudio.com/docs/python/environments#_environment-variables) docs for more information on environment variables. |
Member
Author
There was a problem hiding this comment.
@luabud @ntrogh I moved this step to a note since this step is not needed to get it working by default. Please suggest edits as needed!
cc/ @eleanorjboyd
cwebster-99
commented
Sep 4, 2024
docs/python/testing.md
Outdated
| 1. Create a `.env` file at the root of your project. | ||
| 2. Add `MANAGE_PY_PATH='<path-to-manage.py>'` to the `.env` file, replacing `<path-to-manage.py>` with the path to your application's `manage.py` file. | ||
| > **Tip**: you can copy the path by right clicking on the file in the Explorer view and selecting **Copy Path**. | ||
| 4. Add Django test arguments to `"python.testing.unittestArgs": []` in the `settings.json` [file](/docs/getstarted/settings.md#settingsjson) as needed, and remove any arguments that are not compatible with Django. |
Member
Author
There was a problem hiding this comment.
Suggested change
| 4. Add Django test arguments to `"python.testing.unittestArgs": []` in the `settings.json` [file](/docs/getstarted/settings.md#settingsjson) as needed, and remove any arguments that are not compatible with Django. | |
| 3. Add Django test arguments to `"python.testing.unittestArgs": []` in the `settings.json` [file](/docs/getstarted/settings.md#settingsjson) as needed, and remove any arguments that are not compatible with Django. |
Member
Author
There was a problem hiding this comment.
Should this step be nested or represented top-level # 3
Contributor
There was a problem hiding this comment.
It should probably be top-level #3 because it is not part of setting that environment variable.
Contributor
|
@cwebster-99 merging this PR to make sure it's included in today's release. |
ntrogh
approved these changes
Sep 5, 2024
lszomoru
approved these changes
Sep 5, 2024
chrmarti
approved these changes
Sep 5, 2024
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.
Updating python/testing.md to include setup and troubleshooting for Django testing.