Skip to content

Add some instructions for diagnosing slow test collection speeds #1055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 1 commit into from
Oct 27, 2025
Merged

Add some instructions for diagnosing slow test collection speeds #1055

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,17 @@ to find the tests for a specific module or function.

PRs should ideally include tests for any new features or bug fixes.

To diagnose slow test speeds, you can run

```shell
uv run pyinstrument -m pytest
```

With any `pytest` options you wish to include, e.g. `-k` to run specific tests, or
`--collect-only` to only profile test collection time. This will generate a CLI-friendly
report of where time is being spent. For an interactive HTML report, you can run
`pyinstrument` with the `-r=html` option before the `-m pytest` part.

## Documentation

Documentation is hosted at <https://usethis.readthedocs.io/en/stable/>. It can be served
Expand Down