Skip to content

Commit ec5da61

Browse files
authored
docs: clarify supported Python testing frameworks
Docs-only update to clarify which Python testing frameworks are supported by the extension and how unsupported frameworks (e.g. behave) currently behave. This helps set expectations for users and provides additional context for feature requests such as #25330.
1 parent 79035c8 commit ec5da61

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,32 @@ Learn more about the rich features of the Python extension:
9999
- [Environments](https://code.visualstudio.com/docs/python/environments): Automatically activate and switch between virtualenv, venv, pipenv, conda and pyenv environments.
100100
- [Refactoring](https://code.visualstudio.com/docs/python/editing#_refactoring): Restructure your Python code with variable extraction and method extraction. Additionally, there is componentized support to enable additional refactoring, such as import sorting, through extensions including [isort](https://marketplace.visualstudio.com/items?itemName=ms-python.isort) and [Ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff).
101101

102+
### Testing framework support
102103

104+
The Python extension provides built-in integration with the VS Code Test Explorer
105+
for the following Python testing frameworks:
106+
107+
- `unittest`
108+
- `pytest`
109+
110+
These frameworks are directly supported through dedicated test discovery,
111+
execution, and result reporting implementations.
112+
113+
#### Other testing frameworks (e.g. behave)
114+
115+
Additional testing frameworks such as `behave` (BDD / Gherkin-style testing)
116+
are not currently supported out of the box.
117+
118+
While these frameworks can still be executed manually via the terminal,
119+
they do not integrate with the VS Code Test Explorer at this time.
120+
121+
Supporting additional frameworks would require:
122+
- Implementing test discovery logic
123+
- Mapping results to the VS Code Testing API
124+
- Long-term maintenance and ownership
125+
126+
Community feedback helps prioritize which additional testing frameworks
127+
may be considered for future support.
103128

104129
## Supported locales
105130

0 commit comments

Comments
 (0)