Skip to main content

flake8 wrapper to run only on modified/staged code

Project description


Run flake8 but report the findings only on staged files (identified with git diff --staged) This tool is primarily meant to be integrated through pre-commit but it also offers a CLI.

How it works?

This tool runs first git diff -U0 --staged -- and identify the files and lines that were modified, it then runs flake8 on the entire files and simply filters out all the findings that are not coming from the modified code.

If no files is staged in git, it will return immediately

Pre-commit integration

An example .pre-commit-config.yaml:

  - repo:
    rev: ''  # Use the sha / tag you want to point at
      - id: flake8-staged-diff

NOTE: This will only affect local usage of pre-commit, typically through git commit. When it runs for instance in a Github pipeline through pre-commit run -a, there will be no staged files and the tool will simply pass.

CLI Usage

Interface is the same as flake8, e.g.

flake8-staged-diff --select=E501


This tool allows to introduce some flake8 rules in large/legacy codebases only on the code that is updated or inserted.

We use this at work for enforcing type annotations on modified code using the following config

  - repo:
    rev: ''  # Use the sha / tag you want to point at
      - id: flake8-staged-diff
          - "--select=AN"
          - flake8-annotations


Use this consciously, not every flake8's rule is a good candidate for this tool, in fact sometimes a modified line can introduce errors in other part of the file but since those part of the file aren't in the diff, they wouldn't appear through this tool. Make sure to review pre-commit / Flake8's maintainer comment made here.

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-staged-diff-0.3.0.tar.gz (4.2 kB view hashes)

Uploaded Source

Built Distribution

flake8_staged_diff-0.3.0-py2.py3-none-any.whl (4.7 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