Работа в IDE PyCharm (FAQ) + полезные фишки

Twitter, Pinterest, HP, Symantec, Groupon. Как думаете, что у них общего 🤔? Не сомневаюсь, ответ вам известен. Но помимо того, что это крупнейшие на мировом IT-рынке компании, есть и более специфичная деталь: те их сотрудники, кто программирует на языке Python, пишут свой код в среде разработки PyCharm.

Талантливые ребята из JetBrains разработали одну из наиболее используемых IDE в мире для этого языка программирования.

IDE PyCharm выбирают из-за его удобства, функционала, возможностей кастомизации и поддержки со стороны разработчиков.

В начале 2019 года компания JetBrains опросила почти 7000 разработчиков. 42% опрошенных, которые пишут на Python, выбрали PyCharm как основную IDE для своей работы.

Результаты опроса JetBrains по использованию IDE для работы с Python.

PyCharm кроссплатформенна и совместима с Windows, Linux и MacOS. Она поддерживает, как вторую, так и третью версию Питона и, кроме всего прочего, имеет красивый и функциональный UI.

Так выглядит интерфейс IDE PyCharm

Инструменты и функции, предоставляемые этой интегрированной средой, помогают Python-программистам быстро и эффективно писать код, синхронизироваться с системой контроля версий, использовать фреймворки и плагины, позволяя при этом настроить интерфейс так, как удобно самому пользователю и даже дают возможность дополнительного расширения IDE.

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

PyCharm анализирует ваш код в фоновом режиме, подсвечивает ошибки и подсказывает варианты их исправления.

Тут реализованы системы автодополнения и контроля качества кода в соответствии со стандартом PEP8. Всё для того, чтобы сделать текст ваших программ красивее, чище и структурированнее.

В интегрированной среде от JetBrains поддерживаются основные современные Python-фреймворки для веб-разработки, в ней вы сможете работать с Jupyter-notebook, подключать Anaconda, а также прочие библиотеки для научных вычислений и Data Science. Но, как говорится – "И это ещё не всё!". Помимо, собственно, питона, PyCharm отлично ладит и с другими языками программирования – JS, TypeScript-а, SQL или шаблонизаторами.

Системные требования

Официальные системные требования последней версии PyCharm выглядят так:

ОС:

  • Windows – Microsoft Windows 10 64-битили Windows 8 64-бит.
  • macOS – macOS 10.13 или выше.
  • Linux – среда GNOME или KDE;

RAM: не менее 2 ГБ, но рекомендуется 8 ГБ;

Место на диске: установка потребует 2,5 ГБ, рекомендуется использование SSD;

Разрешение экрана: не менее 1024x768 пикселей;

Python: Python 2.7, Python 3.5 или более поздняя версия;

При этом разработчики обращают внимание пользователей macOS и Linux на то, что JBR 11 поставляется в комплекте с PyCharm, и дополнительно устанавливать Java им не нужно.

В самих системных требованиях нет ничего особенного, однако хочется отметить, что IDE прекрасно себя чувствует и на Windows 7, а к рекомендациям по поводу 8 ГБ оперативной памяти и использования SSD стоит тщательным образом прислушаться, не прогадаете 😉.

Как установить

Процесс установки вкратце описан на официальном сайте для каждой из поддерживаемых ОС:

На Windows

  1. Запускаете файл pycharm.exe.
  2. Следуете инструкциям инсталл-мастера.
  3. Выбираете нужные параметры установки.
  4. Готово.

На Mac OS

  1. Сперва следует скачать файл pycharm.dmg.
  2. Затем смонтировать диск в вашей системе.
  3. И, наконец, необходимо скопировать PyCharm в Applications.

