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

Как запустить Pylint с PyCharm

Я хочу настроить pylint как внешний инструмент для всей моей директории проекта для проекта python, над которым я работаю. Я пытался использовать репозиторий как модуль с __init__.py и без него, и он не работает в любом случае. Мне сложно настроить pylint для запуска с PyCharm. Я знаю, что я должен использовать его как внешний инструмент, но настройки меня путают. Властный источник в своей документации не работает, поэтому я не могу это проверить.

Wasif Hyder 01 июль 2016, в 00:38
Поделиться
Поделиться:

8 ответов

Лучший ответ

1. Установить pylint :

$ pip install pylint 

$ which pylint # MacOS/Linux /usr/local/bin/pylint # this is just a possible output check yours 

$ where pylint # Windows %LocalAppData%\Programs\Python\Python36-32\Scripts\pylint.exe # possible location 

Откройте окно настроек PyCharm с помощью меню » File → Settings , затем перейдите к » Tools → External Tools на боковой панели. (Или поиск «внешние инструменты»)

Настройте внешний инструмент, нажав на знак + и заполнив соответствующие поля. В Program используйте путь, который вы получили при запуске which pylint , для других значений вы можете использовать то же изображение.

Запустите pylint из Tools → External Tools → pylint :

Посмотри свой вывод в терминале PyCharm

Для получения более подробной информации, обратитесь к Pylinting с PyCharm.

Обновить:

Если вы хотите использовать pylint для проверки всего вашего проекта или определенного файла или каталога, вы можете щелкнуть правой кнопкой мыши на корне, файле или каталоге вашего проекта, затем External Tools → pylint как показано ниже.

Плагины, горячие клавиши, настройки для PyCharm

Всем привет! Перед самим списком плагинов, горячих клавиш и т. п. небольшой дисклеймер.

Думаю каждый разработчик хоть раз встаёт перед трудным вопросом: Где и как писать код? Многие «тру» программисты тут же ответят: VIM NVIM и другие консольные редакторы. Но мы то с вами нормальные люди и хотим разрабатывать с удобством и комфортом. Хотим облегчить процесс кодинга.

Именно поэтому, многие программисты и отдают предпочтение ide’шкам, а не консольным редакторам.

После установки любой современной ide, у вас наверняка наступает ощущение абсолютной радости (особенно, если вы раньше вообще не программировали). Но после первых пары дней, вы узнаете о такой потрясающей вещи как плагины. Да. Это то, что может сделать опыт работы с ide ещё более простым, понятным, комфортным.

Когда я только начинал свой путь в разработке, я решил использовать PyCharm (соотвественно, для разработки на Python). И по моему глубокому убеждению не прогадал. PyCharm относительно лёгкая, относительно минималистичная ide’шка. Но не смотря на это, PyCharm — мощнейший инструмент для написания кода. Всё, начиная от подсветки синтаксиса и подсказок типов и заканчивая возможностью делать рефакторинг за одно сочетание клавиш, приводить весь код к единому стандарту, подключаться к базе данных и FTP/SSH, всё это может делать наш горячо любимый PyCharm.

Так зачем же тогда такому прекрасному редактору ещё и плагины? Всё очень просто, плагины позволяют нам добавить узкоспециализированные фичи, который просто не помещаются в стандартную «библиотеку» PyCharm.

Но в интернете практически нет статей посвящённых набору крутых плагинов, такие статьи разбросаны по всему интернету и найти в них ценный материал крайне сложно, поэтому, надеюсь, эта статья и станет своего рода базой, единым топом крутых плагинов для наших любых ide от JetBrains и для PyCharm в частности.

Итак, начнём с плагинов, я буду перечислять их примерно отсортировав по степени важности (по моему мнению).

Топ плагинов для PyCharm:

