doctest_tui

An ncurses TUI for running Python "doctests".

Note that this may work perfectly fine for some use cases, but it is still in an "alpha" state and has some bugs, mainly that it does not successfully import some files, for reasons I have not yet debugged.

See the screenshots below for a look at the UI, if the colour scheme isn't to your tastes, it just uses the same theme as your terminal, so no modifications are necessary.

A screenshot showing "diffed" output from a failed test. A screenshot showing tracebacks in a test that failed due to a raised error.

Usage

Ensure that you have python3 installed and on your path, then clone this repository, and place doctest_tui somewhere on your path somewhere on your path.

Then, to run it, use the following command:

doctest_tui module_with_doctests.py more_doctests.py

Note that you can specify as many files as you would like as arguments, with relative or absolute paths. If a path is not valid, doctest_tui will still run, but the path will be highlighted in red in the top left corner. If no valid paths are found in the arguments, then it will refuse to run and display help information instead.

Keymap

Key	Action
q	quit
Tab	focus next ui element
Shift + Tab	focus next ui element
h or ←	navigate left
j or ↓	navigate down
k or ↑	navigate up
l or →	navigate right
r	update tests

Contributing

Feel free to contribute in any way you'd like, there are two things I would suggest though:

• Try to stick to vi-like keybindings, as far as it is possible in order to match the current keymap.
• If the functionality you're adding is not something you think most people will use, consider hiding it behind a keyboard shortcut, or adding configuration options

Planned Improvements

• Debug failing imports.
• Add python_ta shortcut that pulls the configuration, max line length, allowed imports, etc. from the target file.
• Add horizontal and vertical scrolling for long doctests.
• Interactive debugging in the output window.
• pytest support?
• Improve data structure of Functions.results and Functions.names, and cut down on duplicate data.