Как работать на pycharm в windows

Содержание:развернуть

• Системные требования
• Как установить

• На Windows

• На Mac OS

• На Linux

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

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

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

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

• Запуск скриптов в консоли
• Отладчик (debugger) в Pycharm
• Deploy на удаленный хост
• Макросы
• Полезные хоткеи и фишки
• ТОП 7 полезных плагинов для Pycharm
• Что делать, если PyCharm не видит модули Python?

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

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

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

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

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

В 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;

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

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 и придумайте ему имя. Теперь можно приступить к настройке.

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

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

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

File -> Settings -> editor -> font

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

File -> Settings -> editor -> color scheme

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

file -> settings -> editor

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

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

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

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

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

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

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

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

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

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

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

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

• Нажмите на шестеренку в верхнем правом углу, выберите «Add..«.
• Выберите «Virual Enviroment» и задайте параметры.

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

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

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

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

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

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

Run -> Run

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

Alt + Shift + F10

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

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

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

Shift + F10

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

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

• Внизу окна программы кликните на «Terminal«.
• Напишите в терминале python <name>.py или python3 <name>.py.

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

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

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

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

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

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

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

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

Shift + F9

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

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

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

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

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

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

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

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

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

Tools -> Deployment -> Configuration

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

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

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

Tools -> Deployment -> Upload to <your_host_name>

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

Макросы

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

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

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.

if __name__ == '__main__':
    print('Hello, world!')

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

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

Шаг 0. Прежде чем вы начнете

На каких языках поддерживается PyCharm?

С PyCharm вы можете разрабатывать приложения на Python. Кроме того, в Professional Edition можно разрабатывать приложения Django, Flask и Pyramid. Кроме того, он полностью поддерживает HTML (включая HTML5), CSS, JavaScript и XML: эти языки включены в IDE через плагины и включены для вас по умолчанию. Поддержка других языков и фреймворков также может быть добавлена ​​через плагины (перейдите к Settings | Plugins или PyCharm | Preferences | Plugins для пользователей MacOS, чтобы узнать больше или установить их во время первого запуска IDE).

File / Settings / Plugins

На каких платформах я могу запустить PyCharm?

PyCharm — это кросс-платформенная среда разработки, работающая в Windows, MacOS и Linux. Если вам нужна помощь в установке PyCharm, см. Инструкции по установке для Linux , macOS и Windows .

Шаг 1. Откройте / создайте проект в PyCharm

Зачем мне нужен проект?

Все, что вы делаете в PyCharm, выполняется в контексте проекта. Он служит основой для поддержки кодирования, рефакторинга, согласованности стиля кодирования и т.д.

У вас есть три варианта начать работу над проектом внутри среды IDE:

1. Открыть существующий проект

Начните с открыв один из ваших существующих проектов, хранящихся на вашем компьютере. Вы можете сделать, нажав Открыть проект (Open )на экране приветствия (или File | Open):

Светлый интерфейс

Темный интерфейс

Или выберите Open в меню File и укажите каталог, в котором находятся ваши источники:

PyCharm File/Open

Затем PyCharm создаст для вас проект из ваших источников.

Смотрите также. Раздел Импорт проекта из существующего исходного кода.

2. Создать проект с нуля

Если вы предпочитаете начинать с нуля, нажмите New Project и на открывшемся экране введите имя проекта в диалоговом окне и будет создан проект Python.

File / New Project

Смотрите также. Раздел Создание и управление проектами

Шаг 2. Ознакомьтесь с интерфейсом

Когда вы запускаете PyCharm в первый раз или когда нет открытых проектов, вы видите Экран приветствия . Он предлагает вам основные точки входа в среду IDE: создание или открытие проекта , проверка проекта с помощью контроля версий,просмотр документации и настройка среды IDE.

Когда проект открывается, вы видите главное окно, разделенное на несколько логических областей. Давайте рассмотрим ключевые элементы пользовательского интерфейса здесь:

Интерфейс PyCharm (тёмный)

Интерфейс PyCharm (светлый)

1. Project Tool Window. Панель инструментов проекта. В этом окне отображаются файлы вашего проекта.
2. PyCharm Editor. Редактор PyCharm. Находится с правой стороны, где вы пишете свой код. В нем есть вкладки для удобной навигации между открытыми файлами.
3. Navigation Bar. Панель навигации. Находится над редактором, позволяет быстро запускать и отлаживать ваше приложение, а также выполнять процедуры контроля версий VCS.
4. Left gutter. Левый столбец, вертикальная полоса рядом с редактором, показывает брекпоинты и обеспечивает удобный способ перехода по иерархии кода. Он также отображает номера строк и историюVCS.
5. Right gutter. Правый столбец, справа от редактора. PyCharm постоянно контролирует качество вашего кода и постоянно показывает результаты проверки в правом столбце: ошибки, предупреждения и т.д. Индикатор в правом верхнем углу показывает общий статус проверки кода для всего файла.
6. PyCharm Tool Windows. Панель инструментов PyCharm. Это специальные окна, прикрепленные к низу и сторонам рабочей области, которые обеспечивают доступ к типичным задачам, таким как управление проектами, поиск и навигация по исходному коду, интеграция с системами контроля версий и т.д.
7. Status Bar. Строка состояния. Указывает состояние вашего проекта и показывает различные предупреждения и информационные сообщения.

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

Эта кнопка переключает показ панелей инструментов

Переключение между панелями

Шаг 3. Настройте свою среду

Вы можете настроить среду IDE, чтобы она идеально соответствовала вашим потребностям и была удобна для Вас. Зайдите в меню File / Settings, чтобы просмотреть список доступных параметров настройки.

File / Settings PyCharm

Settings PyCharm

Внешний вид IDE

Первое, что нужно подстроить, — это общий «внешний вид». Зайдите в меню File / Settings / Appearance and Behavior /Appearance, чтобы выбрать Тему IDE : тема по умолчанию, или Dracula, если вы предпочитаете более темную настройку:

File / Settings / Appearance and Behavior /Appearance

Редактор

Множество вкладок, доступных в меню File / Settings / Editor помогут вам настроить каждый аспект поведения редактора. Здесь доступно множество опций, начиная с общих настроек (например, с помощью функции Drag’n’Drop, конфигурации прокрутки и т.д.). Для настройки цвета для каждого доступного языка и варианта использования, для вкладок и настроек свертки кода, для поведения завершения кода и.т.д.

File / Settings / Editor

Стиль кода

Стиль кода может быть определен для каждого языка File / Settings / Editor / Code Style. Вы также можете создать и сохранить свой собственный стиль кода.

File / Settings / Editor / Code Style

Раскладка

PyCharm использует подход, ориентированный на клавиатуру, что означает, что почти все действия, доступные в среде IDE, сопоставляются с комбинациями клавиш.

Горячие клавиши, с которыми вы работаете, — одна из ваших личных привычек — ваши пальцы «помнят» определенные комбинации клавиш, и изменить эти привычки достаточно сложно.

PyCharm предоставляет вам стандартную раскладку (выберите Help / Keymap Reference в главном меню), делая ваше кодирование действительно продуктивным и удобным. Однако вы всегда можете её изменить File / Settings / Keymap

Help / Keymap Reference

PyCharm Default keymap

File / Settings / Keymap

Также есть некоторые предварительно определенные раскладки клавиатуры (такие как Emacs, Visual Studio, Eclipse, NetBeans и т.д.), И вы также можете создать свою собственную раскладку на основе существующей.

Некоторые предварительно определенные раскладки клавиатуры

Завершение кода

Автозаполнение кода ( Auto-Completing Code) — отличная экономия времени, независимо от типа файла, с которым вы работаете. Завершение работает по мере ввода и завершения любого имени мгновенно.

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

Auto-Completing Code PyCharm

Intention Actions

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

Intention Actions

Полный список доступных Intention Actions можно найти в File / Settings / Editor / Intentions

File / Settings / Editor / Intentions

Шаг 5. Сделайте свой код аккуратным

PyCharm контролирует ваш код и пытается сохранить его точным и чистым. Он обнаруживает потенциальные ошибки и проблемы и предлагает быстрые исправления (quick-fixes) для них.

Каждый раз, когда среда IDE находит неиспользованный код, бесконечный цикл и многое другое, что , вероятно, потребует вашего внимания, вы увидите лампочку. Щелкните по ней или нажмите Alt+Enter, чтобы применить исправление.

Полный список доступных проверок можно найти в разделе меню File / Settings / Editor / Inspections. Отключите некоторые из них или включите другие, а также настройте степень серьезности каждой проверки. Вы решаете, следует ли считать это ошибкой или просто предупреждением.

File / Settings / Editor / Inspections

Шаг 6. Создание кода

Написание кода может быть намного проще и быстрее, если вы используете варианты генерации кода, доступные в PyCharm. The Code / Generate ( Alt+Insert) поможет вам создать символы, а также предложит переопределить / реализовать некоторые функции:

Pycharm – Введение

PyCharm – самая популярная среда разработки, используемая для языка сценариев Python. В этой главе вы познакомитесь с PyCharm и объясните его особенности.

PyCharm предлагает некоторые из лучших функций для своих пользователей и разработчиков в следующих аспектах –

• Завершение кода и проверка
• Расширенная отладка
• Поддержка веб-программирования и фреймворков, таких как Django и Flask

Особенности PyCharm

Кроме того, разработчик найдет PyCharm удобным для работы из-за функций, упомянутых ниже –

Завершение кода

PyCharm обеспечивает более плавное завершение кода, как для встроенного, так и для внешнего пакета.

SQLAlchemy as Debugger

Вы можете установить точку останова, сделать паузу в отладчике и увидеть SQL-выражение пользовательского выражения для кода языка SQL.

Git Visualization в редакторе

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

Покрытие кода в редакторе

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

Управление пакетами

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

Местная история

Local History всегда отслеживает изменения таким способом, который дополняет Git. Локальная история в PyCharm дает полную информацию о том, что необходимо для отката и что нужно добавить.

Рефакторинг

Рефакторинг – это процесс переименования одного или нескольких файлов одновременно, и PyCharm включает в себя различные сочетания клавиш для плавного процесса рефакторинга.

Пользовательский интерфейс редактора PyCharm

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

На скриншоте, показанном выше, вы можете увидеть недавно созданный проект Demo и папку site-packages для управления пакетами вместе с различными другими папками.

Вы можете скачать редактор PyCharm и ознакомиться с его официальной документацией по этой ссылке – https://www.jetbrains.com/pycharm/

Pycharm – Установка

В этой главе вы подробно узнаете о процессе установки PyCharm на ваш локальный компьютер.

Вовлеченные шаги

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

Шаг 1

Загрузите требуемый пакет или исполняемый файл с официального сайта PyCharm https://www.jetbrains.com/pycharm/download/#section=windows. Здесь вы увидите две версии пакета для Windows, как показано на приведенном ниже снимке экрана.

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

Шаг 2

Загрузите пакет сообщества (исполняемый файл) в свою систему и укажите папку назначения, как показано ниже –

Шаг 3

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

Шаг 4

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

Это помогает в создании нового проекта Python, где вы можете работать с нуля. Обратите внимание, что в отличие от других IDE, PyCharm фокусируется только на работе с проектами языка сценариев Python.

Pycharm – Понимание Основ

В этой главе будут обсуждаться основы PyCharm и вы будете чувствовать себя комфортно, чтобы начать работать в редакторе PyCharm.

Когда вы запускаете PyCharm в первый раз, вы видите экран приветствия с точками входа в IDE, такими как –

