Как сделать комментарии в pycharm

Добавил пользователь Алексей Ф.
Обновлено: 04.10.2024

PyCharm – это одна из наиболее удобных сред разработки на языке Python. Существует в двух версиях:

  • PyCharm Community – свободно-распространяемая версия с открытым исходным кодом.
  • PyCharm Professional – проприетарная платная версия с триальным периодом.

В версии Community вы сможете программировать в основном на Python, в Professional – также на смежных языках (веб-программирование), использовать множество фреймворков.

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

В Linux, распаковав установочный пакет PyCharm, вы найдете в нем файл Install***.txt , в котором описано, что надо сделать, чтобы установить и запустить среду разработки.

Процесс может выглядеть следующим образом:

Перемещаем каталог с файлами среды разработки в директорию /opt командой

Переходим в директорию bin только что перемещенного каталога:

Выполняем файл pycharm.sh командой

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

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

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

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

Вернувшись в предыдущее окно, снимем флажок Create a main.py welcome script .

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

Слева на панели Project управляют файлами проекта. На скрине выше в каталоге pythonProject нет ни одного файла. Чтобы создать файл, в котором будет написана программа на Python, кликнем по этой папке правой кнопкой мыши. В контекстном меню выбираем New → Python File .

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

Нажав Enter , вы увидите файл на панели Project . Также он будет открыт в центральной части окна PyCharm.

После того, как исходный код написан, чтобы первый раз запустить программу, проще всего нажать Ctrl+Shift+F10 . Внизу раскроется вкладка Run , в которой отобразиться результат выполнения.

Иногда удобнее, чтобы панель выполнения программы открывалась не снизу, а, например, справа. В этом случае в настройках панели (справа значок похожий на гайку) следует выбрать Move to → Right Top .

После этого интерфейс среды разработки примет такой вид:

Внешний вид среды и множество других ее свойств, поведение настраиваются в окне Settings (меню File → Settings ). На скрине ниже показано, как изменить темную тему оформления PyCharm на светлую.

Бывает удобно менять размер шрифта в редакторе кода, зажав Ctrl и прокручивая колесо мыши. Чтобы воспользоваться этой возможностью в PyCharm, надо установить соответствующий флажок в разделе Editor → General окна настроек.

Изменить по-умолчанию заданный размер шрифта можно в разделе Editor → Font .

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

В дистрибутивах Linux обычно значок PyCharm не устанавливается в системное меню. И для последующего запуска среды вам снова надо будет обращаться к файлу pycharm.sh . Однако вы можете создать ярлык на приложение выполнив команду Tools → Create Desktop Entry… .

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

Теперь рассмотрим некоторые особенности работы в PyCharm, точнее в его редакторе кода. Многие из них универсальны, характерны для других сред разработки. Так нажатие Ctrl + D дублирует строку, в которой находится курсор.

Ctrl + C копирует строку, в которой находится курсор, выделять строку при этом не надо. Потом копию можно вставить в любое место программы командой Ctrl + V .

Если надо скопировать или продублировать участок в несколько строк, его следует выделить.

Выделенный участок можно сдвинуть вправо (сделать вложенным), нажав Tab . Смещение влево (на внешний уровень) выполняется комбинацией Shift + Tab .

Поднять/опустить (поменять местами с предшествующей/нижестоящей) строку или выделенный участок можно с помощью сочетаний Shift + Ctrl + стрелка вверх или стрелка вниз клавиатуры.

Примеры решения и дополнительные уроки в android-приложении и pdf-версии курса

Компания JetBrains сделала еще один шаг навстречу образованию, выпустив PyCharm Educational Edition, образовательную версию среды разработки для Python, которая включает в себя возможность создавать интерактивные курсы.

Также PyCharm Educational Edition содержит предустановленный курс "Introduction to Python", который хорошо подходит для тех, кто начинает изучать Python.

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

Установка PyCharm Educational Edition

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

Так как у вас (скорее всего) не было других версий PyCharm, оставляете как есть.

После запуска PyCharm вас встретит таким вот окном:

Выбираем "Introduction to Python". И начинаем!

Задание 1: Hello World

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

Смена интерпретатора

Может так случиться (особенно если вы сидите на linux), что PyCharm по умолчанию поставит интерпретатор Python 2.

Поэтому проверьте, и при необходимости поменяйте интерпретатор (File → Settings → Project Interpreter)

Задание 2: Комментарии

Комментарии. Достаточно написать любой комментарий. Кстати, в PyCharm нажатием "Ctrl и /" можно закомментировать / раскомментировать любую строчку.

