4
Summary: passive checker of Python programs
5
Home-page: https://github.com/PyCQA/pyflakes
6
Author: A lot of people
7
Author-email: code-quality@python.org
10
Classifier: Development Status :: 6 - Mature
11
Classifier: Environment :: Console
12
Classifier: Intended Audience :: Developers
13
Classifier: License :: OSI Approved :: MIT License
14
Classifier: Programming Language :: Python
15
Classifier: Programming Language :: Python :: 2
16
Classifier: Programming Language :: Python :: 3
17
Classifier: Topic :: Software Development
18
Classifier: Topic :: Utilities
24
A simple program which checks Python source files for errors.
26
Pyflakes analyzes programs and detects various errors. It works by
27
parsing the source file, not importing it, so it is safe to use on
28
modules with side effects. It's also much faster.
30
It is `available on PyPI <https://pypi.python.org/pypi/pyflakes>`_
31
and it supports all active versions of Python from 2.5 to 3.5.
38
It can be installed with::
40
$ pip install --upgrade pyflakes
45
* Be sure to install it for a version of Python which is compatible
46
with your codebase: for Python 2, ``pip2 install pyflakes`` and for
47
Python3, ``pip3 install pyflakes``.
49
* You can also invoke Pyflakes with ``python3 -m pyflakes .`` or
50
``python2 -m pyflakes .`` if you have it installed for both versions.
52
* If you require more options and more flexibility, you could give a
58
Pyflakes makes a simple promise: it will never complain about style,
59
and it will try very, very hard to never emit false positives.
61
Pyflakes is also faster than Pylint_
62
or Pychecker_. This is
63
largely because Pyflakes only examines the syntax tree of each file
64
individually. As a consequence, Pyflakes is more limited in the
65
types of things it can check.
67
If you like Pyflakes but also want stylistic checks, you want
68
flake8_, which combines
69
Pyflakes with style checks against
71
per-project configuration ability.
77
Share your feedback and ideas: `subscribe to the mailing-list
78
<https://mail.python.org/mailman/listinfo/code-quality>`_
83
Issues are tracked on `Launchpad <https://bugs.launchpad.net/pyflakes>`_.
85
Patches may be submitted via a `GitHub pull request`_ or via the mailing list
86
if you prefer. If you are comfortable doing so, please `rebase your changes`_
87
so they may be applied to master with a fast-forward merge, and each commit is
88
a coherent unit of work with a well-written log message. If you are not
89
comfortable with this rebase workflow, the project maintainers will be happy to
90
rebase your commits for you.
92
All changes should include tests and pass flake8_.
94
.. image:: https://api.travis-ci.org/PyCQA/pyflakes.svg
95
:target: https://travis-ci.org/PyCQA/pyflakes
98
.. _Pylint: http://www.pylint.org/
99
.. _flake8: https://pypi.python.org/pypi/flake8
100
.. _`PEP 8`: http://legacy.python.org/dev/peps/pep-0008/
101
.. _Pychecker: http://pychecker.sourceforge.net/
102
.. _`rebase your changes`: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
103
.. _`GitHub pull request`: https://github.com/PyCQA/pyflakes/pulls