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.


~$ 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.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

pytest_todo-0.2.1-py2.py3-none-any.whl (4.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page