assertEquals man page

assertEquals — an opinionated testing interface for Python


assertEquals [options] module


assertEquals is an interface for running tests written with the Python standard library's unittest module. It delivers summary and detail reports on TestCases discovered in module-space, via both a command-line and a curses(3) interface. The interactive mode is the default, but it depends on the non-interactive mode. For debugging, static tracebacks and interactive Python debugger (Pdb) sessions are available in both scripted and interactive modes.


Use the command-line interface. If not set, assertEquals will use the curses(3) interface.
assertEquals should find TestCases but not run them. This only obtains in scripted mode, for summary reports.
-x stopwords
--stopwords stopwords
stopwords is a comma-delimited list of strings that, if they appear in a module's full dotted name, will prevent that module from being included in the search for TestCases.
-t testcase
--testcase testcase
--TestCase testcase
assertEquals should only run the tests found in testcase, which is the name of a Python unittest.TestCase class within the module specified by module. Given this option, assertEquals will output a detail report for the named TestCase; without it, a summary report for all TestCases found at or below module. This option only obtains in scripted mode.

Scripted Mode

If the --testcase option is not given, assertEquals imports module, and then searches sys.modules for all modules at or below module that do not include any stopwords in their full dotted name. assertEquals collects TestCase classes that are defined in these modules, and prints a summary report to the standard output of the format (actually 80 chars wide):

-------------<| assertEquals |>-------------
<header row>
<name> <passing> <failures> <errors> <all>
TOTALS <passing> <failures> <errors> <all>

<name> is the full dotted name of a TestCase (this row is repeated for each TestCase). If the --find flag is set, then no tests are run, and <passing>, <failures>, and <errors> are each set to a single dash (‘-’). Otherwise, <passing> is given as a percentage, with a terminating percent sign; the other three are given in absolute terms. There will always be at least one space between each field, and data rows will be longer than 80 characters iff the field values exceed the following character lengths:

field width
name 60
failures 4
errors 4
total 4

Note that in order for your TestCases to be found, you must import their containing modules within module. assertEquals sets the PYTHONTESTING environment variable to ‘assertEquals’ so that you can avoid defining TestCases or importing testing modules in a production environment. You can also quarantine your tests in a subpackage, and give module as the dotted name of this subpackage. If the --testcase flag is set, then only the named TestCase is run (any --find option is ignored), and assertEquals delivers a detail report. This report is the usual output of unittest.TextTestRunner, preceded by the same first banner row as for the summary report. For both summary and detail reports, assertEquals guarantees that no program output will occur after the banner row.

Interactive Mode

Interactive mode is a front end for scripted mode. There are two main screens, representing the summary and detail reports described above. Each is populated by calling assertEquals in scripted mode in a child process, and then parsing and formatting the output. There are two additional screens: One is a primitive pager showing a Python traceback, which is used both for viewing individual test failures, as well as for error handling in both parent and child processes. The other is a primitive terminal for interacting with a Pdb session in a child process. You can send a SIGINT (<ctrl>-C) at any time to exit assertEquals.

Summary Screen

The summary screen shows the summary report as described above, but item names are indented rather than given in full. Modules are shown in gray, and un-run TestCases in white. TestCases with non-passing tests are shown in red, and those that pass in green. You may run any subset of the presented tests. The totals for the most recent test run are shown at the bottom of the screen, in green if all tests pass, red otherwise. TestCases for which there are results but that were not part of the most recent test run are shown in faded red and green.

Refresh the list of available TestCases without running them.
Run the selected tests and go to the detail screen if there are non-passing tests.
Alias for q.
Exit assertEquals.
Alias for enter.
Alias for enter.
Alias for enter.

Detail Screen

The detail screen shows a list of non-passing tests on the left side, and the traceback for the currently selected test on the right. Failures are displayed in red, and errors in yellow. Tests are listed in alphabetical order.

Run the tests again.
Open the traceback for the selected test in an error screen.
Alias for q.
Exit back to the summary screen.
Alias for enter.
Alias for F5.

Error Screen

The error screen provides a primitive pager for viewing tracebacks.

Alias for q.
Exit back to the previous screen.

Debugging Screen

The debugging screen is a primitive terminal for interacting with a Python debugger session. When a child process includes the string ‘(Pdb) ’ in its output, assertEquals enters the debugging screen. When the debugger exits, assertEquals returns to the previous screen, ignoring any report output that may have followed the debugging session. You can easily start debugging from any point in your program or tests by manually setting a breakpoint:

import pdb; pdb.set_trace()

The Python debugger's command reference is online at:


Implementation Notes

This program is known to work with the following software:


Run assertEquals's own tests, displaying a summary report on the standard output:

See Also

python(1) curses(3)


assertEquals <trunk>



Explore man page connections for assertEquals(1).