pre-commit/flake8: flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code.

mirror of https://github.com/PyCQA/flake8.git synced 2026-03-29 18:46:52 +00:00

flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code. https://flake8.pycqa.org

complexity-analysis flake8 linter linter-flake8 pep8 python python3 static-analysis static-code-analysis style-guide styleguide stylelint

Find a file

Tarek Ziade 53f153dc12 bumped revision		2011-01-26 11:59:20 +01:00
bin	fixed outputs	2010-08-12 15:02:26 +02:00
flake8	added a mercurial hook	2011-01-26 11:59:05 +01:00
.hgtags	Added tag 0.1 for changeset 72a440d1fa2d	2010-08-12 15:35:13 +02:00
LICENSE	initial commit	2010-08-12 14:40:53 +02:00
README	added a mercurial hook	2011-01-26 11:59:05 +01:00
setup.py	bumped revision	2011-01-26 11:59:20 +01:00

README

======
Flake8
======

Flake8 is just a merge of the PyFlakes and the pep8 projects into one single
script.

It runs both tests by launching the single 'flake8' script, but ignores pep8
options and just uses its defaults.

It also adds a few features:

- lines that contains a "# NOQA" comment at the end will not issue a warning
- merging pep8 and pyflakes options
- a Mercurial hook
- more things to come..

Original projects:

- pep8: http://github.com/jcrocholl/pep8/
- PyFlakes: http://divmod.org/trac/wiki/DivmodPyflakes


Mercurial hook
==============

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

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

    [flake8]
    strict = 0


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