flake8-fixme is a plugin for the Flake8 Python code checker that identifies temporary developer notes like FIXME, TODO, and XXX within source code. It helps enforce code quality by flagging these comments, ensuring they are addressed. The current version is 1.1.1, released in May 2019. As a Flake8 plugin, its release cadence is tied to its own maintenance and compatibility with Flake8 updates.
pip install flake8-fixmeNo compatibility data collected yet for this library.
Install flake8-fixme alongside flake8. Flake8 will automatically discover the plugin. Running flake8 on your code will then report any FIXME, TODO, or XXX comments.
Update your `.flake8` or `setup.cfg` configurations to reflect the new error codes (T100, T101, T102) if you were explicitly ignoring or selecting them. Be aware that a single line with multiple temporary notes will now generate multiple reports.
Ensure both `flake8` and `flake8-fixme` are installed within the same virtual environment. You can verify plugin discovery by running `flake8 --version` and checking the output for `flake8-fixme`.
Use a code formatter like Black, Yapf, or a custom script if you need to automatically remove or modify these comments. flake8-fixme's purpose is to *report* their presence, not to eliminate them programmatically.
Ensure you have activated the correct virtual environment (if any) and run `pip install flake8 flake8-fixme`. Then, re-run `flake8 --version` to confirm `flake8-fixme` is listed.
Address the 'FIXME' comment in your code. If you intend to temporarily allow 'FIXME's, you can configure flake8 to ignore the T100 error code in your `.flake8` or `setup.cfg` file (e.g., `ignore = T100`).
This is the intended behavior. If you want to consolidate these, you must manually rewrite the comment to contain only one keyword per line, or adjust your workflow to handle multiple reports for such lines. Alternatively, you can selectively ignore specific error codes if you only care about certain types of notes.