Skip to main content

python code static checker

Project description

https://github.com/PyCQA/pylint/actions/workflows/ci.yaml/badge.svg?branch=main https://coveralls.io/repos/github/PyCQA/pylint/badge.svg?branch=main Pypi Package version Documentation Status https://img.shields.io/badge/code%20style-black-000000.svg pre-commit.ci status

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 https://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 and pytest-benchmark for running the test suite. You should be able to install it with:

pip install tox pytest pytest-benchmark

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 | RSS feed

Download files

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

Source Distribution

pylint-2.9.5.tar.gz (317.3 kB view details)

Uploaded Source

Built Distribution

pylint-2.9.5-py3-none-any.whl (375.2 kB view details)

Uploaded Python 3

File details

Details for the file pylint-2.9.5.tar.gz.

File metadata

  • Download URL: pylint-2.9.5.tar.gz
  • Upload date:
  • Size: 317.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for pylint-2.9.5.tar.gz
Algorithm Hash digest
SHA256 1f333dc72ef7f5ea166b3230936ebcfb1f3b722e76c980cb9fe6b9f95e8d3172
MD5 af10eacb0c9e94d0067980d481a45d4f
BLAKE2b-256 cbf441c130d3efb1cbc8dc34a7b8f38ea3f753820a1c74b5c19bc965033e031c

See more details on using hashes here.

File details

Details for the file pylint-2.9.5-py3-none-any.whl.

File metadata

  • Download URL: pylint-2.9.5-py3-none-any.whl
  • Upload date:
  • Size: 375.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for pylint-2.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 748f81e5776d6273a6619506e08f1b48ff9bcb8198366a56821cf11aac14fc87
MD5 cb592fa172e38ed944aef49e9021bccc
BLAKE2b-256 eeaaae73665b00ee8e4e9d5a26939bb450005ded84c19cfdb356a25b3bb136a3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page