flake8-debugger

4.1.2 · active · verified Wed Apr 15

flake8-debugger is a plugin for the flake8 code quality tool that checks for the presence of common debugger statements (like `pdb.set_trace()`, `ipdb.set_trace()`, and `breakpoint()`) in Python code. This helps prevent accidental commits of debugging code into production. The current version is 4.1.2. Releases are made periodically, typically following updates to Python versions or the flake8 ecosystem.

Warnings

breaking Support for Python 3.6 was dropped in version 4.1.0.
Fix: Ensure your project uses Python 3.7 or newer. Upgrade your Python environment if necessary.
breaking Official support for Python 2.7 was dropped in version 4.0.0.
Fix: Migrate your project to Python 3.x. Version 3.1.0 was the last to explicitly support Python 2.7.
gotcha flake8-debugger works as a plugin and does not require any explicit imports or configuration files to enable. Simply installing it makes it active when you run the `flake8` command.
Fix: No fix needed, this is intended behavior. Just ensure `flake8` is installed and run it as usual.
gotcha While comprehensive, flake8-debugger relies on AST parsing and might not catch highly obfuscated or dynamic debugger calls. It primarily targets common patterns like `pdb.set_trace()` or `breakpoint()`.
Fix: For critical applications, supplement static analysis with runtime checks or enforce strict code review policies against debugging statements.

Install

pip install flake8-debugger Install flake8-debugger

Quickstart

Install flake8-debugger alongside flake8. It automatically integrates. Create a Python file with a debugger statement and run flake8 on it to see the plugin in action.

import os

def my_function():
    # This line will be flagged by flake8-debugger
    if os.environ.get('DEBUG_ENABLED', 'false').lower() == 'true':
        import pdb; pdb.set_trace()
    print("Hello, world!")

my_function()

# To run this example:
# 1. Save the code as example.py
# 2. Run 'pip install flake8 flake8-debugger'
# 3. Run 'flake8 example.py' in your terminal
# Expected output will include an error like 'example.py:6:9: D001 debugger detected'

view raw JSON →