Skip to main content

A small plugin for the pytest testing framework, marking TODO comments as failure

Project description

Marking unfinished source code or known problems with a TODO comment is a popular method among developers. During development this is an acceptable, lightweight option. In a release version however TODO comments leave a bitter taste at best or mean a forgotten major issue at worst.

This plugin parses Python source files for TODO comments and marks them as a failed test.

Usage

~$ pytest --todo

Possible Usage

During development the CI server simply runs the unit tests against the code, checking if the tests pass. At this stage TODO comments are allowed. Once a release candidate exists (maybe on a release branch) the CI server will also add the –todo flag. Forgotten TODO comments will now cause the tests to fail and a possible source of bugs is cleared out before the release happens.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pytest-todo, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size pytest_todo-0.2.1-py2.py3-none-any.whl (4.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page