pytest
- Repo stars 2,412
- License NOASSERTION
- Author repo debugpy
- Domain
- Documentation
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 94 / 100 · heuristic scan, not runtime safety proof
- Runtime evidence
- Not run; no isolated runtime test evidence is currently recorded
- Author / version / license
- @microsoft · NOASSERTION
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No explicit requirements detected
- Detected file/system behavior
-
- Read-only
- Network behavior
- Local-only
- Install commands
- None (reference only)
Heads up: Tool permissions are not declared; actual access depends on the runtime.
# Skill: pytest
Best practices for writing and organizing tests with pytest including fixtures, parametrize, and plugins.
## When to Use
Apply this skill when writing and organizing tests with pytest — fixtures, parametrize, markers, plugins, and test structure.
## Test Organization
- Place tests in a `tests/` directory mirroring the source structure.
- Name test files `test_<module>.py` and test functions `test_<behavior>()`.
- Group related tests in classes only when they share fixtures/setup.
## Fixtures
- Define fixtures at the narrowest scope needed (`function` > `class` > `module` > `session`).
- Use `conftest.py` for shared fixtures; put it at the appropriate directory level.
- Prefer factory fixtures over complex fixture inheritance.
- Use `yield` fixtures for setup/teardown; prefer `tmp_path` over `tempfile`.
## Parametrize
- Use `@pytest.mark.parametrize` for data-driven tests with multiple inputs.
- Give test IDs (`ids=...`) for readable test output.
- Combine `parametrize` with fixtures for cross-product testing.
## Assertions
- Use plain `assert` statements — pytest rewrites them for clear failure messages.
- Use `pytest.raises(ExceptionType, match=...)` for exception testing.
- Use `pytest.approx()` for floating-point comparisons.
## Plugins
- Common plugins: `pytest-cov`, `pytest-mock`, `pytest-asyncio`, `pytest-xdist`, `pytest-timeout`.
- Use `pytest-mock`'s `mocker` fixture over raw `unittest.mock.patch`.
## Pitfalls
- Don't use `session`-scoped fixtures for mutable state.
- Don't assert on implementation details — test observable behavior.
- Avoid test interdependence; each test should be runnable in isolation.
Sections and files
Listed in source order.
sections -> When to Use → Test Organization → Fixtures → Parametrize → Assertions → Plugins
terms -> Best practices for writing and organizing tests with pytest including fixtures, parametrize, and plugins. · Apply this skill when writing and organizing tests with pytest — fixtures, parametrize, markers, plugins, and test structure. · - Place tests in a tests/ directory mirroring the source structure. · - Define fixtures at the narrowest scope needed (function > class > module > session). · - Use @pytest.mark.parametrize for data-driven tests with multiple inputs. · - Use plain assert statements — pytest rewrites them for clear failure messages. · - Common plugins: pytest-cov, pytest-mock, pytest-asyncio, pytest-xdist, pytest-timeout. · - Don't use session-scoped fixtures for mutable state.
files/cmd -> tests/ · test_<module>.py · test_<behavior>() · function · class · module · session · conftest.py
body sha256 -> b1c1f8e689f4
Test Organization
Place tests in a
tests/directory mirroring the source structure. Name test filestest_<module>.pyand test functionstest_<behavior>(). Group related tests in classes only when they share fixtures/setup.Fixtures
Define fixtures at the narrowest scope needed (
function>class>module>session). Useconftest.pyfor shared fixtures; put it at the appropriate directory level. Prefer factory fixtures over complex fixture inheritance. Useyieldfixtures for setup/teardown; prefertmp_pathovertempfile.Parametrize
Use
@pytest.mark.parametrizefor data-driven tests with multiple inputs. Give test IDs (ids=...) for readable test output. Combineparametrizewith fixtures for cross-product testing.Assertions
Use plain
assertstatements — pytest rewrites them for clear failure messages. Usepytest.raises(ExceptionType, match=...)for exception testing. Usepytest.approx()for floating-point comparisons.Plugins
Common plugins:
pytest-cov,pytest-mock,pytest-asyncio,pytest-xdist,pytest-timeout. Usepytest-mock'smockerfixture over rawunittest.mock.patch.