• Создание или открытие проекта
• Извлечение проекта из системы контроля версий
• Просмотр документации
• Настройка IDE

Напомним, что в предыдущей главе мы создали проект с именем demo1, и мы будем ссылаться на один и тот же проект на протяжении всего этого урока. Теперь мы начнем создавать новые файлы в том же проекте, чтобы понять основы PyCharm Editor.

Приведенный выше снимок экрана описывает обзор проекта demo1 и варианты создания нового файла. Давайте создадим новый файл с именем main.py.

Код, включенный в main.py, выглядит следующим образом:

y = 3

def print_stuff():
   print ("Calling print_stuff")
   print (y)
   z = 4
   print (z)
   print("exiting print_stuff")
	
print_stuff() # we call print_stuff and the program execution goes to (***)
print(y) # works fine
print (z) # NameError!!!

Код, созданный в файле main.py с помощью PyCharm Editor, отображается, как показано ниже –

Этот код можно запустить в среде IDE. Основная демонстрация запуска программы обсуждается ниже –

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

Pycharm – Keymaps

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

Вы можете найти список раскладок клавиш, доступных в меню « Справка» -> «Справочник раскладок», как показано на скриншоте ниже –

Вы можете найти список раскладок и доступные сочетания клавиш в формате PDF, как показано ниже –

Примечание. Таблица ключей по умолчанию для операционных систем Windows и Linux используется по умолчанию, а в Mac OS по умолчанию используется таблица ключей OSX 10.5.

Вы также можете просмотреть список раскладок клавиш, используя параметр « Настройки» в операционной системе Windows и Linux («Настройки в Mac OS»), как показано на приведенном ниже снимке экрана:

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

Pycharm – ярлыки

Сочетания клавиш – это комбинации клавиш, используемые для выполнения ряда действий. Вы можете найти список ярлыков PyCharm в справочнике по Keymaps.

В поисках ярлыка

Список ярлыков доступен в следующем меню « Справка» -> «Найти действие», где он появляется с окном ярлыков.

Вы можете увидеть контекстное окно, как показано здесь –

Ярлык включает в себя список идентификаторов, ярлыки с функциями и строку меню параметров. Например, панель навигации «Вид» включает в себя кнопки «ВКЛ» и «ВЫКЛ», которые отображают панель навигации в соответствии с установленным значением (ВКЛ и ВЫКЛ).

Пихарм – Омни

Omni – это раздел в PyCharm, который работает в любом месте и в любом месте. Он включает в себя различные инструменты для перемещения пользователя из одного места в другое. Это помогает в таком сценарии, что вам нужно быстро перейти из одного каталога проекта в другой. Эта глава познакомит вас с функциональностью Omni.

Функциональности

Меню Navigate описывает функции, задействованные в Omni. В этом разделе они подробно обсуждаются –

Учебный класс

Это помогает перемещаться из одного класса в другой в упомянутом проекте. Это очень полезно для навигации по списку классов.

назад

Эта опция помогает вернуться назад из существующего состояния. Сочетание клавиш – Ctrl + Alt + Left .

Вперед

Работает аналогично заднему варианту. Тем не менее, функциональность полностью наоборот.

Pycharm – Макросы

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

Перейдите Макрос

Посмотрите на следующий снимок экрана для лучшего понимания макроса Navigate –

Навигация -> Объявление помогает показать объявление, объявление типа и определить супер методы. Различные атрибуты, включенные в объявление типа, показаны ниже –

Однако есть проблема с этим макросом, если пользователь пытается перейти к объявлению объекта .so, например, переходя от модуля datetime к модулю выбора , тогда каждый раз, когда он сталкивается с заглушкой .

Искать везде

Это помогает искать классы и связанные методы. Он также включает в себя возможность поиска с помощью Google.

Каждая из этих частей содержит комбинацию клавиш рядом с названием раздела. Поиск везде – это ворота к другим поисковым действиям, доступным в PyCharm.

Пихарм – Микро

Микро занимаются получением мест в указанном файле. Эти инструменты используют большую часть процедуры разработки. В этой главе вы подробно изучите Micro.

Рассмотрим пример Структурной панели, которая используется для представления микро.

Прокрутка от источника

Это помогает прокручивать от упомянутого источника как полное местоположение папки указанного файла.

Свернуть все

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

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

Показать меню настроек

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

Список опций отображается ниже –

Спрятать

Эта опция помогает скрыть панель структуры окна проекта. Пользовательский интерфейс панели структуры после свертывания показан ниже.

Вы можете снова открыть панель структуры, как показано здесь –

Pycharm – улучшение и написание кода

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

Улучшение дополнения кода

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

message = 'GIEWIVrGMTLIVrHIQS' #encrypted message
LETTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'

for key in range(len(LETTERS)):
   translated = ''
	
   for symbol in message:
      if symbol in LETTERS:
         num = LETTERS.find(symbol)
         num = num - key
         if num < 0:
            num = num + len(LETTERS)
         translated = translated + LETTERS[num]
      else:
         translated = translated + symbol
   print('Hacking key #%s: %s' % (key, translated))

Код завершается с использованием следующей конструкции –

Если вы нажмете Ctrl + пробел, когда это всплывающее окно находится на экране, вы увидите больше вариантов завершения кода –

Намеренные действия

PyCharm включает определенные намерения действия, и комбинация клавиш для того же самого – Alt + Enter . Наиболее важным примером намерений в работе является использование языкового внедрения в строках.

На приведенном ниже снимке экрана показано действие намеренных действий –

Обратите внимание, что мы можем вставить много разных языков намеренных действий в PyCharm Editor.

Pycharm – Консоль

PyCharm имеет полноценную консоль Python с полным завершением кода, которая доступна в меню параметров Инструменты -> Запустить консоль Python.

Рассмотрим код, который был упомянут в предыдущей главе, как показано ниже –

message = 'GIEWIVrGMTLIVrHIQS' #encrypted message
LETTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
for key in range(len(LETTERS)):
   translated = ''
   for symbol in message:
      if symbol in LETTERS:
         num = LETTERS.find(symbol)
         num = num - key
         if num < 0:
            num = num + len(LETTERS)
         translated = translated + LETTERS[num]
      else:
         translated = translated + symbol
   print('Hacking key #%s: %s' % (key, translated))

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

Вы можете наблюдать результат, как показано ниже –

Pycharm – переводчики

PyCharm включает в себя переводчиков для создания нового проекта с новыми функциями по мере необходимости. Вы можете создать виртуальную среду в своей системе так, как вам это нужно. Вы также можете наследовать глобальные пакеты сайтов в диалоговом окне. Интерпретаторы доступны в Python Package Index (PyPI) и могут быть легко установлены и доступны с помощью pip install.

Создание переводчика

Для создания интерпретатора всегда рекомендуется создать новый проект, в котором будут управляться требуемые конфигурации. Посмотрите на следующий скриншот для лучшего понимания –

Эти параметры включают в себя –

• Местоположение – описывает параметр, в котором создается виртуальная среда, ориентируясь на местоположение в системе.

• Базовый интерпретатор – определяет атрибуты интерпретатора.

Местоположение – описывает параметр, в котором создается виртуальная среда, ориентируясь на местоположение в системе.

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

Детали Project Interpreter и базовую конфигурацию существующего проекта demo1 можно увидеть, как показано ниже –

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

Pycharm – отладка и точки останова

Запуск кода Python состоит из двух режимов: запуск сценария и отладка сценария. Эта глава посвящена отладке скрипта Python с использованием PyCharm.

Вовлеченные шаги

Шаги для отладки проекта Python описаны ниже:

Шаг 1

Начните с отладки проекта Python, как показано на скриншоте ниже –

Шаг 2

Теперь брандмауэр Windows запрашивает разрешение на отладку проекта Python, поскольку процедура включает построчную компиляцию.

Шаг 3

Консоль отладки создается в редакторе PyCharm, как показано ниже, который выполняет вывод построчно.

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

Понимание точек останова

При отладке конкретного сценария намеренно создается точка останова. Точки останова – это место преднамеренного останова или место, где код приостановлен, чтобы идентифицировать результат на определенной стадии.

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

Pycharm – интеграция контроля версий

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

Вовлеченные шаги

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

Инициализация системы управления Subversion

Чтобы систематически запускать систему контроля версий, важно ее инициализировать. В PyCharm доступны различные опции для разных систем контроля версий.

Игнорирование файла

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

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

Конфигурация GitHub

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

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

Pycharm – интеграция HTML и CSS

HTML и CSS хорошо поддерживаются в редакторе PyCharm. PyCharm Editor включает в себя специальные сокращения и обеспечивает завершение тегов для HTML.

муравей

Emmet – сокращение, используемое в редакторе PyCharm. Он включает в себя различные функции, такие как предварительный просмотр аббревиатуры, автоматическое распознавание URL и точки редактирования для файлов HTML и CSS. Пользовательский интерфейс раздела настроек показан на снимке экрана, представленном ниже –

Создание файлов HTML и CSS

PyCharm включает в себя встроенную функцию для создания файлов HTML и CSS. Основные шаги для создания новых файлов HTML и CSS:

Теперь упомяните имя файла при создании файлов HTML в проекте, как показано ниже –

Это создает файл sample-file.html, как показано ниже –

Создание CSS файла

Шаги для создания файла CSS показаны здесь –

В меню « Новый» выберите « Файл», как показано ниже.

Укажите имя CSS во время его создания, как показано здесь –

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

Pycharm – поддержка JavaScript

В этой главе мы сосредоточимся на основных функциях использования JavaScript в редакторе PyCharm. Когда пользователь реализует библиотеку JavaScript через URL, PyCharm намеревается загрузить локальную копию, чтобы ее можно было использовать для завершения и анализа кода.

Рассмотрим пример кода нашего HTML-файла, как показано ниже, который мы создали в предыдущей главе –

Для каждого HTML-файла или JavaScript-файла вы можете проверить внешние библиотеки, загруженные через конфигурацию настроек PyCharm Editor. Посмотрите на скриншот, показанный ниже, для лучшего понимания –

Обратите внимание, что вы не сможете увидеть какую-либо библиотеку, если не загрузите и не внедрите ее. PyCharm также включает поддержку JavaScript различных библиотек через набор инструментов под названием JS Toolbox . Следующий скриншот показывает это.

Он также включает в себя различные атрибуты, которые необходимы для конфигурации файла JavaScript. Список атрибутов и конфигураций показан ниже –

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

Pycharm – Советы

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

В этой главе вы увидите некоторые важные советы PyCharm.

Изменение файла в определенный список изменений

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

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

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

Чтобы найти команду меню для действия

Этот совет помогает найти команду меню для определенного действия, а сочетание клавиш для него – Ctrl + Shift + A. Пользователь может выбрать желаемое действие из упомянутого списка предложений.

Выполнение проверки через код

Этот совет помогает в проведении конкретной проверки через код. Сочетание клавиш для того же – Ctrl + Alt + Shift + I.

Укажите список настроек

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

Запустить / отладить файлы сценариев

Этот совет очень полезен для запуска или отладки файлов скриптов, к которым вы можете получить доступ через главную панель инструментов. Сочетание клавиш для того же – Alt + Shift + F10 .

Pycharm – инструменты для баз данных

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

Добавление источника данных

Важно помнить, что PyCharm поддерживает широкий спектр соединений с базами данных.

Шаг 1

Откройте окно инструмента базы данных View -> Tool Windows -> Database> и откройте диалоговое окно под названием Data Sources and Dialog .

Теперь выберите базу данных MySQL для добавления нового источника данных.