1. Tabnine — подсказки с использованием ИИ. Очень крутой плагин, сильно помогает при написании кода, использую всегда.
2. Translation — супер полезный плагин, позволяет запустить переводчик прямо из кода. Использование: выделить нужный текст, нажать ПКМ и выбрать Translate/Translate and Repace. Либо нажать в правом верхнем углу на иконку перевода.
3. PyLint — линтер для Python, указывает на плохой код. Использование: выбрать в нижнем меню PyLint и запустить проверку.
4. MyPy — проверка типов в Python (чтобы не допускать ошибки связанные с типом возвращаемых значений). Использование: выбрать в нижнем меню MyPy и запустить проверку.
5. SonarLint — указывает на различные ошибки в нейминге переменных/функций/классов. Использование: Ctrl+Shift+S или выбрать в нижнем меню SonarLint и запустить проверку.`
6. Python Security — проверяет код на уязвимости, работает автоматически.
7. Quick File Preview — посмотреть файл не открывая его, полезен если вы постоянно бегаете по файлам в поисках буквально 1 строчки и нет смысла полностью открывать файл (в данный момент этот функционал уже реализован в PyCharm:https://www.jetbrains.com/help/idea/2020.3/using-code-editor.html#preview-tab). Использование: Один раз кликнуть на файл.
8. String Manipulation — работа с названиями переменных/функций и т. п. (можно привести к snake_case, camelCase и т. п.), Использование: выделить нужное слово, нажать ПКМ, нажать String Manipulation, нажать Switch Case и выбрать нужный пункт.
9. Rainbow Brackets — красит скобочки в свой цвет, нужно чтобы чётко видеть иерархию скобок.
10. Python Smart Execute — запустить блок кода в консоли, не запуская при этом саму программу (к примеру для теста на работоспособность). Использование: выделить код и Alt+Shift+A, или нажать ПКМ и выбрать Smart execute.
11. MultiHighlight — выделить какое-либо название цветом (к примеру чтобы не забыть отрефакторить этот кусок). Использование: Выделить кусок и нажать Ctrl+’
12. Dummy Text Generator — сгенерировать рандомное предложение в различных стилях. Бывает полезно для теста функционала (к примеру, что текст отображения не вылазит за рамки). Использование: Нажать ПКМ, выбрать Generate (либо Alt+Insert), выбрать Generate Dummy Text.
13. Randomness — сгенерировать случайное число, строку и т. п. Использование: нажать Alt+R и выбрать нужное действие.
14. CodeGlance — добавляет карту с кодом в правую часть окна.
15. Extra Icons — изменяет стандартные иконки. Использование: Включить Settings/Appearance Behavior/Extra Icons
16. Mario Progress Bar — изменяет стандартный прогресс бар на марио.

Теперь предлагаю перейти на интересные сочетания клавиш, которые позволят вам быстрее выполнять стандартные действия, да и просто ускорят вашу разработку (кнопки для обычной, НЕ МАКОВСКОЙ клавиатуры).

1. Ctrl+Alt+S — Перейти в настройки (откроется та часть где вы остановились).
2. Ctrl+Shift+Стрелочки (вверх, вниз) — Переместить строчку вверх или вниз.
3. Ctrl+D/Y — Дублировать строчку/Удалить строчку.
4. Alt+Enter — Привести код к принятым стандартам (для Python — PEP8).
5. Ctrl+B — Переместиться к реализации данного класса/метода и т. п.
6. Ctrl+R — Изменить название класса/функции и т. п. по всему проекту.
7. Double tap on Shift — поиск в классе, функции, файле, PyCharm action или везде.
8. Ctrl+J — Использовать шаблон кода.
9. Alt+Enter — произвести настройку класса/функции и т. п. (к примеру указать типы принимаемых и возвращаемых значений).
10. Ctrl+E — Навигация по файлам (отображает список файлов в хронологическом порядке).
11. Ctrl+Alt+M — Объединить выделенный код в функцию/метод.
12. Ctrl+N — Найти класс/метод и т. п. по названию (по всем местам).
13. Ctrl+Shift+N — Найти файл по названию (по всем местам).
14. Alt+F7 — Посмотреть где используется класс/метод/функция и т. п.
15. Ctrl+F12 — Показывает структура файла (класса, функции и т. п).
16. Shift+Control+Minus и Shift+Control+Plus — скрыть или развернуть все функции/классы.

Думаю про горячие клавиши всё понятно, тут главное не спутать их 🙂

Под конец предлагаю рассмотреть интересные настройки, которые улучшат ваш опыт работы с ide.

1. Настроить интерпретатор. Тут вы сможете изменить версию Python, добавить библиотеки и ещё много чего интересного. File -> Settings -> Project: -> Project Interpreter
2. Изменить шрифты, размеры и т. д. File -> Settings -> editor -> font
3. Поменять цветовую схему UI. File -> Settings -> editor -> color scheme
4. Deploy на сервер. Эта настройка открывает нам целый мир удобного деплоя, если будет интересно, могу написать отдельную статью просвещённую деплою. Tools -> Deployment -> Configuration
5. Добавление плагинов. File -> Settings -> Plugins
6. Это не совсем настройка, но всё же находится в меню, так что я решил добавить это сюда. Позволяет посмотреть небольшую статистику своей продуктивности. Help -> MyProductivity
7. Включить возможность увеличивать/уменьшать масштаб с помощью Ctrl+Колёсико File -> Settings -> editor -> general -> Change font size with Ctrl+Mouse Wheel in: Это первый пункт меню, вам надо поставить галочку.

На этом основные настройки заканчиваются, да их не так много как тех же плагинов или хоткеев, но для начала думаю достаточно.

Спасибо что прочитали эту статью, надеюсь вы смогли подчерпнуть с неё нечто новое.

Пишите свои крутые плагины, хоткеи, настройки, если сообществу понравится я обязательно добавлю их в статью.

External tools

Configure third-party command-line applications as external tools to run them from PyCharm. For example, your workflow may require running a specific script, code generator, analyzer, preprocessor or postprocessor, some database utility, and so on. By configuring it as an external tool, PyCharm provides a dedicated action for it, which you can run from the main menu, from certain context menus, assign a shortcut to it, or run it when launching a specific run configuration.

You can use built-in IDE macros to pass context-dependent command-line arguments to the tool, such as the current file or your project source path. If necessary, PyCharm will print the tool’s output to the console.

PyCharm supports the following types of external tools:

• Local tools run locally on your computer.
• Remote tools are executed on a remote server over SSH. You can add and run remote tools only in PyCharm Professional.

Add a local external tool

pylint is a code analyzer tool that checks your code and detects any style, logic, and usage problems. It might be a great addition to the code validation features available with PyCharm.

1. Press Control+Alt+S to open the IDE settings and then select Project | Python Interpreter .
2. Click to install a new package.
3. In the Available packages window, search for «pylint», then choose it in the list of packages, and click Install Package . Wait until the package is installed and close the window.
4. Now that you have installed pylint on your system, you can configure its integration with PyCharm.
5. Press Control+Alt+S to open the IDE settings and then select Tools | External Tools .
6. Click the button to add a new external tool.
7. Add configuration options as shown below:
8. Group : The name of the external tool group to show in the Tools | External Tools menu
9. Name : The external tool name
10. Description : An optional description
11. Program : The path to the pylint executable ( $PyInterpreterDirectory$ is a directory where the Python interpreter of the current project is placed). Example:

$PyInterpreterDirectory$\pylint
$PyInterpreterDirectory$/pylint
—msg-template=»$FileDir$\::::()» car.py test —msg-template=»$FileDir$/::::()» car.py test

Now you can access this external tool from the Tools | External Tools .

You can run pylint using this menu. However, you might also want to add it to the Run/Debug Configuration of your application.

Run the external tool

1. Go to Run | Edit Configurations , then in the Edit Configurations dialog, click in the Before launch section.
2. Select Run External tool from the Add new configuration list and specify pylint. It will be added to the list of scripts to be executed before the application launch.
3. Click OK to save the changes
4. Run the Run/Debug configuration Shift+F10 . You should expect to see the pylint tab in the Tools window with the following sample output:

You can inspect the reported errors, click the corresponding links to navigate to the problematic code, and made the required changes.

Add a remote external tool

Make sure the FTP/SFTP/WebDAV Connectivity and HTTP Client plugins are installed and enabled. Press Control+Alt+S to open the IDE settings and then select Plugins .

Remote SSH external tools are configured similarly to local external tools, but also define the remote server on which they are executed and require credentials for connecting to it via SSH.

This example demonstrates how to add date as a remote SSH external tool that is executed on a remote server over SSH and returns the current date and time on it.

1. Press Control+Alt+S to open the IDE settings and then select Tools | Remote SSH External Tools .
2. Click to open the Create Tool dialog. This dialog provides the same set of settings as when you add a local external tool, but also allows you to select a remote connection. If you don’t specify the connection settings, PyCharm will ask you for the host, port, and relevant SSH credentials every time you run the tool on the server. For more information, refer to Remote SSH External Tools. You can use built-in IDE macros to specify the name of the current file, paths relative to the project root, and other contextual information for the tool.
3. Click OK to add the tool and then apply the changes.

Run the added tool on a remote server

Do one of the following:

• In the main menu, go to Tools | Remote Tools and the name of the added remote external tool.
• Create a shortcut to run the tool. Press Control+Alt+S to open the IDE settings and then select Keymap . Find the action with the name of your configured remote external tool, and assign a shortcut for it.

After you specify the host, port, and credentials, PyCharm will connect to the server via SSH and run the date command, returning the output to the Run tool window in PyCharm.

Web browsers

You can use a web browser to open any file from your project. By default, it is used to preview the output of an HTML file or run and debug web applications.

Open a file in a web browser

To open a file that is intended to be rendered by a web browser (HTML, XML, JSP, and so on), do one of the following:

• Open the file in the editor and press Alt+F2 .
• Right-click the file in the Project tool window and select Open in Browser .
• In the main menu, go to View | Open in Browser .
• Use the browser popup in the top right part of the editor window (appears on hover). Click the browser button to open the web server file URL, or Shift+LeftClick it to open the local file URL.

The Open in Browser action is not available for other file types. However, you can still execute it using Find Action Control+Shift+A .

View and configure the list of browsers

By default, PyCharm supports some of the most popular browsers, which are configured automatically, if available.

• In the Settings dialog ( Control+Alt+S ), select Tools | Web Browsers and Preview .

If a browser was installed using a standard procedure, the alias in the Path field should point to the right location. If it does not, specify the path to the corresponding executable file.

To add a custom browser, click and specify the browser name, family, and location of the executable file or macOS application.

Use custom profile and settings

You can configure custom profiles for Firefox and Chrome family browsers.

1. In the Settings dialog ( Control+Alt+S ), select Tools | Web Browsers and Preview .
2. Select the browser in the list and click .
   • For Firefox, specify the path to the profiles.ini file and choose the profile to use. For more information, refer to Firefox browser profile.
   • For Chrome, select Use custom user data directory and specify the location of the user data directory. You can also specify additional command-line options to use when running Chrome from PyCharm. For more information, open chrome://flags in the Chrome address bar.

Настройка PyCharm

Вот список полезных плагинов, которые стоит установить (источник):

• Highlight Bracket Pair – плагин позволяет не запутаться в излюбленном занятии программистов – поиске соответствия между открывающими и закрывающими скобками.
• Grep Console – расширение функционала стандартной консоли PyCharm – изменение цвета для разного типа сообщений, вкладки в консоли, аналог grep для вывода и т.д.
• Pylint – Python линтер. После установки появится меню «Pylint» в нижнем левом углу. Для работы плагина необходимо установить модуль pylint (python -m pip install pylint или python3 -m pip install pylint), и в настройках PyCharm указать путь до него (в Windows он обычно лежит в папке C:\ \Scripts, а в Linux путь до pylint можно узнать с помощью which pylint).
• DeepBugs – ищет потенциальные баги и проблемы, связанные с качеством кода используя модели машинного обучения.
• Python Smart Execute – комбинация Alt + Shift + A копирует выделенный код в Python-консоль и выполняет его.
• MyPy — плагин для проверки типов (type hinting) и анализатор исходного кода для Python. После установки появится меню «MyPy» в нижнем левом углу.
• CodeGlance – добавляет мини-карту (minimap) кода в окне редактора справа.

social

Powered by Pelican. Theme blueidea, inspired by the default theme.