pytest-fold 0.7.3

Fold console output and drop user into interactive text user interface

pytest-fold

A Pytest plugin to make console output more manageable

...using Asciimatics TUI (default):

https://user-images.githubusercontent.com/4308435/152653413-acba6882-e930-4d61-ba9c-032bedefe508.mp4

...using Textual TUI (Mac only):

https://user-images.githubusercontent.com/4308435/154608486-19b8c931-45c9-4c00-991f-f3a7274d0925.mov

Introduction

Do you run long Pytest campaigns and get lots of failures? And then spend the next 15 minutes scrolling back in your console to find the one traceback that you're interested in drilling down into? Well, maybe pytest-fold can help. pytest-fold is a simple plugin that captures the output from your test runs, and redirects it into an interactive Text User Interface (TUI), where all your failed tests are "folded up" by default, showing only their titles and their status. Simply click on any test title to open it up and show its traceback information.

Features

• ANSI text markup support - whatever the output on your console looks like is how things are going to show up in the TUI
• Mouse and keyboard support (including scrolling in the Textual TUI)
• Support for FAILURES & ERRORS sections, as well as initial "test session starts", 'warnings summary', 'short test summary info' sections
• Support for all output formats/modes:
  • -v, -vv, -no-header, --showlocals, --color=<yes|no|auto>
  • all variants of --tb except "native"
• Support for other, simple output-manipulating plugins:
  • pytest-clarity
• Not supported: plugins that completely take over the console:
  • pytest-sugar

Requirements

• Works on Mac, Linux, Windows (using Asciimatics TUI); and Mac (using Textual TUI)
• Requires Pytest >= 6.2.5

Installation

pip install pytest-fold

Usage

From top-level directory:

• pytest --fold [--fold-tui asciimatics|textual] <other-pytest-options>

To quit the Ascimatics TUI, either click the Quit button, or press Ctrl-X. To quit the Textual TUI, either click the Quit button, or press Q.

Known Limitations / Issues

• pytest-fold does not display passed tests (that's not really the use case).
• Rudimentary user interfaces; both need a lot of love.
• Not fully tested with all combinations of output formats. Probably some use-cases where things won't work right.
• ERROR output sections are treated just like FAILURES sections. It is assumed that the tester will want to see full text output from pytest when their tests cause an error to be asserted.
• pytest-fold does not mark stderr or stdout sections for folding. It is assumed that the tester is interested in seeing such output.
• pytest-fold is currently incompatible with --tb=native and will cause an INTERNALERROR if run together. (TODO: Fix this.)
• pytest-fold may crash in the Asciimatics TUI if the console is resized.

Contributing

Contributions are very welcome. Please run pyflakes and black on your code before submitting a PR (at some point I will implement pre-commit in this project).

License

Distributed under the terms of the MIT_ license, "pytest-fold" is free and open source software.

Issues

If you encounter any problems, have feedback or requests, or anything else, please file an issue, along with a detailed description.