pylint

Пинтинт

Что такое Pylint?

Pylint является статическим анализатором кода для Python 2 или 3. Последняя версия поддерживает Python 3.9.0 и выше.

Pylint анализирует ваш код, фактически не запустив его. Он проверяет ошибки, обеспечивает соблюдение стандарта кодирования, ищет запахи кода и может внести предложения о том, как код может быть рефактор.

Установить

Для использования командной строки Pylint установлен с:

 PIP установить Pylint

Или если вы хотите также проверить орфографию с enchant (вам может потребоваться установить библиотеку Enchant C):

pip install pylint[spelling]

Он также может быть интегрирован в большинство редакторов или IDE. Более подробную информацию можно найти в документации.

Что отличает пилент?

Pylint не доверяет вашей печати и выводит фактические значения узлов (для начала, потому что не было никакого типирования, когда началось пилинт), используя его внутреннее представление кода (астроид). Если ваш код является import logging as argparse , Pylint может проверить и знать, что argparse.error(...) на самом деле является вызовом журнала, а не вызовом Argparse. Это делает Pylint медленнее, но также позволяет Pylint найти больше проблем, если ваш код не полностью напечатан.

[Вывод] - это особенность убийцы, которая заставляет нас использовать [Pylint] в нашем проекте, несмотря на то, насколько она мучительно медленна. - Realist Pylint User, 2022

Pylint, не боясь быть немного медленнее, чем он уже есть, также намного более тщательнее, чем другие линщики. Есть больше проверок, в том числе некоторые самоуверенные, которые деактивированы по умолчанию, но могут быть включены с помощью конфигурации.

Как использовать Pylint

Pylint не умнее вас: он может предупредить вас о вещах, которые вы делали добросовестно, или проверить некоторые вещи, о которых вам не волнует. Во время усыновления, особенно в устаревшем проекте, где Pylint никогда не применялся, лучше всего начинать с флага --errors-only , а затем отключить соглашения и рефакторные сообщения с помощью --disable=C,R и постепенно переоценивают и повторно устанавливают сообщения по мере развития ваших приоритетов.

Pylint очень настраивается и позволяет записывать плагины, чтобы добавить свои собственные проверки (например, для внутренних библиотек или внутреннего правила). У Pylint также есть экосистема существующих плагинов для популярных фреймворков и сторонних библиотек.

Примечание

Pylint поддерживает стандартную библиотеку Python из коробки. Сторонние библиотеки не всегда поддерживаются, поэтому может потребоваться плагин. Хорошим местом для запуска является PyPI , который часто возвращает плагин, ища pylint <library> . Pylint-Pydantic, Pylint-Django и Pylint-Sonarjson являются примерами таких плагинов. Более подробную информацию о плагинах и о том, как их загрузить можно найти в плагинах.

Рекомендуется Линтерам вместе с Pylint

Проекты, которые вы, возможно, захотите использовать вместе с Pylint, включают Ruff ( действительно быстрый, со встроенным автофиксом и большим количеством чеков, взятых из популярных линтеров, но внедренных в rust ) или Flake8 (структура для реализации ваших собственных чеков в Python с использованием ast непосредственно), Mypy, Black-Formake-Formake). (Автоматическое удаление неиспользованного импорта или переменных), Pyupgrade (автоматическое обновление до более нового синтаксиса Python) и PydocstringFormatter (Automated PEP257).

Дополнительные инструменты, включенные в Pylint

Pylint Ships с двумя дополнительными инструментами:

• Pyreverse (автономный инструмент, который генерирует пакетные и классовые диаграммы.)
• Symilar (дубликат кода, который также интегрирован в Pylint)

Внося

Мы приветствуем все формы вкладов, такие как обновления для документации, новый код, проверка проблем для дубликатов или сообщать нам, что мы можем закрыть их, подтверждая, что проблемы все еще существуют, создавая проблемы, потому что вы нашли ошибку или хотите функцию и т. Д. Все высоко ценится!

Пожалуйста, следуйте кодексу поведения и проверьте руководства по вкладчику, если вы хотите внести вклад в код.

Покажите свое использование

Вы можете поместить этот значок в свой ReadMe, чтобы другие знали, что ваш проект использует Pylint.

Узнайте, как добавить значок в вашу документацию в документации значков.

Лицензия

Pylint, за несколькими исключениями, перечисленными ниже, GPLV2.

Файлы значков лицензированы по лицензии CC SA 4.0:

• doc/logo.png
• doc/logo.svg

Поддерживать

Пожалуйста, проверьте контактную информацию.

Профессиональная поддержка Pylint доступна как часть подписки Tidelift. Tidelift дает командам разработки программного обеспечения один источник для покупки и поддержания своего программного обеспечения, с профессиональными гарантиями от экспертов, которые знают его лучше всего, в то же время беспрепятственно интегрируются с существующими инструментами.