Source

flake8 / docs / vcs.rst

VCS Hooks

Mercurial hook

To use the Mercurial hook on any commit or qrefresh, change your .hg/hgrc file like this:

[hooks]
commit = python:flake8.hooks.hg_hook
qrefresh = python:flake8.hooks.hg_hook

[flake8]
strict = 0
complexity = 12

If strict option is set to 1, any warning will block the commit. When strict is set to 0, warnings are just printed to the standard output.

complexity defines the maximum McCabe complexity allowed before a warning is emitted. If you don't specify it, it's just ignored. If specified, it must be a positive value. 12 is usually a good value.

Git hook

To use the Git hook on any commit, add a pre-commit file in the .git/hooks directory containing:

#!/usr/bin/env python
import sys
from flake8.hooks import git_hook

COMPLEXITY = 10
STRICT = False

if __name__ == '__main__':
    sys.exit(git_hook(complexity=COMPLEXITY, strict=STRICT, ignore='E501'))
    # Alternatively
    # sys.exit(git_hook(complexity=COMPLEXITY, strict=STRICT,
    #                   ignore=['E501']))

If strict option is set to True, any warning will block the commit. When strict is set to False or omitted, warnings are just printed to the standard output.

complexity defines the maximum McCabe complexity allowed before a warning is emitted. If you don't specify it or set it to -1, it's just ignored. If specified, it must be a positive value. 12 is usually a good value.

lazy when set to True will also take into account files not added to the index.

Also, make sure the file is executable and adapt the shebang line so it points to your Python interpreter.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.