Задание 3: Переменные

Переменные в Python являются ссылками на объект.

Нужно изменить значение переменной greetings.

Задание 4: Несуществующие переменные

Нужно попытаться вывести несуществующую переменную.

Как видите, вызвалось исключение NameError.

Задание 5: тип переменной

У каждого объекта есть тип (например, int или float).

Посмотреть тип переменной в данный момент времени можно с помощью встроенной функции type.

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

А также в PyCharm работает автодополнение.

Задание 6: преобразование типов

Типы можно преобразовывать с помощью соответствующих функций.

Преобразование к целому числу можно выполнить с помощью функции int.

Задание 7: арифметические операции

Python поддерживает арифметические операции: сложение (+), вычитание (-), умножение, (*), деление (/), целочисленное деление (//), взятие остатка от деления (%), возведение в степень.

Сразу ответ к заданию:

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

PyCharm – это одна из наиболее удобных сред разработки на языке Python. Существует в двух версиях:

  • PyCharm Community – свободно-распространяемая версия с открытым исходным кодом.
  • PyCharm Professional – проприетарная платная версия с триальным периодом.

В версии Community вы сможете программировать в основном на Python, в Professional – также на смежных языках (веб-программирование), использовать множество фреймворков.

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

В Linux, распаковав установочный пакет PyCharm, вы найдете в нем файл Install***.txt , в котором описано, что надо сделать, чтобы установить и запустить среду разработки.

Процесс может выглядеть следующим образом:

Перемещаем каталог с файлами среды разработки в директорию /opt командой

Переходим в директорию bin только что перемещенного каталога:

Выполняем файл pycharm.sh командой

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

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

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

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

Вернувшись в предыдущее окно, снимем флажок Create a main.py welcome script .

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

Слева на панели Project управляют файлами проекта. На скрине выше в каталоге pythonProject нет ни одного файла. Чтобы создать файл, в котором будет написана программа на Python, кликнем по этой папке правой кнопкой мыши. В контекстном меню выбираем New → Python File .

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

Нажав Enter , вы увидите файл на панели Project . Также он будет открыт в центральной части окна PyCharm.

После того, как исходный код написан, чтобы первый раз запустить программу, проще всего нажать Ctrl+Shift+F10 . Внизу раскроется вкладка Run , в которой отобразиться результат выполнения.

Иногда удобнее, чтобы панель выполнения программы открывалась не снизу, а, например, справа. В этом случае в настройках панели (справа значок похожий на гайку) следует выбрать Move to → Right Top .

После этого интерфейс среды разработки примет такой вид:

Внешний вид среды и множество других ее свойств, поведение настраиваются в окне Settings (меню File → Settings ). На скрине ниже показано, как изменить темную тему оформления PyCharm на светлую.

Бывает удобно менять размер шрифта в редакторе кода, зажав Ctrl и прокручивая колесо мыши. Чтобы воспользоваться этой возможностью в PyCharm, надо установить соответствующий флажок в разделе Editor → General окна настроек.

Изменить по-умолчанию заданный размер шрифта можно в разделе Editor → Font .

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

В дистрибутивах Linux обычно значок PyCharm не устанавливается в системное меню. И для последующего запуска среды вам снова надо будет обращаться к файлу pycharm.sh . Однако вы можете создать ярлык на приложение выполнив команду Tools → Create Desktop Entry… .

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

Теперь рассмотрим некоторые особенности работы в PyCharm, точнее в его редакторе кода. Многие из них универсальны, характерны для других сред разработки. Так нажатие Ctrl + D дублирует строку, в которой находится курсор.

Ctrl + C копирует строку, в которой находится курсор, выделять строку при этом не надо. Потом копию можно вставить в любое место программы командой Ctrl + V .

Если надо скопировать или продублировать участок в несколько строк, его следует выделить.

Выделенный участок можно сдвинуть вправо (сделать вложенным), нажав Tab . Смещение влево (на внешний уровень) выполняется комбинацией Shift + Tab .

Поднять/опустить (поменять местами с предшествующей/нижестоящей) строку или выделенный участок можно с помощью сочетаний Shift + Ctrl + стрелка вверх или стрелка вниз клавиатуры.

Примеры решения и дополнительные уроки в android-приложении и pdf-версии курса

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

PyCharm.

Стоит начать с того, что PyCharm существует в двух версиях: Professional(платная) и Community(бесплатная). Основные отличия в том, что версия для Community не поддерживает работу с SQL и JavaScript.

Также в версиях по разному выглядит окошко создания проекта:

И хоть нам и не предлагают удобную боковую менюшку для выбора вида проекта в Community издании, проекты, например, для Django и Flask, всё так же прекрасно создаются с помощью внутренней консоли.

Но всё же, если вы хотите Professional издание программы и не хотите за него платить пока учитесь(это объяснимо, вы ведь пока ничего не зарабатываете программированием), то тут есть несколько способов, как получить PyCharm Professional или абсолютно бесплатно или за относительно небольшую плату.

Во-первых, JetBrains без какой либо оплаты даёт попробовать профессиональную версию PyCharm на 30 дней.

Во-вторых, есть акция, которая даёт 4 месяца бесплатного пользования PyCharm(на момент написания эта акция всё ещё активна), найти её можно по ссылке . Акция доступна только для новых пользователей, у которых не было подписки на PyCharm до акции.

В-третьих, на некоторых курсах по программированию вам могут предоставить код для PyCharm на время продолжительности курса. Также, например, Stepik даёт код доступа ко всем продуктам JetBrains за обучение на бесплатных курсах, мне такой дали за обучение на курсе по Linux. Насколько я помню, код дали на 2 или 3 месяца.

Полезные советы.

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

2 . До использования PyCharm вы пользовались стандартным терминалом операционной системы, прыгая из редактора кода в терминал и обратно. Это, признаться, не очень удобно. Теперь, также можно немного облегчить себе жизнь и пользоваться встроенным в PyCharm терминалом, найти его можно в нижней части программы, третья кнопка слева.(см. скриншот)

3 . При создании нового проекта PyCharm создает для него новое виртуальное окружение(думаю вы уже знаете, что это такое и для чего оно нужно). Очень рекомендую создать для виртуальных окружений отдельную папку, иначе, в какой-то момент на вашем системном диске начнётся беспорядок из папок виртуальных окружений, вы захотите навести порядок, куда-нибудь переместите их или удалите, в итоге ваш проект перестанет работать и вы будете тратить время, чтобы всё восстановить. Достаточно один раз указать PyCharm папку и потом он будет на автомате записывть виртуальные окружения в неё, давая им имя вашего проекта.

4 . Работать с GitHub можно прямо из PyCharm. Когда вы захотите разместить ваш проект на GitHub вам нужно в PyCharm сделать следующее, нажать меню VCS вверху программы, выбрать пункт "Import into Version Control", в повившемся меню выбрать "Share Project on GitHub", после нескольких несложных операций ваш проект будет размещён на GitHub и создан новый репозиторий. После этого вы сможете пользоваться горячими клавишами для создания коммита — Ctrl + K , и для отправки изменений в ваш репозиторий на GitHub — Ctrl + Shift + K .

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

На этом пожалуй всё. Завтра наконец-то поговорим о фреймворках для создания наших с вами веб-приложений.

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

Приятного вам обучения!

Для более основательного изучения работы в PyCharm — читайте данную статью .

Pycharm умеет отображать нарушения стилистики кода согласно PEP. Это отключается так в настройках Inspections ищем язык Python, в выпадаеющем меню - PEP8 coding style violation. Дальше идем на страницу PEP8’s documentation, и ищем код ошибки. Жмем плюсик, и вставляем код:


Сохранение файлов с unix-like окончанием строк

Действует только для файлов, созданных после установки этой опции


Заключение выделенного текста в качвычки

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


Создание темплейтов для новых файлов

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


Подсветка синтаксиса Ruby

Для базовой подсветки синтаксиса Ruby можно воспользоваться плагином TextMate bundles support. Сначала его нужно склонировать склонировать куда-нибудь в /user/documents, и затем подключить в Settings -> Editor -> TextMate Bundles


Там же нужно установить желаемую цветовую схему для плагина.

Установка правой границы

В питоне, согласно PEP 0008, максимальная длина строки составляет 80 символов. Pycharm умеет делать автоматический перенос на новую строку при достижении этого ограничения. Однако, это не всегда удобно и необходимо, и отключить эту фичу можно в настройках:


gracefully restart for uwsgi server

В разработке приложений Django я использую не дев-сервер, а uwsgi, настроенный точно так же, как на продакшене. После внесения изменений в код, его надо перезавпустить, для чего я использую Remote ssh external tools :


Затем в настройках keymap назначаю кнопку - и теперь сервер можно перезапустить "одной кнопкой"!

Reformat on paste

Чтобы блок коды вставлялся в новую позицию с правильными отступами, нужно включить функцию Setting -> Editor -> General -> Smart Keys , выбрать Indent Block

Читайте также: