pytest-sugar
pytest-sugar is a pytest plugin that improves test output readability with progress bars, instant failure display, and better formatting. It automatically activates after installation and requires minimal configuration.
Key facts
Objective fields from the source. Values we can't verify are shown as “Unknown” rather than guessed.
| Field | Value |
|---|---|
| Repository | Teemu/pytest-sugar |
| Owner | Teemu |
| Primary language | Python |
| License | BSD-3-Clause — OSI-approved |
| Stars | 1.5k |
| Forks | 83 |
| Open issues | 33 |
| Latest release | v1.1.1 (2025-08-23) |
| Last updated | 2025-12-12 |
| Source | https://github.com/Teemu/pytest-sugar |
What pytest-sugar is
A Python pytest plugin that hooks into pytest's reporting system to provide real-time test failure display, progress visualization, and enhanced terminal output formatting. Supports Playwright trace file integration and requires Python 3.10+ with pytest 7+.
Get the pytest-sugar source
Clone the repository and explore it locally.
git clone https://github.com/Teemu/pytest-sugar.gitcd pytest-sugar# follow the project's README for install & configurationNeed it deployed, integrated, or customized instead? DEV.co ships production installs.
Best use cases
Implementation considerations
- Plugin auto-activates post-install; disable with '-p no:sugar' if conflicts occur with other reporting tools.
- Verify Playwright trace directory (--sugar-trace-dir) configuration if using Playwright; defaults to 'test-results'.
- Test on target OS before production; Windows may require charset/font adjustments to avoid display corruption.
- Check for output conflicts if using multiple pytest plugins that modify reporting (e.g., pytest-html, pytest-rich).
- No configuration file support mentioned; all behavior configured via CLI flags or pytest.ini options only.
When to avoid it — and what to weigh
- Strict log parsing required — If downstream tools parse pytest output programmatically, the enhanced formatting may break parsers expecting standard pytest output.
- Machine-readable test reporting is primary — pytest-sugar prioritizes human-readable output; if you need structured JSON/XML reports, use pytest's native reporting instead.
- Python < 3.10 or pytest < 7 — Project explicitly requires Python 3.10+ and pytest 7+; older versions are not supported.
- Minimal terminal dependencies required — Plugin adds dependencies for colorization and terminal rendering; minimalist projects may prefer standard pytest output.
License & commercial use
BSD-3-Clause license permits commercial use, modification, and distribution with attribution and liability disclaimer.
BSD-3-Clause is a permissive OSI license allowing commercial use without runtime fees. Ensure compliance with attribution requirements in derivative distributions.
DEV.co evaluation signals
Editorial assessment — not user reviews. Directional, with an explicit confidence level.
| Signal | Assessment |
|---|---|
| Maintenance | Active |
| Documentation | Adequate |
| License clarity | Clear |
| Deployment complexity | Low |
| DEV.co fit | Good |
| Assessment confidence | High |
Runs within pytest process; security impact limited to test environment. Reads local Playwright trace files and filesystem paths from CLI arguments. No authentication, remote calls, or data transmission mentioned. Standard Python dependency supply-chain review recommended.
Alternatives to consider
pytest-rich
Similar output enhancement using the Rich library; alternative formatting approach with different dependency footprint.
pytest-pretty
Another output formatter focused on readability; consider if Rich/pytest-rich architecture is preferred.
Standard pytest with --tb=short
Minimal alternative using pytest's built-in options; sufficient for basic failure visibility without plugin overhead.
Build on pytest-sugar with DEV.co software developers
pytest-sugar activates automatically after pip install. Run 'pytest' to see enhanced output with progress bars and instant failure feedback.
Talk to DEV.coRelated open-source tools
Surfaced by semantic similarity across the DEV.co open-source index.
Related on DEV.co
Explore the category and the services that help you build with it.
pytest-sugar FAQ
Does pytest-sugar work in CI/CD pipelines?
Can pytest-sugar be disabled per-run?
Does pytest-sugar support Python 3.9 or older?
How is Playwright trace integration used?
Software development & web development with DEV.co
Need help beyond evaluating pytest-sugar? DEV.co is a software development agency offering software development services and web development for teams of every size. Our software developers and web developers build custom software, web applications, APIs, and open-source testing integrations — and maintain them long-term.
Ready to improve test visibility?
pytest-sugar activates automatically after pip install. Run 'pytest' to see enhanced output with progress bars and instant failure feedback.