На Linux

  1. Файл pycharm.tar.gz нужно скопировать в выбранную папку.
  2. Обязательно убедитесь, что у вас есть права доступа RW для данного каталога.
  3. Распакуйте pycharm.tar.gz используя команду: tar -xzf pycharm-2020.1.2.tar.gz
  4. Будьте внимательны: архив НЕЛЬЗЯ РАСПАКОВЫВАТЬ в папку с существующей инсталляцией.
  5. Теперь можно запустить pycharm.sh из каталога bin.

Подготовка к работе и настройка

Перед тем, как приступить к разработке в PyCharm, вам нужно создать проект, поскольку все дальнейшие манипуляции будут происходить именно в нём и на его основе.

Чтобы начать новый проект, нажмите New Project и придумайте ему имя. Теперь можно приступить к настройке.

Чтобы начать новый проект, нажмите "New Project"

Настройки интерфейса

Несмотря на то, что разработчики из JetBrains начинали свой путь в России, смена языка интерфейса в среде разработки не предусмотрена, поэтому к вашим услугам будет лишь родной язык Уильяма Шекспира.

Зато вы можете изменить сами шрифты и их размеры, пройдя по пути:

File -> Settings -> editor -> font

Поменять цветовую схему UI:

File -> Settings -> editor -> color scheme

И сконфигурировать множество других аспектов, вроде общих настроек, конфигураций прокрутки, настроек цвета для каждого доступного языка и так далее. Для всего этого есть редактор:

file -> settings -> editor
Общие настройки редактора находятся в file -> settings -> editor

Настройка интерпретатора

Скачать интерпретатор вы можете с официального сайта Python. Если в ваши планы не входит работа с библиотеками, которые есть только во второй версии языка, то стоит качать последний релиз Python 3.

flash
О том, как установить Python:

Для использования установленного интерпретатора, выберите его в настройках:

File -> Settings -> Project:<name> -> Project Interpreter
Настройка интерпретатора в Pycharm (file -> settings -> Project:<name> -> Project Interpreter)

💭 Если PyСharm не видит интерпретатор, попробуйте добавить его вручную. Для этого:

  1. Нажмите на шестеренку в верхнем правом углу, выберите "Add..".
  2. Далее выберите "System Interpreter";
  3. Нажмите на 3 точки "..." справа от поля в выбором интерпретатора;
  4. Укажите путь до интерпретатора.
Добавление вручную нового интерпретатора в PyCharm

Настройка виртуального окружения

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

Venv – это, грубо говоря, директория, содержащая ссылку на интерпретатор и набор установленных библиотек. Виртуальное окружение “изолирует” ваши проекты, и помогает, в частности, не запутаться в разных версиях библиотек, адаптированных для каждого из них по отдельности.

flash
Подробнее про виртуальное окружение:

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

File -> Settings -> Project:<name> -> Project Interpreter

Также в этом меню можно создать виртуальные окружения с нуля. Для этого:

  • Нажмите на шестеренку в верхнем правом углу, выберите "Add..".
  • Выберите "Virual Enviroment" и задайте параметры.
Создание виртуального окружения средствами PyCharm ()

Venv создано и готово к работе 👌.

Окружение Pipenv создается аналогичным образом

Запуск скриптов в консоли

Чтобы запустить код в PyCharm, нужно выбрать интерпретатор в настройках (как это сделать я писал чуть выше).

Также, перед запуском своего кода в PyCharm необходимо добавить конфигурацию (чтобы IDE понимал, какой файл ему запускать и по каким правилам). Изначально, если проект новый, конфигурации нет, и кнопка запуска не активна.

В новом проекте кнопка запуска не активна, т.к конфигурации для запуска отсутствуют.

Чтобы запустить код в новом проекте, зайдите в

Run -> Run

или выполните комбинацию:

Alt + Shift + F10
Для запуска кода в PYCharm выберите

Откроется диалоговое окно в выбором файла, который необходимо запустить.

Диалоговое окно с выбором вариантов запуска

После запуска, откроется терминал, в котором вы увидите результат выполнения своего скрипта и сообщение о том, что процесс завершился с кодом 0 (0 означает успешное завершение).

