Skip to main content

python code static checker

Project description

https://travis-ci.org/PyCQA/pylint.svg?branch=master AppVeyor Build Status https://coveralls.io/repos/github/PyCQA/pylint/badge.svg?branch=master Pypi Package version Documentation Status https://img.shields.io/badge/code%20style-black-000000.svg
Tidelift Professional support for pylint is available as part of the Tidelift Subscription. Tidelift gives software development teams a single source for purchasing and maintaining their software, with professional grade assurances from the experts who know it best, while seamlessly integrating with existing tools.

Pylint

It’s not just a linter that annoys you!

Pylint is a Python static code analysis tool which looks for programming errors, helps enforcing a coding standard, sniffs for code smells and offers simple refactoring suggestions.

It’s highly configurable, having special pragmas to control its errors and warnings from within your code, as well as from an extensive configuration file. It is also possible to write your own plugins for adding your own checks or for extending pylint in one way or another.

It’s a free software distributed under the GNU General Public Licence unless otherwise specified.

Development is hosted on GitHub: https://github.com/PyCQA/pylint/

You can use the code-quality@python.org mailing list to discuss about Pylint. Subscribe at https://mail.python.org/mailman/listinfo/code-quality/ or read the archives at https://mail.python.org/pipermail/code-quality/

Pull requests are amazing and most welcome.

Install

Pylint can be simply installed by running:

pip install pylint

If you are using Python 3.6+, upgrade to get full support for your version:

pip install pylint --upgrade

If you want to install from a source distribution, extract the tarball and run the following command

python setup.py install

Do make sure to do the same for astroid, which is used internally by pylint.

For debian and rpm packages, use your usual tools according to your Linux distribution.

More information about installation and available distribution format can be found here.

Documentation

The documentation lives at http://pylint.pycqa.org/.

Pylint is shipped with following additional commands:

  • pyreverse: an UML diagram generator
  • symilar: an independent similarities checker
  • epylint: Emacs and Flymake compatible Pylint

Testing

We use tox for running the test suite. You should be able to install it with:

pip install tox pytest

To run the test suite for a particular Python version, you can do:

tox -e py37

To run individual tests with tox, you can do:

tox -e py37 -- -k name_of_the_test

We use pytest for testing pylint, which you can use without using tox for a faster development cycle.

If you want to run tests on a specific portion of the code with pytest, (pytest-cov) and your local python version:

# ( pip install pytest-cov )
# Everything:
python3 -m pytest tests/
# Everything in tests/message with coverage for the relevant code:
python3 -m pytest tests/message/ --cov=pylint.message
coverage html
# Only the functional test "missing_kwoa_py3":
python3 -m pytest "tests/test_functional.py::test_functional[missing_kwoa_py3]"

Do not forget to clone astroid and install the last version:

git clone https://github.com/PyCQA/astroid.git

# From source
python3 astroid/setup.py build sdist
pip3 install astroid/dist/astroid*.tar.gz

# Using an editable installation
cd astroid
python3 -m pip install -e .

For more detailed information, check the documentation.

License

pylint is, with a few exceptions listed below, GPLv2.

The icon files are licensed under the CC BY-SA 4.0 license:

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pylint, version 2.4.4
Filename, size File type Python version Upload date Hashes
Filename, size pylint-2.4.4-py3-none-any.whl (303.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pylint-2.4.4.tar.gz (646.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page