Skip to main content

python code static checker

Project description

Pylint

https://github.com/PyCQA/pylint/actions/workflows/tests.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 https://img.shields.io/badge/linting-pylint-yellowgreen pre-commit.ci status CII Best Practices Discord

What is Pylint?

Pylint is a static code analyser for Python 2 or 3. The latest version supports Python 3.7.2 and above.

Pylint analyses your code without actually running it. It checks for errors, enforces a coding standard, looks for code smells, and can make suggestions about how the code could be refactored. Pylint can infer actual values from your code using its internal code representation (astroid). If your code is import logging as argparse, Pylint will know that argparse.error(...) is in fact a logging call and not an argparse call.

Pylint is highly configurable and permits to write plugins in order to add your own checks (for example, for internal libraries or an internal rule). Pylint has an ecosystem of existing plugins for popular frameworks such as pylint-django or pylint-sonarjson.

Pylint isn’t smarter than you: it may warn you about things that you have conscientiously done or check for some things that you don’t care about. During adoption, especially in a legacy project where pylint was never enforced, it’s best to start with the --errors-only flag, then disable convention and refactor message with --disable=C,R and progressively re-evaluate and re-enable messages as your priorities evolve.

Pylint ships with three additional tools:

  • pyreverse (standalone tool that generates package and class diagrams.)

  • symilar (duplicate code finder that is also integrated in pylint)

  • epylint (Emacs and Flymake compatible Pylint)

Projects that you might want to use alongside pylint include flake8 (faster and simpler checks with very few false positives), mypy, pyright or pyre (typing checks), bandit (security oriented checks), black and isort (auto-formatting), autoflake (automated removal of unused imports or variables), pyupgrade (automated upgrade to newer python syntax) and pydocstringformatter (automated pep257).

Install

For command line use, pylint is installed with:

pip install pylint

It can also be integrated in most editors or IDEs. More information can be found in the documentation.

Contributing

We welcome all forms of contributions such as updates for documentation, new code, checking issues for duplicates or telling us that we can close them, confirming that issues still exist, creating issues because you found a bug or want a feature, etc. Everything is much appreciated!

Please follow the code of conduct and check the Contributor Guides if you want to make a code contribution.

Show your usage

You can place this badge in your README to let others know your project uses pylint.

https://img.shields.io/badge/linting-pylint-yellowgreen

Learn how to add a badge to your documentation in the the badge documentation.

License

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

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

Support

Please check the contact information.

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.

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.15.6.tar.gz (410.7 kB view details)

Uploaded Source

Built Distribution

pylint-2.15.6-py3-none-any.whl (508.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pylint-2.15.6.tar.gz
  • Upload date:
  • Size: 410.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.8

File hashes

Hashes for pylint-2.15.6.tar.gz
Algorithm Hash digest
SHA256 25b13ddcf5af7d112cf96935e21806c1da60e676f952efb650130f2a4483421c
MD5 8f6ae3c1ed9b9e9ce5cc0904dc5039b5
BLAKE2b-256 626dd671e27077c7d2721266180757c507e68f46403728c6e87eac1b4309c372

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pylint-2.15.6-py3-none-any.whl
  • Upload date:
  • Size: 508.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.8

File hashes

Hashes for pylint-2.15.6-py3-none-any.whl
Algorithm Hash digest
SHA256 15060cc22ed6830a4049cf40bc24977744df2e554d38da1b2657591de5bcd052
MD5 418c45703731798b9df0f99a08552e2f
BLAKE2b-256 d55fdbeceb81e1b3700d1cca3e8b19b0f6643b0e32b675bb75cb9f74de95e920

See more details on using hashes here.

Supported by

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