You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
dependabot[bot] 18a2d4e15a Bump actions/cache from 3.0.6 to 3.0.7 1 day ago
.github Bump actions/cache from 3.0.6 to 3.0.7 1 day ago
doc Fix false positive for `no-self-argument` (#7301) 3 days ago
elisp [spelling] Remove remaining typoes detected by the spelling checker 4 months ago
examples Bump pylint to 2.15.0-a0, update changelog (#7196) 2 weeks ago
pylint Refactors related to separating ast creating and linting (#7286) 2 days ago
script Updating my contributor aliases. 5 days ago
tests Fix false positive for `no-self-argument` (#7301) 3 days ago
.coveragerc [style] Fix a typo in .coveragerc 2 months ago
.gitignore Move ``pylint_primer_tests`` into ``tests`` 3 months ago
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate (#7278) 7 days ago
.pre-commit-hooks.yaml Add prettier to the pre-commit configuration 1 year ago
.pyenchant_pylint_custom_dict.txt Add configuration for `towncrier` 1 month ago
.readthedocs.yaml Create pipeline for checking existence of changelog and update cache version 1 month ago
CODE_OF_CONDUCT.md Add a code of conduct from template (#5589) 8 months ago
CONTRIBUTORS.txt Bump pylint to 2.15.0-a0, update changelog (#7196) 2 weeks ago
Dockerfile Improve packaging [PEP 517 + 621] (#7076) 2 months ago
LICENSE Rename copying to license and upgrade the setup.cfg (#4338) 1 year ago
MANIFEST.in Improve packaging [PEP 517 + 621] (#7076) 2 months ago
README.rst [open source insight] Add the badge from OpenSSF (#7267) 1 week ago
pylintrc Remove unsupported option from our own ``pylintrc`` 1 month ago
pyproject.toml "Contributer" -> "Contributor" 3 days ago
requirements_test.txt Update `astroid` to 2.12 (#7153) 1 month ago
requirements_test_min.txt Add `towncrier` to requirements 1 month ago
requirements_test_pre_commit.txt Bump flake8 from 5.0.2 to 5.0.4 1 week ago
setup.cfg Improve packaging [PEP 517 + 621] (#7076) 2 months ago
tbump.toml Bump pylint to 2.15.0-a0, update changelog (#7196) 2 weeks ago
towncrier.toml Add configuration for `towncrier` 1 month ago
tox.ini Add command to `tox.ini` & update existing github action to use it. 4 weeks ago

README.rst

Pylint

image

image

Pypi Package version

Documentation Status

image

image

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.

image

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.