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 --todoPossible 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file pytest_todo-0.2.1-py2.py3-none-any.whl.
File metadata
- Download URL: pytest_todo-0.2.1-py2.py3-none-any.whl
- Upload date:
- Size: 4.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.5.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c11a20b7d9eacc3d5b18668ed725deeaaf1806c6cf3c54bd92a8da09e142bb57 |
|
| MD5 | c6f7f8b94de70507be4bec35f18b1d24 |
|
| BLAKE2b-256 | 3b1e7286c8abd0e8fe5083e4c1b88ac0383db75c2e17d4c7eacde7675508737e |
