Perfsephone is a pytest plugin that profiles tests running under pytest, whose results can be visualized using the perfetto UI, or chrome's builtin trace visualizer about:tracing.
Perfsephone integrates well with CI/CD pipelines by generating json files which may be consumed at a later time.
A perfsephone generated trace file of FastAPI's test suite, visualized using ui.perfetto.dev
pip install git+https://github.com/lucamuscat/perfsephone.gitIn order to generate a trace using perfsephone, add the --perfetto=<FILE PATH> flag to your pytest
invocation:
pytest --perfetto=./trace.json
Although profiling tools for python already exist, they either:
- Do not integrate well with pytest, leaving out essential data, such as time spent in test setup, test teardown, and collection time;
- Generate too much cruft. Perfsephone filters out call stacks related to pytest internals, which cannot be optimized without optimizing pytest itself.
Perfsephone's dependencies is managed using poetry.
In order to run the project's unit tests & linting suite, run the following command:
poetry run tox -p