Результат выполнения скрипта вы увидите в окне "Run", которое откроется снизу.

Далее, когда конфигурация создана и сохранена, запускать свой код на выполнения можно комбинацией:

Shift + F10

☝️ Если скрипт не запускается, возможно вы не сохранили конфигурацию или PyCharm не видит интерпретатор. Настроить или создать конфигурацию можно в меню "Edit Configurations..", которое находится сверху справа, около кнопки "Run".

Есть еще один способ запуска кода:

  • Внизу окна программы кликните на "Terminal".
  • Напишите в терминале python <name>.py или python3 <name>.py.
Альтернативный вариант запуска Python-кода – через встроенный терминал.

💁‍♂️ В целях обучение, вам может понадобиться быстро писать и проверять Python-инструкции. Для этого в PyCharm-е реализован интерактивный режим (по аналогии с IDLE). Чтобы его вызвать, достаточно нажать на "Python Conole" внизу слева.

PyCharm умеет запускать Python-код в интерактивном режиме

Отладчик (debugger) в Pycharm

Отладка – чрезвычайно полезный инструмент. С помощью него можно пошагово исполнять программный код. Интерпретатор переходит в особый режим, фиксируя на каждом этапе выполнения текущее состояние программы. Т.е. для каждой строки кода вам будет представлен мини-отчёт, в котором можно посмотреть актуальные значения всех переменных и проследить таким образом весь процесс их изменения.

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

Для старта отладки, нужно поставить так называемую точку останова. Это красный кружок напротив строки кода.

Для отладки кода выберите точку останова (красный кружок напротив нужной строки)

Вы можете установить её где захотите, но чаще всего точку следует ставить там, где интерпретатор увидел ошибку.

Для запуска кода в режиме отладки нажмите на значок в "жука" в левом верхнем углу:

Значок "зеленый жук" запустит код в режиме отладки

Или выполните комбинацию:

Shift + F9

Отладка началась.

Запустив код в режиме отладки, откроется окно "Debug" с информацией о ходе выполнения и текущем состоянии.

Теперь, нажимая F8, можно последовательно шагать по строчкам кода и смотреть текущее состояние всей программы.

"Шагать" можно и через F7, но в таком случае дебаггер будет совершать "Шаг с заходом". Т.е. при встрече вызова функции он будет заходить в её описание и последовательно проходить по инструкциям.

Все варианты навигации в режиме отладки можно посмотреть в окне "Debugger":

Кнопки навигации в режиме отладки в PyCharm

Для каждой кнопки существует свой hotkey – чтобы увидеть его, достаточно навести курсор на нужную кнопку.

Deploy на удаленный хост

Развернуть и отправить код на сервер возможно прямиком из PyCharm.

Инструмент не доступен в бесплатной комьюнити-версии

Чтобы добавить удалённый сервер, первым делом перейдём в:

Tools -> Deployment -> Configuration

Здесь сначала вводим имя, а затем настраиваем данные сервера. Потом вводим имя и пароль пользователя и проверяем соединение при помощи кнопки Test Connection.

Для проверки соединения с удаленным хостом нажмите "Test Connection".

Переключаемся на следующую вкладку под названием Mappings. Мапы здесь – это соответствия между путями на вашем компьютере и путями на сервере. Производим и применяем настройки.

Во вкладке Mapping – соответствия между путями на вашем компьютере и путями на сервере.

Теперь можно производить deploy:

Tools -> Deployment -> Upload to <your_host_name>

💡 Лайфхак: для удобной работы можно настроить автоматический деплой на удаленный сервер после каждого "сохранения". Для этого перейдите в Tools -> Deployment -> Options и выберите On explicit save action (Ctrl + S).

Автоматический deploy на сервер по умолчанию в IDE PyCharm

Макросы

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

Чтобы создать или настроить свой собственный макрос, вам нужно выбрать:

