FIXME and TODO checker. Plugin for flake8.
Project description
flake8-fixme
Check for FIXME and other temporary comment notes.
This module provides a plugin for flake8
, the Python code checker.
This module was inspired by flake8-todo
Installation
Install with pip:
pip install flake8-fixme
The plugin officially supports Python >= 3.6
and flake8 >= 3.7
.
You may find other Python 3 versions work as well.
Usage
The plugin finds temporary comments you may not want to commit:
def my_function():
# FIXME actual implementation here!
pass
./my_file.py:2:7: T100 Fixme found (FIXME)
Each word has a seperate warning so you can adjust your workflow. We like to allow committing TODO
s, but deny committing FIXME
s.
Changelog
1.0.2
Enhancements
- development pipeline now runs integration tests with flake8, for
- locally built package (all builds)
- package downloaded from pypi (after version release)
1.0.1
Bugfixes
- fixed pypi packaging not picking up source files
- fixed setup.py not loading markdown readme correctly
1.0.0
Breaking changes
Upgrading to flake8-fixme
from flake8-todo
has the following breaking changes:
- error codes have been changed as follows:
T100
: line containsFIXME
T101
: line containsTODO
T102
: line containsXXX
- a line containing multiple words will raise an error for each word
- drop support for Python
2.7
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
flake8-fixme-1.1.0.tar.gz
(3.4 kB
view hashes)
Built Distribution
Close
Hashes for flake8_fixme-1.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9dd314b58a020a11d860d23d7f1acc4674e02f080175ebf99ca160f30d9c1e81 |
|
MD5 | f0905b2d487515f72b9dedccce40bce5 |
|
BLAKE2b-256 | 4b51cd20d5c2af90ed9f72573e5f84fd08d4947d35be306eb810e2a661047e5e |