pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-07 21:44:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
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
1284 commits 3 branches 92 tags 4.8 MiB
Find a file
Curzy bfd7092eff Git pre-commit hook should not check non-python, excluded files 
This commit fixes two problems that caused by git pre-commit hook

1. flake8 checks non-python files(.md, .txt, ...) and raise errors
```/var/folders/bb/0_8jdgw15f72f18m_fpqwcqr0000gn/T/tmpqbcrt3vn/Users/Curzy/Workspace/flative/hbnn/hbnn/README.md:3:2:
E999 SyntaxError: invalid syntax
/var/folders/bb/0_8jdgw15f72f18m_fpqwcqr0000gn/T/tmpqbcrt3vn/Users/Curzy/Workspace/flative/hbnn/hbnn/README.md:3:20:
E226 missing whitespace around arithmetic operator```
this problem fixed with find_modified_files function
2. flake8 checks excluded files by config(.flake8, config, ...)
```.flake8
[flake8]
ignore = F401
exclude =
    .git,
    __pycache__,
    hbnn/settings.py,
    manage.py,
    */migrations
```
```
./hbnn/settings.py:102:80: E501 line too long (83 > 79 characters)
./user/migrations/0001_initial.py:20:80: E501 line too long (88 > 79 characters)
./user/migrations/0001_initial.py:21:80: E501 line too long (103 > 79 characters)
```
this problem fixed with update_execuldes function should contain both original, temp paths
2017-02-05 03:30:32 +09:00
docs Add test for reproducible --version strings 2017-01-21 14:14:59 -06:00
example-plugin Add an example plugin project to source tree 2016-10-25 18:21:50 -05:00
src/flake8 Git pre-commit hook should not check non-python, excluded files 2017-02-05 03:30:32 +09:00
tests Return similarly named, non-submodule modules 2017-01-22 15:00:48 -06:00
.appveyor.yml Add dogfood testenv to AppVeyor list 2016-08-03 16:48:39 -05:00
.bandit.yml Configure bandit to ignore subprocess warnings 2016-06-14 07:58:13 -05:00
.coveragerc Add coverage reporting and uploading 2016-08-06 15:21:50 -05:00
.gitignore Add coverage reporting and uploading 2016-08-06 15:21:50 -05:00
.gitlab-ci.yml Add Python 3.6 to CI services 2017-01-15 11:26:12 -06:00
.hgignore Ignore ./.tox directory 2014-03-30 23:54:36 +02:00
.hgtags Release v2.2.3 2014-08-25 19:03:13 -05:00
.pylintrc Fix our evaluation formula 2016-02-19 15:30:54 -06:00
.travis.yml Add Python 3.6 to CI services 2017-01-15 11:26:12 -06:00
codecov.yml Add coverage reporting and uploading 2016-08-06 15:21:50 -05:00
CONTRIBUTING.rst Symlink the contributing docs to CONTRIBUTING 2016-06-04 15:46:51 -05:00
CONTRIBUTORS.txt Tidy up last few bits for performance improvement 2016-12-20 18:29:10 -06:00
dev-requirements.txt Switch out dev-requirements for tox 2016-03-17 14:56:54 -05:00
LICENSE Update the copyright in the LICENSE 2016-06-25 10:49:32 -05:00
MANIFEST.in Revert "Update release machinery to include manpages" 2016-11-14 09:49:03 -06:00
pytest.ini setup.cfg: Move pytest options to pytest.ini 2016-09-18 11:23:08 +03:00
README.rst Point documentation to http: instead of https: 2016-08-11 16:11:26 +00:00
setup.cfg Allow newer pycodestyle 2017-02-02 12:22:22 -08:00
setup.py Allow newer pycodestyle 2017-02-02 12:22:22 -08:00
tox.ini Change dogfood environment to use Python 2.7 2017-01-21 13:51:01 -06:00

README.rst 

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

Flake8 is a wrapper around these tools:

- PyFlakes
- pycodestyle
- Ned Batchelder's McCabe script

Flake8 runs all the tools by launching the single ``flake8`` command.
It displays the warnings in a per-file, merged output.

It also adds a few features:

- files that contain this line are skipped::

    # flake8: noqa

- lines that contain a ``# noqa`` comment at the end will not issue warnings.
- you can ignore specific errors on a line with ``# noqa: <error>``, e.g.,
  ``# noqa: E234``
- Git and Mercurial hooks
- extendable through ``flake8.extension`` and ``flake8.formatting`` entry
  points


Quickstart
==========

See our `quickstart documentation
<http://flake8.pycqa.org/en/latest/index.html#quickstart>`_ for how to install
and get started with Flake8.


Frequently Asked Questions
==========================

Flake8 maintains an `FAQ <http://flake8.pycqa.org/en/latest/faq.html>`_ in its
documentation.


Questions or Feedback
=====================

If you have questions you'd like to ask the developers, or feedback you'd like
to provide, feel free to use the mailing list: code-quality@python.org

We would love to hear from you. Additionally, if you have a feature you'd like
to suggest, the mailing list would be the best place for it.


Links
=====

* `Flake8 Documentation <http://flake8.pycqa.org/en/latest/>`_

* `GitLab Project <https://gitlab.com/pycqa/flake8>`_

* `All (Open and Closed) Issues
  <https://gitlab.com/pycqa/flake8/issues?scope=all&sort=updated_desc&state=all>`_

* `Code-Quality Archives
  <https://mail.python.org/mailman/listinfo/code-quality>`_

* `Code of Conduct
  <http://flake8.pycqa.org/en/latest/internal/contributing.html#code-of-conduct>`_

* `Getting Started Contributing
  <http://flake8.pycqa.org/en/latest/internal/contributing.html>`_


Maintenance
===========

Flake8 was created by Tarek Ziadé and is currently maintained by `Ian Cordasco
<https://coglib.com/~icordasc/>`_