Edit -> Macros -> Start Macro Recording

После записи макроса, нажмите Stop Macro Recording.

Полезные хоткеи и фишки

Как поменять цвет консоли в pycharm. Поменять цвет консольного бэкграунда или шрифтов предельно просто: для этого нужно всего лишь зайти в настройки цветовой схемы и изменить их так, как того пожелает ваш внутренний дизайнер:

File -> Settings -> Editor -> Color Scheme

Поиск по всему проекту.

  • Для поиска по коду во всем проекта, выполните комбинацию Ctrl + Shift + F.
  • Для поиска всего и вся во всём проекте дважды нажимаем клавишу Shift.

Хоткеи по запуску и дебаггингу. С помощью комбинации клавиш Shift + F10 можно запустить ваш проект, а нажав Shift + F9 – начать его отладку.

Закомментировать сразу несколько строк. Комментирование кода ещё никогда не было таким простым: вы мышкой выделяете нужные строки, а затем нажимаете Ctrl + /.

Повторив то же самое действие на том же самом месте, вы выполните раскомментирование кода.

Отступы.

  • Отступ – Tab.
  • Для нескольких строк выделите нужные строки и нажмите Tab.
  • Для обратного отступа (отступа в левую сторону) – Shift + Tab.

Некоторые горячие клавиши.

  • Ctrl + Alt + L – автоформатирование кода по PEP 8.
  • Ctr + Z – отмена последнего выполненного действия.
  • Ctr + Up/Down – прокрутка без изменения позиции курсора.
  • Ctr + D – дублировать строку.
  • Tab / Shift + Tab – увеличить / уменьшить отступ.
  • Ctr + Space – выводит предложения по автозаполнению.
Тут шпаргалка по хоткеям в Pycharm.

ТОП 7 полезных плагинов для Pycharm

Меню установки плагинов находится в:

File -> Settings -> Plugins

Для установки плагина достаточно написать его название в строке поиска, найти плагин и нажать "Install".

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

  • Highlight Bracket Pair (описание) – плагин позволяет не запутаться в излюбленном занятии программистов – поиске соответствия между открывающими и закрывающими скобками.
  • Grep Console (описание) – расширение функционала стандартной консоли PyCharm – изменение цвета для разного типа сообщений, вкладки в консоли, аналог grep для вывода и т.д.
  • Pylint (описание) – Python линтер. После установки появится меню "Pylint" в нижнем левом углу. Для работы плагина необходимо установить модуль pylint (python -m pip install pylint или python3 -m pip install pylint), и в настройках PyCharm указать путь до него (в Windows он обычно лежит в папке C:\<python_path>\Scripts, а в Linux путь до pylint можно узнать с помощью which pylint).
  • DeepBugs for Python – ищет потенциальные баги и проблемы, связанные с качеством кода используя модели машинного обучения.

Другие полезные плагины:

  • Python Smart Execute (описание) – комбинация Alt + Shift + A копирует выделенный код в Python-консоль и выполняет его.
  • MyPy (описание) - плагин для проверки типов (type hinting) и анализатор исходного кода для Python. После установки появится меню "MyPy" в нижнем левом углу.
  • CodeGlance (описание) – добавляет мини-карту (minimap) кода в окне редактора справа.

Что делать, если PyCharm не видит модули Python?

Если у вас возникла подобная проблема, то в первую очередь стоит проверить настройки интерпретатора.

Вариант №1 – сброс настроек и выборе новой версии интерпретатора. Настройки находятся тут:

Settings -> Project:<project_name> -> Project Interpreter

Вариант №2 – По умолчанию PyCharm ищет модули начиная от корня проекта. Подскажите PyCharm, где находится директория с вашими модулями. Для этого в проводнике слева щелкните по директории (правой кнопкой мыши), и в контекстном меню выберите Mark Directory As -> Sources Root.

😭
😕
😃
😍