Шаг 2

Пользователь должен загрузить отсутствующие файлы драйвера, чтобы получить правильное соединение с базой данных MySQL .

Шаг 3

Теперь укажите параметры конфигурации для достижения соединения.

Хост – если сервер базы данных находится на другом компьютере, замените localhost на IP-адрес хоста сервера, например, 172.20.240.163.

Порт – Порт сервера MySQL по умолчанию – 3306. Если ваш сервер использует другой порт, укажите этот порт.

Имя пользователя и пароль – это необходимые учетные данные.

Шаг 4

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

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

Pycharm – экспорт данных

PyCharm IDE включает в себя различные функции для преобразования существующего файла кода в формат HTML или CSV. В этой главе вы научитесь экспортировать данные с помощью PyCharm IDE.

Настройки экспорта редактора PyCharm показаны на рисунке ниже –

Функция экспорта в HTML

Эта функция помогает в экспорте определенного файла в формате HTML. Это сделано для улучшения целей безопасности данного модуля. Следующий скриншот дает лучшее понимание –

Как только операция экспорта будет успешной, сгенерированный файл HTML будет отображаться в выводе браузера, как показано ниже –

Теперь, если вы проверите HTML-код, сгенерированный после операции экспорта, вы можете заметить, что для выполнения этой операции также включены номера строк.

Pycharm – веб-фреймворки

Эта глава посвящена веб-фреймворкам и их развертыванию. PyCharm имеет простую функциональность для развертывания кода и файлов. Чтобы развернуть код с помощью PyCharm, нам нужно добавить веб-сервер с настройками параметров меню -> Построить, Выполнить -> Развертывание .

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

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

Код можно развернуть, используя Сервис -> Развертывание в строке меню Инструменты.

Развертывание в PyCharm очень детально: пользователь может развернуть один файл или весь исходный код.

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

Пихарм – Джанго

Одной из особенностей PyCharm является то, что он включает в себя поддержку Django. Благодаря возможности включения функций JavaScript в PyCharm, он может считаться лучшей IDE для Django.

Основные шаги по созданию проекта Django в PyCharm IDE приведены ниже –

Если опция EnableDjangoadmin включена, PyCharm настроит для вас сайт администратора.

Отладка шаблона

Отладка работает с шаблонами Django и Jinja. Мы можем проверять переменные, проходить через код и делать то, что ожидаем, в отладчике.

Пихарм – Пирамида

Вы можете создать проект Pyramid Framework в редакторе PyCharm, используя его окно приветствия.

Пользователь может установить интерпретатор проекта и местоположение Python, выбрав каркас и язык шаблонов по умолчанию. Каркас в платформе Pyramid использует диспетчеризацию URL-адресов для сопоставления URL-адресов и для просмотра кода и SQLAlchemy для свойств персистентности.

Редактор PyCharm запросит у пользователя список необходимых пакетов в файле setup.py и предложит пользователю загрузить требуемые пакеты.

Установите проект в режиме разработки (для получения более подробной информации обратитесь к официальной документации Pyramid). Пользователь должен запустить python setup.py через меню Сервис -> Запустить опцию setup.py .

Пользователь должен выбрать задачу разработки при запуске файла .py, как указано в окне ниже –

Важно инициализировать базу данных, используя консольный скрипт с именем initialize <имя_проекта>, используя следующую команду:

initialize_pyramiddemo_db development.ini

Пользователь может запустить сервер, запустив проект, который покажет результат, как показано ниже –

Пихарм – Колба

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

Вы можете запустить проект, используя Run -> Run ‘<имя-проекта>’ .

Вы также можете добавить новый источник данных с этой структурой. Давайте создадим файл с именем squema.sql и добавим код SQL для создания некоторых таблиц. Редактор PyCharm распознает файлы и попросит вас настроить источник данных и установить диалект базы данных.

PyCharm позволит вам выбрать нужный диалект, который вы хотите использовать. Вы можете изменить свойства SQL: Настройки -> Язык и рамки -> Диалекты SQL

Для редактора склянок самый простой способ выполнить запрос SQL – щелкнуть где-нибудь в запросе, щелкнуть в окне проверки и щелкнуть «Запустить запрос в консоли».

Пользовательский интерфейс платформы Flask показан ниже:

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

В этой статье вы узнаете о:

В этой статье предполагается, что вы знакомы с разработкой Python, и в вашей системе уже установлена ​​какая-то форма Python. Python 3.6 будет использоваться для этого урока. Скриншоты и демонстрации предоставлены для macOS. Поскольку PyCharm работает на всех основных платформах, вы можете увидеть немного разные элементы пользовательского интерфейса и, возможно, потребуется изменить определенные команды.

Note:

PyCharm выпускается в трех редакциях:

Чтобы узнать больше об их различиях, ознакомьтесь сPyCharm Editions Comparison Matrix от JetBrains. У компании также естьspecial offers для студентов, преподавателей, проектов с открытым исходным кодом и других кейсов.

 1 from random import randint
 2
 3 def play():
 4     random_int = randint(0, 100)
 5
 6     while True:
 7         user_guess = int(input("What number did we guess (0-100)?"))
 8
 9         if user_guess == randint:
10             print(f"You found the number ({random_int}). Congrats!")
11             break
12
13         if user_guess < random_int:
14             print("Your number is less than the number we guessed.")
15             continue
16
17         if user_guess > random_int:
18             print("Your number is more than the number we guessed.")
19             continue
20
21
22 if __name__ == '__main__':
23     play()

 1 class Calculator:
 2     def add(self, a, b):
 3         return a + b
 4
 5     def multiply(self, a, b):
 6         return a * b

 1 from unittest import TestCase
 2
 3 class TestCalculator(TestCase):
 4     def test_add(self):
 5         self.fail()
 6
 7     def test_multiply(self):
 8         self.fail()

 1 from unittest import TestCase
 2
 3 from calculator import Calculator
 4
 5 class TestCalculator(TestCase):
 6     def test_add(self):
 7         self.calculator = Calculator()
 8         self.assertEqual(self.calculator.add(3, 4), 7)
 9
10     def test_multiply(self):
11         self.fail()

 1 CONSTANT_VAR = 1
 2
 3
 4
 5 def add(a, b):
 6     c = "hello"
 7     return a + b

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

Оглавление

В этой статье вы узнаете о том:

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

Предполагается, что вы уже знакомы с Python и обладаете некоторым опытом разработки в своей системе. Используется Python 3.6. Скриншоты и демо-версии сделаны в Mac OS. Поскольку PyCharm работает на всех основных платформах, есть некоторые незначительные отличия элементов пользовательского интерфейса и, возможно, потребуется изменить некоторые команды.

В этой статья я буду использовать PyCharm Community Edition 2019.1, так как она бесплатна и доступна на любой популярной платформе всем. Но смею вас заверить, что приведённые здесь примеры с успехом работают и на PyCharm Professional Edition 2019.1.

Для установки PyCharm рекомендую использовать JetBrains Toolbox App. С его помощью вы сможете установить любые продукты JetBrains или несколько версий одного и того же продукта, при необходимости легко обновлять, откатывать и удалять любые инструменты. Вы также сможете быстро открыть любой проект в любой предыдущей версии.

Для установки Toolbox App прочитайте фирменную документацию от JetBrains. Операционная система будет определена автоматически при загрузке и для вас будут предложены корректные пошаговые инструкции. Если этого не произойдёт, то выберите ОС «в рукопашную» в поле справа вверху:

После установки загрузите приложение и подтвердите своё согласие с условиями использования софта. На закладке Tools посмотрите список доступных продуктов. Выберите PyCharm Community и нажмите Install:

Вот и всё! PyCharm уже готов к работе на вашей машине. Если вам не нравится Toolbox app, то воспользуйтесь автономной установкой PyCharm.

Запустите PyCharm и увидите всплывающее окно настройки импорта:

PyCharm автоматически определит новую установку и предложит вам Do not import settings (Не импортировать настройки). Согласитесь и нажмите OK, выберите раскладку клавиш PyCharm по умолчанию и нажмите Next: UI Themes (Далее: тема пользовательского интерфейса) справа внизу:

PyCharm предложит вам тёмную тему под названием Darcula или светлую тему. Выберите то, что вам нравится и нажмите кнопку Next: Launcher Script (Далее: сценарий запуска):

Здесь на протяжении всего урока будет использоваться тёмная тема Darcula. Однако, вы можете найти и установить другую тему, используя плагины, или импортировать идеальную для вас тему IntelliJ.

На следующей странице оставьте всё по-умолчанию и нажмите Next: Featured plugins (Далее: Рекомендуемые плагины). Здесь PyCharm покажет вам список плагинов, которые вы можете немедленно установить, большинство пользователей любят это делать. Нажмите Start using PyCharm (Стартовать PyCharm) и теперь можно смело записывать код!

Запись кода в PyCharm

В PyCharm всё делается в контексте проекта. Поэтому для начала его надо создать.

После установки и загрузки PyCharm в окне приветствия нажмите Create New Project (создать новый проект) и вы появится окно для создания нового проекта New Project:

Укажите местоположение проекта и раскройте список Project Interpreter. Здесь у вас есть возможность создать новый интерпретатор для своего нового проекта или повторно использовать существующий. Выберите New environment using. Прямо рядом с ним у вас есть выпадающий список для выбора одного из вариантов Virtualenv, Pipenv или Conda, которые являются инструментами поддержки необходимых для разный проектов зависимостей отдельно, создавая для этого изолированные среды Python.

Если хотите, выберите для этого урока Virtualenv. При желании можно указать местоположение среды и выбрать базовый интерпретатор из списка, в котором должны присутствовать все интерпретаторы Python, например, Python 2.7 и Python 3.6, установленные в вашей операционной системе. Обычно по умолчанию все бывает в порядке, но если Python у вас не установлен, то придётся это сделать. Пройдите на сайт python.org, скачайте дистрибутив и сделайте установку интерпритатора. Затем вы должны выбрать блоки для наследования глобальных пакетов сайтов в вашей новой среде и сделать их доступными для всех других проектов. Пока не обращайте на них внимание и оставьте невыбранными.

В правом нижнем углу нажмите кнопочку Create и вы увидите созданный новый проект:

Также появится небольшое всплывающее окно Tip of the Day (Совет дня), где при каждом запуске даётся какой-то случайный совет от PyCharm. Прочитайте и просто закройте это окно.

Настало время начать запись кода на Python. Одновременно нажмите Cmd+N если у вас Mac или Alt+Ins если Windows или Linux. После чего выберите Python File. Это можно сделать воспользовавшись главным меню File → New. Назовите новый файл guess_game.py и нажмите OK. Вы увидите окно PyCharm, похожее на это:

Давайте быстренько напишем тестовый код, реализующий простую игру на угадывание — программа генерирует секретное число, которое должен угадать человек. На каждое предложенное человеком число программа скажет, было оно меньше или больше секретного. Игра заканчивается, когда человек угадает число. Вот этот код gauss-game.py:

from random import randint

def play():
    random_int = randint(0, 100)

    while True:
        user_guess = int(input("Запишите целое число в диапазоне от 0 до 100?"))
        if user_guess == randint:
            print(f"Вы угадали число ({random_int}). Поздравляю!")
            break
        if user_guess < random_int:
            print("Ваше число меньше секретного.")
            continue
        if user_guess > random_int:
            print("Выше число больше секретного.")
            continue

if __name__ == '__main__':
    play()

Не копируйте, а введите этот код напрямую и увидите что‑то вроде этого:

Как видите, в PyCharm есть Intelligent Coding Assistance — интеллектуальный ассистент кодирования, который делает автодополнение кода, проверяет синтаксис, сообщает об ошибках и даёт рекомендации по их исправлению. В частности, заметьте, когда вы записали main и нажали Tab, PyCharm автоматически полностью завершил всю конструкцию main за вас.

Так-же обратите внимание, что если перед if поставить точку .if и нажать Tab, то PyCharm полностью за вас напишет конструкцию if. То же самое верно для True.while — работает PyCharm’s Postfix completions (постфиксное дополнение кода) и не надо лишний раз нажимать на Enter для перехода но новую строку.

Загрузка кода в PyCharm

Теперь, когда вы написали код, пришло время запустить его.

У вас есть три способа запуска этой программы:

1. Используйте клавиши Ctrl+Shift+R на Mac или Ctrl+Shift+F10 на Windows или Linux.
2. Нажмите правую кнопку мыши в поле редактирования и в меню выберите Run ‘guess_game’.
3. Поскольку в этой программе есть предложение __main__, то щелкните на маленькую зелёную стрелку слева от фразы __main__ и выберите Run ‘guess_game’отсюда.

Любой из этих вариантов приведёт к запуска программы, и вы увидите панель «Run Tool» в нижней части окна, с выводом кода, показывающим диалог.

Немного поиграйте и увидите, что секретное число угадать можно. Совет от профессионала: начните с 50.

Отладка в PyCharm

Вы нашли секретное число? Если так, то, возможно, заметили что-то странное, вместо того, чтобы печатать поздравление и завершать игру программа запускается заново. Где‑то прямо здесь есть ошибка. Чтобы узнать, почему программа запускается заново, вы должны её отладить.

Сначала установите точку останова, нажав на пустое место слева от строки № 8:

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

1. Нажмите Ctrl+Shift+D на Mac или Shift+Alt+F9 на Windows или Linux.
2. Щелчком правой кнопки мыши в поле редактирования выберите Debug ‘guess_game’.
3. Щёлкните на маленькую зелёную стрелку слева от фразы __main__ и выберите Debug ‘guess_game отсюда.

После этого вы увидите открывшиеся внизу окно Debugger:

Для отладки программы выполните следующие шаги:

1. Обратите внимание, что текущая строка выделена синим цветом.
2. Посмотрите, что random_int и его значение перечислены в окне отладки. Запишите это значение. (На рисунке число 85.)
3. Нажмите F8 для выполнения текущей строки и перехода к следующей. Если в текущей строке вызывается функции, то при необходимости в неё попасть нажмите F7. По-шагово выполняя операторы, в окне отладки вы сможете наблюдать все изменения значений переменных, обновляемые автоматически.
4. Обратите внимание, что рядом с открывшейся вкладкой «Debugger» находится вкладка «Console», у которых совершенно разное функциональное назначение. На вкладке Console вы будете взаимодействовать со своей программой, а на вкладке Debugger вы будете выполнять действия по отладке.
5. Переключайтесь на вкладку Console для диалога с вашим guess.
6. Запишите ваше число и нажмите Enter.
7. Переключитесь назад на вкладку Debugger.
8. Нажмите F8 для выполнения оператора if. Заметьте, вы на строке 14. Постойте! Почему не произошёл переход к 11 строке? Причина в том, что условие в операторе if 10 строки приняло значение False. Но почему False если введённое число то, что надо?
9. Внимательно посмотрите на строчку 10 и заметите, что мы сравниваем user_guess не с тем, что надо. Вместо random_int делается сравнение с функцией randint, импортированной из пакета random.
10. Измените на random_int, перезапустите и сделайте пошаговое выполнение операторов. Вы видите, произошёл переход к строке 11, а значение условия стало True:

Поздравляю! Ошибка найдена и исправлена.

Тестирование в PyCharm

Без тестирования нельзя гарантировать надёжность работы любого приложения. PyCharm помогает быстро и комфортно написать и загрузить тесты. По-умолчанию используется unittest, но кроме него можно использовать такие фреймворки, как pytest, nose, doctest, tox и trial. Например, для своего проекта можно выбрать pytest:

1. Откройте диалог настройки Settings/Preferences → Tools → Python Integrated Tools.
2. Выберите pytest в поле Default test runner.
3. Нажмите OK для сохранения настроек.

В нашем примере мы будем использовать загрузчик теста по‑умолчанию unittest.

В том же самом проекте, где записана игра, создайте файл с именем calculator.py и запишите в него код класса Calculator:

class Calculator:
    def add(self, a, b):
        return a + b
    def multiply(self, a, b):
        return a * b

Для кода, открытого в редакторе, PyCharm позволяет очень легко создавать тесты. С открытым файлом calculator.py выполните любое из следующих действий:

• Нажмите Shift+Cmd+T на Mac или Ctrl+Shift+T на Windows или Linux.
• Правой кнопкой мыши в поле редактирования выберите Go To и Test.
• В основном меню проследуйте Navigate → Test.

Выберите Create New Test (Создать новый тест) и посмотрите на окно:

Значения полей Target directory (целевой каталог), Test file name (Имя файла теста) и Test class name (Имя класса теста) оставьте по‑умолчанию. Для тестирования отметьте оба метода и нажмите на OK. Вуаля! PyCharm автоматически создаст для вас файл с именем test_calculator.py и заглушки для тестов:

from unittest import TestCase
class TestCalculator(TestCase):
    def test_add(self):
        self.fail()
    def test_multiply(self):
        self.fail()

Загрузите тест одним из следующих способов:

• Нажмите Ctrl+R на Mac или Shift+F10 на Windows или Linux.
• Щёлкните правой кнопкой мыши в поле редактирования и выберите Run ‘Unittests for test_calculator.py’.
• Щёлкните на маленькой зелёной стрелке слева от имени класс теста и выберите Run ‘Unittests for test_calculator.py’.

Вы увидите открытое окно тестов со всеми ошибками:

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

Теперь реализуем test_add, изменив код на следующий:

from unittest import TestCase
from calculator import Calculator
class TestCalculator(TestCase):
    def test_add(self):
        self.calculator = Calculator()
        self.assertEqual(self.calculator.add(3, 4), 7)
    def test_multiply(self):
        self.fail()

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

Обратите внимание, что метод sleep (0.1), который вы видите на картинке выше, намеренно используется для замедления одного из тестов, чтобы показать, как работает сортировка по времени исполнения.

Редактирование существующего проекта в PyCharm

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

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

После чего разархивируйте и откройте его в PyCharm одним из следующих способов:

• Нажмите File → Open в главном меню.
• Нажмите Open в окне Welcome Screen, если вы только что загрузили PyCharm.

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

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

Если вы хотите создать свою virtualenv — виртуальную среду, что обычно и делается, то откройте Preferences, нажав на Mac Cmd+, или Settings на Windows или Linux Ctrl+Alt+S и найдите секцию Project: ProjectName. Откройте выпадающий список и выберите Project Interpreter:

Выберите virtualenv в выпадающем списке. Если такого выбора в списке нет, то для настройки спарва от выпадающего списка нажмите кнопку Add…. Дальнешие шаги такие же, как при создании нового проекта.

Поиск и навигация в PyCharm

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

• Поиск фрагмента текста в текущем файле: нажмите Cmd+F на Mac или Ctrl+F на Windows или Linux.
• Поиск фрагмента во всем проекте: нажмите Cmd+Shift+F на Mac или Ctrl+Shift+F на Windows или Linux.
• Поиск класса: нажмите Cmd+O на Mac или Ctrl+N на Windows или Linux.
• Поиск файла: нажмите Cmd+Shift+O на Mac или Ctrl+Shift+N на Windows или Linux.
• Поиск везде, если не знаете, что конкретно ищете — файл, класс или фрагмент кода: нажмите Shift дважды.

Что касается навигации, шпаргалка ниже сэкономит вам массу времени:

• Переход к объявлению переменной: нажмите Cmd на Mac или Ctrl на Windows или Linux и щёлкните по переменной.
• Поиск используемого класса, метода или любого символа: нажмите Alt+F7.
• Просмотр последних изменений: нажмите Shift+Alt+C или выберите View → Recent Changes в главном меню.
• Просмотр ваших последних файлов: нажмите Cmd+E на Mac или Ctrl+E на Windows или Linux или в главном меню прйдите View → Recent Files.
• G>Переход назад и вперед по истории навигации после того, как вы уже что‑то сделали: нажмите Cmd+[ / Cmd+] на Mac или Ctrl+Alt+Left / Ctrl+Alt+Right на Windows или Linux.

Для более подробного знакомства с этим вопросом читайте официальную документацию.

Управление версиями в PyCharm

Система управления версиями^એ, типа, Git или Mercurial является важнейшим инструментом в современном мире разработки программного обеспечения. Поэтому так важна поддержка их в любой IDE. PyCharm делает это очень хорошо, прекрасно интегрируясь с Git (и Github), а так же с другими популярными системами такими, как Mercurial, Perforce и Subversion.

Настройка систем управления версиями

Что-бы включить интеграцию с системой управления версиями пройдите VCS → VCS Operations Popup… в верхнем меню или нажмите клавиши Ctrl+V на Mac или Alt+` на Windows или Linux. Выберите Enable Version Control Integration…. Посмотрите на открывшееся окно:

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

Теперь, если вы пройдете VCS Operations Popup…, то увидите всплывающее окно с опциями git add, git stash, git branch, git commit, git push и много другое:

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

Коммиты и разрешение конфликтов

Есть две особенности интеграции систем управления версиями в PyCharm, которые лично я использую и получаю от этого огромное удовольствие! Допустим, вы закончили свою работу и хотите это как-то отметить. Перейдите VCS → VCS Operations Popup… → Commit… или нажмите Cmd+K на Mac или Ctrl+K на Windows или Linux. Посмотрите на появившееся окно:

В этом окне можно:

1. Выбрать файлы для фиксации;
2. Записать сообщение о фиксации;
3. Выполнить все команды проверки и очистки перед фиксацией;
4. Посмотреть различия в изменениях;
5. Зафиксировать и нажать стрелку справа от кнопки Commit и выбрать Commit and Push….

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

При работе в команде случаются конфликты слияния. Кто-то фиксирует изменения в файле, над которым вы сейчас работаете, но его изменения пересекаются с вашими, потому что вы оба поменяли одни и те же строки. Система управления версиями не сможет самостоятельно выяснить, какие изменения ей зафиксить ваши или вашего товарища по команде. Таким образом, могут получиться эти неудачные стрелки и символы:

Всё это выглядит странно и трудно понять, что надо удалить, а что оставить. PyCharm на помощь! У него гораздо приятнее и чище способ разрешения конфликтов. Перейдите к VCS в верхнем меню, выберите Git, а затем Resolve conflicts…. Выберите файл, конфликты которого вы хотите разрешить, и нажмите Merge. Вы увидите следующее открытое окно:

В левой колонке вы увидите свои изменения. Справа — изменения, внесенные вашим товарищем по команде. Наконец, в средней колонке вы увидите результат. Конфликтующие строки подсвечиваются и вы можете видеть маленькие X and >>/<< рядом с этими строками. Нажмите стрелки для того, чтобы принять изменения, а X, что бы отклонить. После того, как вы разрулите все эти конфликты, нажмите кнопку Apply:

В приведенной выше картинке в первой противоречивой строке автор отказался от своих изменений и принял изменения своих товарищей по команде. А во второй строке наоборот, автор принял свои собственные изменения и отклонил изменения своих партнеров по команде.

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

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

• Добавить поддержку для различных языков и структур;
• Увеличить свою пропродуктивность, используя быстрые подсказки, средства просмотра файлов и т.д.;
• Выучить новый язык программирования с помощью упражнений по кодированию

Например, IdeaVim добавит иммитацию Vim^એ в ваш PyCharm. Ну, если вам нравится Vim^એ, почему-бы это не сделать.

Измените тему своего PyCharm на Material Theme UI и посмотрите, как это выглядит:

Vue.js добавляет поддержку проектов Vue.js^એ. Markdown^એ предоставляет возможность редактировать файлы Markdown в среде IDE и просматривать HTML‑код в режиме предварительного просмотра в браузере. Вы можете найти и установить все доступные плагины, выбрав Preferences → Plugins на Mac или Settings → Plugins на Windows или Linux на вкладке Marketplace, но это уже за деньги:

Если вы ничего не нашли, то можете разработать свой плагин.

Если вы не можете найти нужный плагин и не хотите разрабатывать свой собственный, потому что в PyPI уже есть пакет, то его можно добавить в PyCharm в качестве внешнего инструмента. Так, например, анализатор кода Flake8.

Сначала установите flake8 в своей virtualenv, используя pip install flake8 в терминале приложения. Так же успешно можно использовать пакет интегрированный в PyCharm:

Далее пройдите в меню Preferences → Tools на Mac или Settings → Tools для Windows/Linux и выберите External Tools. Щёлкните на маленькую кнопку + (1). В новом всплывающем окне вставьте детали, как показано ниже, и нажмите ОК для обоих окон:

Здесь Program (2) относится к исполняемому файлу Flake8, который находится в папке /bin вашей виртуальной среды. Arguments (3) указывают, какой файл вы хотите проанализировать с помощью Flake8. Working directory — рабочий каталог вашего проекта.

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

Обратите свой взор на то, что называется Макрос. Макросы позволяют задавать значения переменным в формате $name$, которые могут меняться в зависимости от вашего контекста. Например, $FileName$ — это first.py, когда вы редактируете first.py, а когда вы редактируете second.py, то это second.py. Вы можете просмотреть их список и вставить любой из них, нажав на кнопки Insert Macro…. Поскольку здесь вы использовали макросы, значения будут меняться в зависимости от проекта, над которым вы сейчас работаете, и Flake8 продолжит правильно выполнять свою работу.

Чтобы это понять, создайте файл example.py и запишите туда следующий код:

CONSTANT_VAR = 1

def add(a, b):
    c = "hello"
    return a + b

То, что написано, немного не по правилам Flake8. Нажмите правую кнопку ыша на поле редактирования этого файла. Выберите External Tools и Flake8. Вуа‑ля! Результат анализа Flake8 можно посмотреть внизу:

Для ускорения работы с внешними инструментами можно добавить клавиши быстрого доступа. Перейдём к Preferences на Mac или к Settings на Windows или Linux. Затем Keymap → External Tools → External Tools. Дважды щёлкните на Flake8 и выберите Add Keyboard Shortcut. Посмотрите сюда:

На картинке выше показано, как назначены клавиши быстрого доступа Ctrl+Alt+A для загрузки этого инструмента. Добавьте свои клавиши быстрого доступа в текстовое поле и нажмите OK для обоих окон. Теперь вы можете использовать эти клавиши для загрузки Flake8 и анализа файла, над которым сейчас работаете.

Возможности профессиональной версии PyCharm

PyCharm Professional — это платная версия PyCharm с огромным количеством готовых функций и возможностей интеграции. В этом разделе, в основном, будет представлен обзор главных функций и ссылки на официальную документацию, где каждая функция подробно обсуждается. Помните, что ни одна из следующих функций не доступна в версии Community.

Поддержка Django

PyCharm поддерживает Django, один из самых популярных и любимых веб‑фреймворков Python. Что бы убедиться в его доступности проделайте следующее:

1. Откройте Preferences на Mac или Settings на Windows или Linux.
2. Выберите Languages and Frameworks.
3. Выберите Django.
4. Проверьте установлена ли галочка на Enable Django support?Если нет, установите.
5. Примените изменения.

Теперь, когда вы включили поддержку Django, ваше путешествие при разработке с Django станет наиболее приятным с PyCharm:

• При создании проекта у вас будет выбран тип проекта Django. И это означает, что в проекте такого типа у вас будут все необходимые файлы и настройки. Это эквивалентно использованию django-admin startproject mysite.
• Вы можете загрузить manage.py непосредственно из PyCharm.
• Поддержка в шаблоне Django включает:
  • синтаксис и подсветку ошибок.
  • Автозавершение кода.
  • Навигацию.
  • Завершение имен блоков.
  • Завершение пользовательских тегов и фильтров.
  • Быстрый доступ к документации по тегам и фильтрам.
  • Возможность их отладки.
• Автоавершение кода во всех других частях Django, таких как представления, URL‑адреса и модели, а также поддержка анализа кода для Django ORM.
• Диаграммы зависимостей для моделей Django.

Более подробная информация о поддержке Django смотрите в официальной документации.

Поддержка баз данных

Современная разработка баз данных — сложная задача со множеством вспомогательных систем и рабочих процессов. Вот почему JetBrains, компания, стоящая за PyCharm, разработала для этого отдельную IDE DataGrip. Это отдельный продукт от PyCharm с отдельной лицензией.

К счастью, PyCharm поддерживает все функции, доступные в DataGrip через плагин Database tools and SQL, который включен по умолчанию. С его помощью можно запрашивать, создавать и управлять базами данных независимо от того, работают ли они локально, на сервере или в облаке. Плагин поддерживает MySQL, PostgreSQL, Microsoft SQL Server, SQLite, MariaDB, Oracle, Apache Cassandra и другие. Для получения дополнительной информации о том, что вы можете сделать с этим плагином, посмотрите полную документацию по поддержке баз данных.

Визуализация параллельных потоков

Django Channels, asyncio и последние фреймворки, такие как Starlette являются примерами растущей популярности асинхронного программирования на Python. Несмотря на то, что асинхронные программы действительно приносят много пользы, известно, что их довольно сложно писать и отлаживать. В таких случаях визуализация параллельных потоков может быть именно тем, что доктор прописал. Она помогает полностью контролировать свои многопоточные приложения и оптимизировать их.

Проверьте подробную документацию этой функции для получения более подробной информации.

Более подробная информация содержится в подробной документации об этой функции.

Профилировщик

Говоря об оптимизации, профилирование — это еще один метод, который можно использовать для оптимизации кода. С его помощью можно увидеть, какие части кода занимают большую часть времени при выполнении. Профилировщик расставляет следующие приоритеты:

1. vmprof
2. yappi
3. cProfile

Если у вас не установлен vmprof или yappi, просто вернитесь к стандартному cProfile. Он хорошо документирован и здесь я не буду пересказывать эту документацию.

Режим научной разработки

Python — это язык не только для общего и веб‑программирования. За последние годы он стал лучшим инструментом для науки о данных и машинного обучения. Своей популярностью он обязан своим инструментам и библиотекам, таким как NumPy, SciPy, scikit-learn, Matplotlib, Jupyter и другим. При наличии таких мощных библиотек необходима мощная IDE для поддержки всех функций, таких как построение графиков и анализ этих библиотек. PyCharm предоставляет все, что нужно, исчерпывющая документация здесь.

Удалённая разработка

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

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

Заключение

PyCharm — одна из лучших, если не самая лучшая, полнофункциональная, специализированная и универсальная IDE для разработки на Python. Он обладает массой возможностей, которые экономят время, помогая вам с рутинными задачами. Теперь вы знаете, как быть ним продуктивным!

Здесь вы узнали о многом, в том числе:

• Как установить PyCharm;
• Как записать код в PyCharm;
• Как загрузить код в PyCharm;
• Отладка и тестирование кода в PyCharm;
• Как изменить существующий проект в PyCharm;
• Поиск и навигация в PyCharm;
• Контроль версий в PyCharm;
• Плагины и внешние инструменты в PyCharm;
• Использование возможностей профессиональной версии PyCharm, таких как поддержка Django и режима научной разработки.;

Если Вы хотите что-то спросить или поделиться своими замечаниями пишите в комментарии ниже. Для более детального знакомства с документацией перейдите на сайт PyCharm.

Оригинал: PyCharm — эффективная разработка на PythonР

Pycharm — Introduction

PyCharm is the most popular IDE used for Python scripting language. This chapter will give you an introduction to PyCharm and explains its features.

PyCharm offers some of the best features to its users and developers in the following aspects −

• Code completion and inspection
• Advanced debugging
• Support for web programming and frameworks such as Django and Flask

Features of PyCharm

Besides, a developer will find PyCharm comfortable to work with because of the features mentioned below −

Code Completion

PyCharm enables smoother code completion whether it is for built in or for an external package.

SQLAlchemy as Debugger

You can set a breakpoint, pause in the debugger and can see the SQL representation of the user expression for SQL Language code.

Git Visualization in Editor

When coding in Python, queries are normal for a developer. You can check the last commit easily in PyCharm as it has the blue sections that can define the difference between the last commit and the current one.

Code Coverage in Editor

You can run .py files outside PyCharm Editor as well marking it as code coverage details elsewhere in the project tree, in the summary section etc.

Package Management

All the installed packages are displayed with proper visual representation. This includes list of installed packages and the ability to search and add new packages.

Local History

Local History is always keeping track of the changes in a way that complements like Git. Local history in PyCharm gives complete details of what is needed to rollback and what is to be added.

Refactoring

Refactoring is the process of renaming one or more files at a time and PyCharm includes various shortcuts for a smooth refactoring process.

User Interface of PyCharm Editor

The user interface of PyCharm editor is shown in the screenshot given below. Observe that the editor includes various features to create a new project or import from an existing project.

From the screenshot shown above, you can see the newly created project Demo and the site-packages folder for package management along with various other folders.

You can download the PyCharm Editor and read its official documentation at this link −
https://www.jetbrains.com/pycharm/

Pycharm — Installation

In this chapter, you will learn in detail about the installation process of PyCharm on your local computer.

Steps Involved

You will have to follow the steps given below to install PyCharm on your system. These steps show the installation procedure starting from downloading the PyCharm package from its official website to creating a new project.

Step 1

Download the required package or executable from the official website of PyCharm https://www.jetbrains.com/pycharm/download/#section=windowsHere you will observe
two versions of package for Windows as shown in the screenshot given below −

Note that the professional package involves all the advanced features and comes with free trial for few days and the user has to buy a licensed key for activation beyond the trial period. Community package is for free and can be downloaded and installed as and when required. It includes all the basic features needed for installation. Note that we will continue with community package throughout this tutorial.

Step 2

Download the community package (executable file) onto your system and mention a destination folder as shown below −

Step 3

Now, begin the installation procedure similar to any other software package.

Step 4

Once the installation is successful, PyCharm asks you to import settings of the existing package if any.

This helps in creating a new project of Python where you can work from the scratch. Note that unlike other IDEs, PyCharm only focusses on working with projects of Python scripting language.

Pycharm — Understanding Basics

This chapter will discuss the basics of PyCharm and make you feel comfortable to begin working in PyCharm editor.

When you launch PyCharm for the first time, you can see a welcome screen with entry points to IDE such as −

• Creating or opening the project
• Checking out the project from version control
• Viewing the documentation
• Configuring the IDE

Recall that in the last chapter, we created a project named demo1 and we will be referring
to the same project throughout this tutorial. Now we will start creating new files in the same project to understand the basics of PyCharm Editor.

The above snapshot describes the project overview of demo1 and the options to create a new file. Let us create a new file called main.py.

The code included in main.py is as follows −

y = 3

def print_stuff():
   print ("Calling print_stuff")
   print (y)
   z = 4
   print (z)
   print("exiting print_stuff")
	
print_stuff() # we call print_stuff and the program execution goes to (***)
print(y) # works fine
print (z) # NameError!!!

The code created in the file main.py using PyCharm Editor is displayed as shown below −

This code can be run within IDE environment. The basic demonstration of running a program is discussed below −

Note that we have included some errors within the specified code such that console can execute the code and display output as the way it is intended to.

Pycharm — Keymaps

PyCharm includes various Keymaps to show the most-used commands in the editor. This chapter discusses Keymaps in detail.

You can find the list of Keymaps available in the file menu Help -> Keymap Reference
as shown in the screenshot given below −

You can find the list of Keymaps and the available shortcuts in PDF format as shown below −

Note − The default Keymap for Windows and Linux operating systems is default, while in Mac OS the default Keymap is OSX 10.5.

You can also view the list of Keymaps available using the Settings option in Windows and Linux Operating system (Preferences in Mac OS) as shown in the screenshot given below −

The default Keymap includes various sections for Editor Actions, Main Menu, Tool Windows, External tools, Version Control System, Macros, Quick Lists, Plug-ins and Other options as well.

Pycharm — Shortcuts

Shortcuts are the combinations of keys being used to perform a set of activities. You can find the list of PyCharm shortcuts in Keymaps guide reference.

Finding Shortcut

The list of shortcuts is available in the following option Help -> Find Action menu where it pops up with a shortcut window.

You can see the shortcut window as shown here −

The shortcut includes a list of Identifiers, shortcuts with functions and option menu bar.For example, View Navigation Bar includes toggle ON and OFF which displays the navigation bar as per the value set (ON and OFF).

Pycharm — Omni

Omni is the section in PyCharm which deals into anywhere from any place. It includes various tools for a user to move from one place to another. It helps in such a scenario that you need to quickly move from one project directory into another. This chapter will familiarize you with the functionalities of Omni.

Functionalities

The Navigate menu describes the functionalities involved in Omni. This section discusses these in detail −

Class

This helps to navigate from one class to another in a mentioned project. This is very helpful to navigate through a list of classes.

Back

This option helps to move backwards from the existing state. The shortcut key is Ctrl+Alt+Left.

Forward

It works similar to the back option. However, the functionality is completely vice-versa.

Pycharm — Macros

The difference between a macro and Omni is subtle in PyCharm Editor. Omni allows you to go to the exact location of editor or a specified place of code with no particular significance. Macro on the other hand allows the user to navigate through functions and classes or particular class method.

Navigate Macro

Observe the following screenshot for a better understanding of Navigate macro −

The Navigate -> Declaration helps to show declaration, type declaration and to define super methods. Various attributes included in the type declaration are shown below −

However, there is an issue with this macro, if a user tries to go to the declaration of a .so object for example, navigating from datetime module to select module, then each time it will encounter the stub file.

Search Everywhere

It helps to search the classes and associated methods. It includes the option to search with Google as well.

Each of these parts includes a shortcut key combination next to its section name. Search Everywhere is a gateway to other search actions available in PyCharm.

Pycharm — Micros

Micros deal with getting places within a specified file. These tools end up using most of the development procedure. In this chapter, you will learn Micro in detail.

Consider the example of Structure Panel which is being used as representation of micros.

Scroll from Source

It helps to scroll from the mentioned source like the complete folder location of the specified file.

Collapse All

Consider the screenshot shown below which shows opening the file with specified location.In order to collapse the folder structure, you can use the shortcut key shown in the image.

This shortcut key helps in collapsing the folder location of specified code as shown below.

Show Options menu

The Show Options menu of the structure panel of project displays the list of options available for the project created. Observe the screenshot shown below for a better understanding −

The list of options is displayed below −

Hide

This option helps to hide the structure panel of the project window. The user interface of the structure panel after being collapsed is as shown below −

You can reopen the structure panel as shown here −

Pycharm — Improving and Writing Code

PyCharm includes various standards for writing code with proper indentations valid for Python. This makes it interesting to improve the code standards and writing the complete code in PyCharm editor.

Improving Code Completion

Code completion in PyCharm is really unique. You can enhance it further using many other features. Note that the editor provides start and end of the code block. Consider a file named demo.py with the following code −

message = 'GIEWIVrGMTLIVrHIQS' #encrypted message
LETTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'

for key in range(len(LETTERS)):
   translated = ''
	
   for symbol in message:
      if symbol in LETTERS:
         num = LETTERS.find(symbol)
         num = num - key
         if num < 0:
            num = num + len(LETTERS)
         translated = translated + LETTERS[num]
      else:
         translated = translated + symbol
   print('Hacking key #%s: %s' % (key, translated))

The code is completed using the following construct −

If you press Ctrl + spacebar while this popup is on the screen, you can see more code completion options −

Intention Actions

PyCharm includes intent specific actions and the shortcut key for the same is Alt+Enter. The most important example of intentions at work is using language injection in strings.

The screenshot given below shows the working of intention actions −

Note that we can insert many different languages of intention actions in PyCharm Editor.

Pycharm — Console

PyCharm has a full-fledged Python console with full code completion which is available in the option menu Tools -> Run Python Console.

Consider the code which was mentioned in the previous chapter, as shown below −

message = 'GIEWIVrGMTLIVrHIQS' #encrypted message
LETTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
for key in range(len(LETTERS)):
   translated = ''
   for symbol in message:
      if symbol in LETTERS:
         num = LETTERS.find(symbol)
         num = num - key
         if num < 0:
            num = num + len(LETTERS)
         translated = translated + LETTERS[num]
      else:
         translated = translated + symbol
   print('Hacking key #%s: %s' % (key, translated))

Now, let us run the code with the help of console to execute the script for getting the desired output, as shown below.

You can observe the output as shown below −

Pycharm — Interpreters

PyCharm includes interpreters to create a new project with new features as the way it is needed. You can create a virtual environment in your system as the way you need it. You can also inherit global site packages in the dialog box. Interpreters are available on Python Package Index (PyPI) and can be easily installed and accessed using pip install.

Creation of Interpreter

For creating an interpreter, it is always recommended to create a new project where desired configurations are managed. Look at the following screenshot for a better understanding −

These parameters include −

• Location − This describes the parameter where virtual environment is created focusing on the location on system.

• Basic interpreter − It defines the attributes of interpreter.

The dialog box also refers to the parameter where an existing virtual interpreter will be taken as an attribute. Once the user adds a new local interpreter, PyCharm will ask the user for the binary of interpreter. In most cases, it is always considered to be a .exe file. In case of Jython, it will be always a .bat file.

The details of Project Interpreter and the basic configuration of the existing project demo1 can be seen as shown below −

Remember that the interpreter also includes the basic packages which are mandatory for smooth functioning of working of project.

Pycharm — Debugging and Breakpoints

Running a python code comprises of two modes: running a script and debugging the script. This chapter focusses on debugging the Python script using PyCharm.

Steps Involved

The steps for debugging the Python project are as explained below −

Step 1

Start with debugging the Python project as shown in the screenshot below −

Step 2

Now, Windows firewall asks permission for debugging the Python project as the procedure involves line by line compilation.

Step 3

The debugging console is created in PyCharm editor as shown below which executes the output line by line.

The run button moves from one line to another to execute the output as the way we want.

Understanding Breakpoints

While debugging a particular script, it is intentional to create a breakpoint. Breakpoints are intentional stopping place or the place where the code is paused in order to identify the output at specific stage.

In PyCharm, breakpoints are visible using a separate dialog in the specified editor. It includes various attributes to evaluate the breakpoints defined and tracing log for the same with a main motive to achieve better programming practice.

Pycharm — Integration of Version Control

PyCharm supports various subversion control systems. This feature helps in improving the code base managing various versions together. This chapter talks about this concept in detail.

Steps Involved

You will have to go through the following steps for initializing and managing version control system −

Initializing a Subversion Control System

To start the version control system in a systematic way, it is important to initialize it. Various options are available in PyCharm for different version control systems.

Ignoring File

In any project of PyCharm where we set up the default project and the virtual environment on it, we should also create its management with version control system. For example, Git includes .gitignore files which are ignored during commit operation, however, includes some of its configurations. Now, go to the Settings menu and check for the following −

It includes various configurations for checking the path of Git executable and verifying if any files are ignored.

Configuration of GitHub

PyCharm includes settings to include configuration of GitHub repository, where a user can include username, password and other credentials, if any.

Once you are done with the settings mentioned, you can directly add and commit the local changes to Git repository.

Pycharm — HTML and CSS Integration

HTML and CSS are well supported in PyCharm Editor. PyCharm Editor includes a special shorthand and provides tag completion for HTML.

Emmet

Emmet is the shorthand used in PyCharm editor. It includes various features such as abbreviation preview, automatic URL recognition and edit points, for HTML and CSS files.The user interface of the settings section is shown in the screenshot given below −

Creating HTML and CSS files

PyCharm includes an inbuilt feature for creating HTML and CSS files. The basic steps for creating new HTML and CSS files are as follows −

Now, mention the name of file while creating HTML files in the project as shown below −

This creates the sample-file.html file as shown below −

Creating CSS file

The steps for creating a CSS file are shown here −

From the New menu, select the File option as shown below −

Specify the name of CSS during its creation as shown here −

You can see the complete project structure with various files mentioned in different color combinations as shown below −

Pycharm — JavaScript Support

In this chapter, we will focus on main features in using JavaScript in PyCharm editor. When a user implements JavaScript library through URL, PyCharm intends to download a local copy so it can be used for completion and code analysis.

Consider the sample code of our HTML file as shown below, which we created in the previous chapter −

For each HTML file or JavaScript file, you can check the external libraries loaded through Settings configuration of PyCharm Editor. Observe the screenshot shown below for a better understanding −

Note that you cannot see any library unless you download and implement it. PyCharm also includes JavaScript support of various libraries through a toolbox called JS Toolbox. The following screenshot shows this.

It also includes various attributes which are necessary for the JavaScript file configuration. The list of attributes and configurations is shown below −

Observe that it includes various parameters such as Unit test suffix, File suffix, View suffix, Search URL and the specific Root directory.

Pycharm — Tips

PyCharm includes various tips during startup that help its user to understand its functionalities and operations. It also includes some shortcuts which are mandatory to understand.

In this chapter, you will see some of the important PyCharm tips.

Changing the File to a Specific Changelist

This tip shows how to change the file to a specific changelist as per the user’s choice. This helps in managing repositories as per version control system settings. Observe the following screenshot for a better understanding −

Display the List of all Usages in a Class

This function displays the list of all usages included in a specific class, method or variable across the project. It quickly enables the user to jump to specific area. Observe the following screenshot for a better understanding −

To find Menu Command for an Action

This tip helps to find menu command for a specific action and the shortcut key for the same is Ctrl+Shift+A. A user can select desired action from the mentioned suggestion list.

Running Inspection through a Code

This tip helps in running a specific inspection through the code. The shortcut key combination for the same is Ctrl+Alt+Shift+I.

Specify the List of Settings

This tip is used to specify the list of desired settings. It includes smart keys for specific editor. The smart keys are shortcut keys for some operations.

Run / Debug the Script Files

This tip is very useful for running or debugging the script files which you can access through main toolbar. The shortcut key combination for same is Alt+Shift+F10.

Pycharm — Database Tools

PyCharm supports interface support with various types of databases. Once a user grants access to the created database, it provides schema diagram of the database with SQL writing tools which provide code completion. In this chapter, we will focus on MySQL database connectivity which will involve following steps.

Adding a Data Source

It is important to keep a note that PyCharm supports a wide variety of database connectivity.

Step 1

Open the database tool window View -> Tool Windows -> Database> and open the dialog called Data Sources and Dialog.

Now, select MySQL database for adding a new data source.

Step 2

User should download the missing driver files to get proper connectivity with MySQL database.

Step 3

Now, specify the configuration settings for connectivity to be achieved.

Host − If you database server is on a different computer, replace localhost with the IP address of the server host, e.g. 172.20.240.163.

Port − The default MySQL server port is 3306. If your server uses a different port, specify that port.

User and Password − These are the required credentials.

Step 4

Always make sure that database connectivity is successful through Test Connection feature.

Testing the connection also involves creating test table through query and executing them. Once the execution is successful, you can drop the database.

Pycharm — Exporting Data

PyCharm IDE includes various features for converting the existing code file into HTML format or CSV format. In this chapter, you will learn exporting data using PyCharm IDE.

The export settings of PyCharm editor are shown in the figure given below −

Export to HTML feature

This feature helps in exporting the specific file in HTML format. This is done to improve the security purposes of the given module. The following screenshot gives a better understanding −

Once the export operation is successful, the generated HTML file will display in browser output as shown below −

Now, if you check the HTML code generated after the export operation, you can observe that line numbers are also included to achieve this operation.

Pycharm — Web Frameworks

This chapter focusses on web frameworks and its deployment. PyCharm has a simple functionality to deploy code and files. To deploy code with PyCharm, we need to add a web server with Menu Option Settings -> Build, Execution-> Deployment.

Now, include all the settings with various configurations required for deployment of the project.

In the Mappings tab, a user can specify where the local code is and where it should be copied to remotely.

The code can be deployed using Tools -> Deployment option under the Tools menu bar.

Deployment in PyCharm is very granular: a user can deploy one single file or the whole source code.

PyCharm also includes various actions to compare remote and local versions. The editor is more reliable to use automatic deployments and a version control system to compare local and remote versions.

Pycharm — Django

One of the features of PyCharm is that it includes a support for Django. With the ability of including JavaScript features within PyCharm, it can be considered as the best IDE for Django.

The basic steps for creating a Django project in PyCharm IDE are given below −

If the EnableDjangoadmin option is enabled, PyCharm will setup the admin site for you.

Template Debugging

Debugging works with Django and Jinja templates. We can inspect variables, step through code, and do what we expect in a debugger.

Pycharm — Pyramid

You can create a project of Pyramid Framework in PyCharm editor by using its Welcome Window.

A user can set the project’s interpreter and Python location, choosing scaffold, and a template language by default. The scaffold in Pyramid framework uses URL dispatch to map URLs and to view code and SQLAlchemy for persistence properties.

PyCharm editor will ask user with list of required packages in the setup.py file and prompts the user to download the required packages.

Install the project in development mode (refer to official documentation of Pyramid for more details). The user should run python setup.py through the menu Tools -> Run setup.py option.

A user should select develop task while running a .py file as mentioned in the below window −

It is important to initialize the database using console script named initialize <project_name> using the following command −

initialize_pyramiddemo_db development.ini

The user can start the server by running the project which will display the result as shown below −

Pycharm — Flask

PyCharm supports Flask framework development. You can easily create a new Flask project by creating new project through welcome screen. You can set the project’s location and the virtual environment and choose a template language and where the templates will be located.

You can run a project by using Run -> Run ‘<project-name>’.

You can also add a new data source with this framework. Let us create a file called squema.sql and add SQL code to create some tables. PyCharm editor will recognize the files and asks you to configure a data source and set up to the database dialect.

PyCharm will let you choose the desired dialect that you want to use. You can change the properties of the SQL: Settings -> Language and Frameworks -> SQL Dialects

For flask editor, the easiest way to run the SQL query is to click somewhere in the query and click on the inspection window and click “Run Query into console “.

The user interface of the Flask framework is displayed as below −

Pycharm — Introduction

PyCharm is the most popular IDE used for Python scripting language. This chapter will give you an introduction to PyCharm and explains its features.

PyCharm offers some of the best features to its users and developers in the following aspects −

• Code completion and inspection
• Advanced debugging
• Support for web programming and frameworks such as Django and Flask

Features of PyCharm

Besides, a developer will find PyCharm comfortable to work with because of the features mentioned below −

Code Completion

PyCharm enables smoother code completion whether it is for built in or for an external package.

SQLAlchemy as Debugger

You can set a breakpoint, pause in the debugger and can see the SQL representation of the user expression for SQL Language code.

Git Visualization in Editor

When coding in Python, queries are normal for a developer. You can check the last commit easily in PyCharm as it has the blue sections that can define the difference between the last commit and the current one.

Code Coverage in Editor

You can run .py files outside PyCharm Editor as well marking it as code coverage details elsewhere in the project tree, in the summary section etc.

Package Management

All the installed packages are displayed with proper visual representation. This includes list of installed packages and the ability to search and add new packages.

Local History

Local History is always keeping track of the changes in a way that complements like Git. Local history in PyCharm gives complete details of what is needed to rollback and what is to be added.

Refactoring

Refactoring is the process of renaming one or more files at a time and PyCharm includes various shortcuts for a smooth refactoring process.

User Interface of PyCharm Editor

The user interface of PyCharm editor is shown in the screenshot given below. Observe that the editor includes various features to create a new project or import from an existing project.

From the screenshot shown above, you can see the newly created project Demo and the site-packages folder for package management along with various other folders.

You can download the PyCharm Editor and read its official documentation at this link −
https://www.jetbrains.com/pycharm/

Pycharm — Installation

In this chapter, you will learn in detail about the installation process of PyCharm on your local computer.

Steps Involved

You will have to follow the steps given below to install PyCharm on your system. These steps show the installation procedure starting from downloading the PyCharm package from its official website to creating a new project.

Step 1

Download the required package or executable from the official website of PyCharm https://www.jetbrains.com/pycharm/download/#section=windowsHere you will observe
two versions of package for Windows as shown in the screenshot given below −

Note that the professional package involves all the advanced features and comes with free trial for few days and the user has to buy a licensed key for activation beyond the trial period. Community package is for free and can be downloaded and installed as and when required. It includes all the basic features needed for installation. Note that we will continue with community package throughout this tutorial.

Step 2

Download the community package (executable file) onto your system and mention a destination folder as shown below −

Step 3

Now, begin the installation procedure similar to any other software package.

Step 4

Once the installation is successful, PyCharm asks you to import settings of the existing package if any.

This helps in creating a new project of Python where you can work from the scratch. Note that unlike other IDEs, PyCharm only focusses on working with projects of Python scripting language.

Pycharm — Understanding Basics

This chapter will discuss the basics of PyCharm and make you feel comfortable to begin working in PyCharm editor.

When you launch PyCharm for the first time, you can see a welcome screen with entry points to IDE such as −

• Creating or opening the project
• Checking out the project from version control
• Viewing the documentation
• Configuring the IDE

Recall that in the last chapter, we created a project named demo1 and we will be referring
to the same project throughout this tutorial. Now we will start creating new files in the same project to understand the basics of PyCharm Editor.

The above snapshot describes the project overview of demo1 and the options to create a new file. Let us create a new file called main.py.

The code included in main.py is as follows −

y = 3

def print_stuff():
   print ("Calling print_stuff")
   print (y)
   z = 4
   print (z)
   print("exiting print_stuff")
	
print_stuff() # we call print_stuff and the program execution goes to (***)
print(y) # works fine
print (z) # NameError!!!

The code created in the file main.py using PyCharm Editor is displayed as shown below −

This code can be run within IDE environment. The basic demonstration of running a program is discussed below −

Note that we have included some errors within the specified code such that console can execute the code and display output as the way it is intended to.

Pycharm — Keymaps

PyCharm includes various Keymaps to show the most-used commands in the editor. This chapter discusses Keymaps in detail.

You can find the list of Keymaps available in the file menu Help -> Keymap Reference
as shown in the screenshot given below −

You can find the list of Keymaps and the available shortcuts in PDF format as shown below −

Note − The default Keymap for Windows and Linux operating systems is default, while in Mac OS the default Keymap is OSX 10.5.

You can also view the list of Keymaps available using the Settings option in Windows and Linux Operating system (Preferences in Mac OS) as shown in the screenshot given below −

The default Keymap includes various sections for Editor Actions, Main Menu, Tool Windows, External tools, Version Control System, Macros, Quick Lists, Plug-ins and Other options as well.

Pycharm — Shortcuts

Shortcuts are the combinations of keys being used to perform a set of activities. You can find the list of PyCharm shortcuts in Keymaps guide reference.

Finding Shortcut

The list of shortcuts is available in the following option Help -> Find Action menu where it pops up with a shortcut window.

You can see the shortcut window as shown here −

The shortcut includes a list of Identifiers, shortcuts with functions and option menu bar.For example, View Navigation Bar includes toggle ON and OFF which displays the navigation bar as per the value set (ON and OFF).

Pycharm — Omni

Omni is the section in PyCharm which deals into anywhere from any place. It includes various tools for a user to move from one place to another. It helps in such a scenario that you need to quickly move from one project directory into another. This chapter will familiarize you with the functionalities of Omni.

Functionalities

The Navigate menu describes the functionalities involved in Omni. This section discusses these in detail −

Class

This helps to navigate from one class to another in a mentioned project. This is very helpful to navigate through a list of classes.

Back

This option helps to move backwards from the existing state. The shortcut key is Ctrl+Alt+Left.

Forward

It works similar to the back option. However, the functionality is completely vice-versa.

Pycharm — Macros

The difference between a macro and Omni is subtle in PyCharm Editor. Omni allows you to go to the exact location of editor or a specified place of code with no particular significance. Macro on the other hand allows the user to navigate through functions and classes or particular class method.

Navigate Macro

Observe the following screenshot for a better understanding of Navigate macro −

The Navigate -> Declaration helps to show declaration, type declaration and to define super methods. Various attributes included in the type declaration are shown below −

However, there is an issue with this macro, if a user tries to go to the declaration of a .so object for example, navigating from datetime module to select module, then each time it will encounter the stub file.

Search Everywhere

It helps to search the classes and associated methods. It includes the option to search with Google as well.

Each of these parts includes a shortcut key combination next to its section name. Search Everywhere is a gateway to other search actions available in PyCharm.

Pycharm — Micros

Micros deal with getting places within a specified file. These tools end up using most of the development procedure. In this chapter, you will learn Micro in detail.

Consider the example of Structure Panel which is being used as representation of micros.

Scroll from Source

It helps to scroll from the mentioned source like the complete folder location of the specified file.

Collapse All

Consider the screenshot shown below which shows opening the file with specified location.In order to collapse the folder structure, you can use the shortcut key shown in the image.

This shortcut key helps in collapsing the folder location of specified code as shown below.

Show Options menu

The Show Options menu of the structure panel of project displays the list of options available for the project created. Observe the screenshot shown below for a better understanding −

The list of options is displayed below −

Hide

This option helps to hide the structure panel of the project window. The user interface of the structure panel after being collapsed is as shown below −

You can reopen the structure panel as shown here −

Pycharm — Improving and Writing Code

PyCharm includes various standards for writing code with proper indentations valid for Python. This makes it interesting to improve the code standards and writing the complete code in PyCharm editor.

Improving Code Completion

Code completion in PyCharm is really unique. You can enhance it further using many other features. Note that the editor provides start and end of the code block. Consider a file named demo.py with the following code −

message = 'GIEWIVrGMTLIVrHIQS' #encrypted message
LETTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'

for key in range(len(LETTERS)):
   translated = ''
	
   for symbol in message:
      if symbol in LETTERS:
         num = LETTERS.find(symbol)
         num = num - key
         if num < 0:
            num = num + len(LETTERS)
         translated = translated + LETTERS[num]
      else:
         translated = translated + symbol
   print('Hacking key #%s: %s' % (key, translated))

The code is completed using the following construct −

If you press Ctrl + spacebar while this popup is on the screen, you can see more code completion options −

Intention Actions

PyCharm includes intent specific actions and the shortcut key for the same is Alt+Enter. The most important example of intentions at work is using language injection in strings.

The screenshot given below shows the working of intention actions −

Note that we can insert many different languages of intention actions in PyCharm Editor.

Pycharm — Console

PyCharm has a full-fledged Python console with full code completion which is available in the option menu Tools -> Run Python Console.

Consider the code which was mentioned in the previous chapter, as shown below −

message = 'GIEWIVrGMTLIVrHIQS' #encrypted message
LETTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
for key in range(len(LETTERS)):
   translated = ''
   for symbol in message:
      if symbol in LETTERS:
         num = LETTERS.find(symbol)
         num = num - key
         if num < 0:
            num = num + len(LETTERS)
         translated = translated + LETTERS[num]
      else:
         translated = translated + symbol
   print('Hacking key #%s: %s' % (key, translated))

Now, let us run the code with the help of console to execute the script for getting the desired output, as shown below.

You can observe the output as shown below −

Pycharm — Interpreters

PyCharm includes interpreters to create a new project with new features as the way it is needed. You can create a virtual environment in your system as the way you need it. You can also inherit global site packages in the dialog box. Interpreters are available on Python Package Index (PyPI) and can be easily installed and accessed using pip install.

Creation of Interpreter

For creating an interpreter, it is always recommended to create a new project where desired configurations are managed. Look at the following screenshot for a better understanding −

These parameters include −

• Location − This describes the parameter where virtual environment is created focusing on the location on system.

• Basic interpreter − It defines the attributes of interpreter.

The dialog box also refers to the parameter where an existing virtual interpreter will be taken as an attribute. Once the user adds a new local interpreter, PyCharm will ask the user for the binary of interpreter. In most cases, it is always considered to be a .exe file. In case of Jython, it will be always a .bat file.

The details of Project Interpreter and the basic configuration of the existing project demo1 can be seen as shown below −

Remember that the interpreter also includes the basic packages which are mandatory for smooth functioning of working of project.

Pycharm — Debugging and Breakpoints

Running a python code comprises of two modes: running a script and debugging the script. This chapter focusses on debugging the Python script using PyCharm.

Steps Involved

The steps for debugging the Python project are as explained below −

Step 1

Start with debugging the Python project as shown in the screenshot below −

Step 2

Now, Windows firewall asks permission for debugging the Python project as the procedure involves line by line compilation.

Step 3

The debugging console is created in PyCharm editor as shown below which executes the output line by line.

The run button moves from one line to another to execute the output as the way we want.

Understanding Breakpoints

While debugging a particular script, it is intentional to create a breakpoint. Breakpoints are intentional stopping place or the place where the code is paused in order to identify the output at specific stage.

In PyCharm, breakpoints are visible using a separate dialog in the specified editor. It includes various attributes to evaluate the breakpoints defined and tracing log for the same with a main motive to achieve better programming practice.

Pycharm — Integration of Version Control

PyCharm supports various subversion control systems. This feature helps in improving the code base managing various versions together. This chapter talks about this concept in detail.

Steps Involved

You will have to go through the following steps for initializing and managing version control system −

Initializing a Subversion Control System

To start the version control system in a systematic way, it is important to initialize it. Various options are available in PyCharm for different version control systems.

Ignoring File

In any project of PyCharm where we set up the default project and the virtual environment on it, we should also create its management with version control system. For example, Git includes .gitignore files which are ignored during commit operation, however, includes some of its configurations. Now, go to the Settings menu and check for the following −

It includes various configurations for checking the path of Git executable and verifying if any files are ignored.

Configuration of GitHub

PyCharm includes settings to include configuration of GitHub repository, where a user can include username, password and other credentials, if any.

Once you are done with the settings mentioned, you can directly add and commit the local changes to Git repository.

Pycharm — HTML and CSS Integration

HTML and CSS are well supported in PyCharm Editor. PyCharm Editor includes a special shorthand and provides tag completion for HTML.

Emmet

Emmet is the shorthand used in PyCharm editor. It includes various features such as abbreviation preview, automatic URL recognition and edit points, for HTML and CSS files.The user interface of the settings section is shown in the screenshot given below −

Creating HTML and CSS files

PyCharm includes an inbuilt feature for creating HTML and CSS files. The basic steps for creating new HTML and CSS files are as follows −

Now, mention the name of file while creating HTML files in the project as shown below −

This creates the sample-file.html file as shown below −

Creating CSS file

The steps for creating a CSS file are shown here −

From the New menu, select the File option as shown below −

Specify the name of CSS during its creation as shown here −

You can see the complete project structure with various files mentioned in different color combinations as shown below −

Pycharm — JavaScript Support

In this chapter, we will focus on main features in using JavaScript in PyCharm editor. When a user implements JavaScript library through URL, PyCharm intends to download a local copy so it can be used for completion and code analysis.

Consider the sample code of our HTML file as shown below, which we created in the previous chapter −

For each HTML file or JavaScript file, you can check the external libraries loaded through Settings configuration of PyCharm Editor. Observe the screenshot shown below for a better understanding −

Note that you cannot see any library unless you download and implement it. PyCharm also includes JavaScript support of various libraries through a toolbox called JS Toolbox. The following screenshot shows this.

It also includes various attributes which are necessary for the JavaScript file configuration. The list of attributes and configurations is shown below −

Observe that it includes various parameters such as Unit test suffix, File suffix, View suffix, Search URL and the specific Root directory.

Pycharm — Tips

PyCharm includes various tips during startup that help its user to understand its functionalities and operations. It also includes some shortcuts which are mandatory to understand.

In this chapter, you will see some of the important PyCharm tips.

Changing the File to a Specific Changelist

This tip shows how to change the file to a specific changelist as per the user’s choice. This helps in managing repositories as per version control system settings. Observe the following screenshot for a better understanding −

Display the List of all Usages in a Class

This function displays the list of all usages included in a specific class, method or variable across the project. It quickly enables the user to jump to specific area. Observe the following screenshot for a better understanding −

To find Menu Command for an Action

This tip helps to find menu command for a specific action and the shortcut key for the same is Ctrl+Shift+A. A user can select desired action from the mentioned suggestion list.

Running Inspection through a Code

This tip helps in running a specific inspection through the code. The shortcut key combination for the same is Ctrl+Alt+Shift+I.

Specify the List of Settings

This tip is used to specify the list of desired settings. It includes smart keys for specific editor. The smart keys are shortcut keys for some operations.

Run / Debug the Script Files

This tip is very useful for running or debugging the script files which you can access through main toolbar. The shortcut key combination for same is Alt+Shift+F10.

Pycharm — Database Tools

PyCharm supports interface support with various types of databases. Once a user grants access to the created database, it provides schema diagram of the database with SQL writing tools which provide code completion. In this chapter, we will focus on MySQL database connectivity which will involve following steps.

Adding a Data Source

It is important to keep a note that PyCharm supports a wide variety of database connectivity.

Step 1

Open the database tool window View -> Tool Windows -> Database> and open the dialog called Data Sources and Dialog.

Now, select MySQL database for adding a new data source.

Step 2

User should download the missing driver files to get proper connectivity with MySQL database.

Step 3

Now, specify the configuration settings for connectivity to be achieved.

Host − If you database server is on a different computer, replace localhost with the IP address of the server host, e.g. 172.20.240.163.

Port − The default MySQL server port is 3306. If your server uses a different port, specify that port.

User and Password − These are the required credentials.

Step 4

Always make sure that database connectivity is successful through Test Connection feature.

Testing the connection also involves creating test table through query and executing them. Once the execution is successful, you can drop the database.

Pycharm — Exporting Data

PyCharm IDE includes various features for converting the existing code file into HTML format or CSV format. In this chapter, you will learn exporting data using PyCharm IDE.

The export settings of PyCharm editor are shown in the figure given below −

Export to HTML feature

This feature helps in exporting the specific file in HTML format. This is done to improve the security purposes of the given module. The following screenshot gives a better understanding −

Once the export operation is successful, the generated HTML file will display in browser output as shown below −

Now, if you check the HTML code generated after the export operation, you can observe that line numbers are also included to achieve this operation.

Pycharm — Web Frameworks

This chapter focusses on web frameworks and its deployment. PyCharm has a simple functionality to deploy code and files. To deploy code with PyCharm, we need to add a web server with Menu Option Settings -> Build, Execution-> Deployment.

Now, include all the settings with various configurations required for deployment of the project.

In the Mappings tab, a user can specify where the local code is and where it should be copied to remotely.

The code can be deployed using Tools -> Deployment option under the Tools menu bar.

Deployment in PyCharm is very granular: a user can deploy one single file or the whole source code.

PyCharm also includes various actions to compare remote and local versions. The editor is more reliable to use automatic deployments and a version control system to compare local and remote versions.

Pycharm — Django

One of the features of PyCharm is that it includes a support for Django. With the ability of including JavaScript features within PyCharm, it can be considered as the best IDE for Django.

The basic steps for creating a Django project in PyCharm IDE are given below −

If the EnableDjangoadmin option is enabled, PyCharm will setup the admin site for you.

Template Debugging

Debugging works with Django and Jinja templates. We can inspect variables, step through code, and do what we expect in a debugger.

Pycharm — Pyramid

You can create a project of Pyramid Framework in PyCharm editor by using its Welcome Window.

A user can set the project’s interpreter and Python location, choosing scaffold, and a template language by default. The scaffold in Pyramid framework uses URL dispatch to map URLs and to view code and SQLAlchemy for persistence properties.

PyCharm editor will ask user with list of required packages in the setup.py file and prompts the user to download the required packages.

Install the project in development mode (refer to official documentation of Pyramid for more details). The user should run python setup.py through the menu Tools -> Run setup.py option.

A user should select develop task while running a .py file as mentioned in the below window −

It is important to initialize the database using console script named initialize <project_name> using the following command −

initialize_pyramiddemo_db development.ini

The user can start the server by running the project which will display the result as shown below −

Pycharm — Flask

PyCharm supports Flask framework development. You can easily create a new Flask project by creating new project through welcome screen. You can set the project’s location and the virtual environment and choose a template language and where the templates will be located.

You can run a project by using Run -> Run ‘<project-name>’.

You can also add a new data source with this framework. Let us create a file called squema.sql and add SQL code to create some tables. PyCharm editor will recognize the files and asks you to configure a data source and set up to the database dialect.

PyCharm will let you choose the desired dialect that you want to use. You can change the properties of the SQL: Settings -> Language and Frameworks -> SQL Dialects

For flask editor, the easiest way to run the SQL query is to click somewhere in the query and click on the inspection window and click “Run Query into console “.

The user interface of the Flask framework is displayed as below −