Настройка кода Python для Visual Studio

Обновлено: 24.11.2024

Недавно я решил выучить язык Python для одного из своих проектов. В настоящее время я нахожусь в процессе настройки моей системы macOS для среды разработки Python. Я установил последнюю версию Python 3.x на свой MacBook Pro. Поскольку я уже использую VS Code IDE, я подумываю использовать ее для программирования на Python. Здесь я поделюсь с вами своими действиями по настройке Visual Studio Code для Python в macOS.

Используемые инструменты и технологии

  • macOS Мохаве (10.14.5)
  • Код Visual Studio (1.36.0)
  • Питон (3.7.3)

Шаги по настройке VS Code для Python

Предпосылки

Выбор интерпретатора Python

  1. Запустите VS Code.
  2. Откройте папку для рабочей области Python, выбрав «Файлы» >> «Открыть…» >> Выберите или создайте папку в окне поиска и откройте ее. Это будет ваше рабочее пространство Python.
  3. Теперь откройте палитру команд, нажав клавиши Shift, Command и P.
  4. В палитре команд введите и выберите Python: Select Interpreter.
  5. Из списка интерпретаторов выберите подходящий интерпретатор Python 3.x. Это действие создаст папку .vscode внутри вашей рабочей области. Внутри этой папки .vscode вы можете найти файл settings.json, в котором хранятся настройки, относящиеся к рабочей области. В нашем случае вы можете найти путь к интерпретатору Python.
  6. В нижнем левом углу окна VS Code вы также можете увидеть версию Python.

    7. Теперь Visual Studio Code готов к интерпретации и запуску кода Python. Пришло время создать исходный код Python в VS Code и проверить его.

    Создайте свой первый код Python в VS Code

    1. На панели проводника нажмите значок "Новый файл" напротив папки рабочей области. Введите имя файла с расширением .py. Я назвал его first.py.
    2. В только что созданном файле введите код Python. Например, я использовал приведенный ниже код, где строковое значение присваивается переменной, а переменная передается в качестве параметра функции печати. При вводе исходного кода вы можете увидеть, как intellisense показывает вам функции автозаполнения и значения параметра функции. Это указывает на то, что настройки, которые мы сделали ранее, были правильными.
      message = «Hello Python World. ”
      печать(сообщение)
    3. Чтобы запустить этот код, щелкните правой кнопкой мыши где-нибудь в редакторе и выберите "Запустить файл Python в терминале".
    4. Это действие откроет панель терминала внизу и запустит файл python для выбранного интерпретатора. Результат будет таким:

      5. Настройка отладчика

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

      Базовая настройка отладчика Python завершена. Теперь VS Code готов к отладке кода Python. Вы можете отредактировать файл launch.json и изменить или добавить параметры конфигурации. Подробнее о настройке отладчика читайте здесь. Теперь посмотрим, как пользоваться отладчиком

      Использование отладчика Python

      1. Откройте файл Python.
      2. Установите точку останова на строке с печатным комментарием, нажав левую полосу перед номером строки.
      3. Нажмите значок отладки на боковой панели, чтобы открыть панель отладки.
      4. Нажмите зеленую стрелку отладки в верхней части панели отладки.
      5. Отладчик запустится и остановится в точке останова. К этому времени вы заметите некоторые изменения в редакторе. Сверху появится панель инструментов отладки, которую вы можете использовать для продолжения, перехода, входа, выхода, перезапуска и остановки отладки. В панели отладки вы можете увидеть переменные и их значения. Консоль отладки Python появится внизу. Строка состояния меняет цвет на оранжевый.
      6. Если вы наведете указатель мыши на переменную в окне редактора, она покажет сохраненное в ней значение.
      7. Нажмите значок "Продолжить" на панели инструментов отладки, чтобы завершить отладку и получить результат в консоли терминала.

        8. Заключение

        Мы рассмотрели настройку рабочей области Python в Visual Studio Code для macOS, а также базовые настройки отладки.

        Работа с Python в Visual Studio Code с использованием расширения Microsoft Python проста, интересна и продуктивна. Расширение делает VS Code отличным редактором Python и работает в любой операционной системе с различными интерпретаторами Python. Он использует все возможности VS Code для обеспечения автоматического завершения и IntelliSense, линтинга, отладки и модульного тестирования, а также возможность легко переключаться между средами Python, включая виртуальные среды и среды conda.

        В этой статье представлен только обзор различных возможностей расширения Python для VS Code. Для ознакомления с редактированием, запуском и отладкой кода используйте кнопку ниже.

        Установите Python и расширение Python

        Установив версию Python, активируйте ее с помощью команды Python: Select Interpreter. Если VS Code не находит нужный интерпретатор автоматически, см. раздел Среды — указание интерпретатора вручную.

        Вы можете настроить расширение Python в настройках. Узнайте больше в справочнике по настройкам Python.

        Подсистема Windows для Linux. Если вы работаете в Windows, WSL — отличный способ разработки на Python. Вы можете запускать дистрибутивы Linux в Windows, и Python часто уже установлен. В сочетании с расширением Remote — WSL вы получаете полную поддержку редактирования и отладки VS Code при работе в контексте WSL. Чтобы узнать больше, перейдите к разделу «Разработка в WSL» или ознакомьтесь с учебным пособием «Работа в WSL».

        Запустить код Python

        Чтобы испытать Python, создайте файл (с помощью проводника) с именем hello.py и вставьте в него следующий код:

        Расширение Python затем предоставляет ярлыки для запуска кода Python в выбранном в данный момент интерпретаторе (Python: выберите интерпретатор в палитре команд):

        • В текстовом редакторе: щелкните правой кнопкой мыши в любом месте редактора и выберите «Запустить файл Python в терминале». При вызове для выбора выполняется только этот выбор.
        • В проводнике: щелкните файл Python правой кнопкой мыши и выберите "Запустить файл Python в терминале".

        Вы также можете использовать команду «Терминал: Создать новый терминал», чтобы создать терминал, в котором VS Code автоматически активирует текущий выбранный интерпретатор. См. Среды ниже. Python: Start REPL активирует терминал с текущим выбранным интерпретатором, а затем запускает Python REPL.

        Более подробные пошаговые инструкции по запуску кода см. в руководстве.

        Автозаполнение и IntelliSense

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

        IntelliSense быстро показывает методы, члены класса и документацию по мере ввода, а завершение можно активировать в любое время с помощью ⌃Пробел (Windows, Linux Ctrl+Space ) . Вы также можете навести указатель мыши на идентификаторы, чтобы получить дополнительную информацию о них.

        Совет. Ознакомьтесь с расширением IntelliCode для VS Code (предварительная версия). IntelliCode предоставляет набор возможностей с поддержкой ИИ для IntelliSense в Python, таких как вывод наиболее релевантных автозавершений на основе текущего контекста кода.

        Линтинг

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

        Расширение Python может применять ряд различных линтеров, включая Pylint, pycodestyle, Flake8, mypy, pydocstyle, prospector и pylama. См. Линтинг.

        Отладка

        Больше никакой отладки операторов печати! Установите точки останова, проверьте данные и используйте консоль отладки, шаг за шагом запуская программу. Отладка различных типов приложений Python, включая многопоточные, веб-приложения и удаленные приложения.

        Подробные сведения о Python, включая настройку конфигурации launch.json и удаленную отладку, см. в разделе Отладка. Общие сведения об отладке кода VS можно найти в документе по отладке. Учебники по Django и Flask также демонстрируют отладку в контексте этих веб-приложений, включая отладку шаблонов страниц Django.

        Среда

        Расширение Python автоматически обнаруживает интерпретаторы Python, установленные в стандартных местах. Он также обнаруживает среды conda, а также виртуальные среды в папке рабочей области. См. раздел Настройка среды Python.

        Текущая среда отображается в левой части строки состояния VS Code:

        В строке состояния также указывается, не выбран ли интерпретатор:

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

        Чтобы изменить текущий интерпретатор, включая переключение на conda или виртуальные среды, выберите имя интерпретатора в строке состояния или используйте команду Python: Select Interpreter.

        VS Code предложит вам список обнаруженных сред, а также тех, которые вы добавили вручную в свои пользовательские настройки (см. Настройка сред Python).

        Установка пакетов

        Пакеты устанавливаются с помощью панели терминала и таких команд, как pip install

        (Windows) и установка pip3

        (macOS/Linux). VS Code устанавливает этот пакет в ваш проект вместе с его зависимостями. Примеры приведены в руководстве по Python, а также в руководствах по Django и Flask.

        Блокноты Jupyter

        Если вы откроете файл блокнота Jupyter ( .ipynb ) в VS Code, вы сможете использовать редактор блокнота Jupyter для непосредственного просмотра, изменения и запуска ячеек кода.

        Открытие записной книжки в виде файла Python позволяет использовать все возможности отладки VS Code. Затем вы можете сохранить файл записной книжки и снова открыть его как записную книжку в редакторе записных книжек, Jupyter или даже загрузить его в такую ​​службу, как Записные книжки Azure.

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

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

        Расширение Python поддерживает тестирование с помощью unittest и pytest.

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

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

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

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

        Другие популярные расширения Python

        Расширение Microsoft Python предоставляет все функции, описанные ранее в этой статье. Дополнительную поддержку языка Python можно добавить в VS Code, установив другие популярные расширения Python.

        1. Откройте представление «Расширения» ( ⇧⌘X (Windows, Linux Ctrl+Shift+X)).
        2. Отфильтруйте список расширений, введя "python".

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

        Загрузить и установить код Visual Studio

        Как я уже упоминал, VS Code можно скачать и установить на любую операционную систему. Ради этой статьи я собираюсь показать, как установить то же самое в Windows. Кроме того, я буду использовать Windows в качестве среды разработки для настройки среды Python. Для Linux и macOS процесс будет почти таким же; однако в командах могут быть некоторые изменения.

        Рисунок 1. Загрузка кода Visual Studio для Windows

        После завершения загрузки продолжите обычную установку. После успешной установки вы увидите, как запускается Visual Studio Code, как показано ниже:

        Рис. 2. Запуск кода Visual Studio

        Загрузить и установить Python

        Рисунок 3. Загрузка Python 3.8.3

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

        Если Python был успешно установлен, эта команда вернет установленную версию Python. Я уже скачал Python, и у меня установлена ​​версия 3.8.1, а не 3.8.3:

        Рисунок 4. Проверка установки Python

        Теперь, когда оба необходимых компонента установлены, мы можем приступить к настройке среды разработки для Visual Studio Code for python.

        Установите расширение Python для VS Code

        Сначала обо всем по порядку. По умолчанию VS Code работает как простой текстовый редактор и не имеет встроенной поддержки Python. Что я имею в виду под предыдущим утверждением, так это то, что даже если вы сейчас можете писать код Python в VS Code, вы не сможете использовать некоторые инструменты или методы разработчика, которые значительно упрощают написание кода. Например, давайте начнем создавать файл Python с именем «main.py», импортируем модуль JSON и напечатаем оператор «Hello World». Когда вы пишете код, вы видите, что в редакторе кода нет автозаполнения или IntelliSense, и вам нужно написать весь оператор самостоятельно:

        Рисунок 5. Настройка Visual Studio Code для Python

        Рисунок 6. Загрузка расширения Python для Visual Studio Code

        Кроме того, вы также можете нажать значок "Расширения" на левой панели в Visual Studio Code и выполнить поиск по ключевому слову "python". Выберите расширение, предоставленное Microsoft, и нажмите «Установить». Я уже установил расширение на свой компьютер:

        Рисунок 7. Поиск и установка расширения Python для VS Code

        Как только расширение Python будет установлено, вы увидите, что в крайнем правом верхнем углу появляется кнопка «Выполнить», с помощью которой вы можете запустить файл python непосредственно во встроенном терминале. в коде ВС. Кроме того, еще одна вещь, которую вы можете заметить здесь, это то, что вы получаете несколько вариантов того, как вы хотите запустить открытый файл python:

        Рисунок 8. Функции расширения Python

        Еще один момент, который вы можете заметить после установки этого расширения, заключается в том, что оно предоставляет нам своего рода удобную документацию, когда мы наводим курсор на определенный объект. Например, в том же файле, если навести курсор на ключевое слово «json», теперь можно увидеть, что видна небольшая всплывающая подсказка, содержащая информацию о модуле json. Вы можете прокрутить страницу ниже и найти другую информацию о том, как использовать модуль и т. д.:

        Рисунок 9. Поддержка документации в VS Code

        IntelliSense в Visual Studio Code для Python

        Во-вторых, говоря об IntelliSense, вы можете видеть, что теперь он включен, и вы можете легко получить ключевые слова автозаполнения из раскрывающегося списка. Например, если сейчас вы начнете вводить «импорт», редактор автоматически начнет предлагать ключевые слова, соответствующие слову, которое вы вводите. Это помогает достичь более высокой скорости написания кода, поскольку вам не нужно вручную вводить слова целиком, чтобы скрипт заработал:

        Рисунок 10. Intellisense в Visual Studio Code для Python

        Фрагменты в Visual Studio Code

        Фрагменты очень удобны, когда вам нужно реализовать блок операторов в коде без необходимости писать весь синтаксис. Вы можете рассматривать это как шаблон кода для блока, такого как блок if-else и блок операторов for или блок try-catch. . Давайте теперь попробуем написать блок if-else, используя фрагмент кода:

        Рисунок 11. Использование фрагмента кода If Else

        Как только вы выберете фрагмент кода if/else, вы увидите, что в редакторе появляется блок предопределенного кода, и вы можете просто редактировать значения, не изменяя блок.Вы можете использовать клавишу «TAB» и перейти от условия к значениям pass:

        Рисунок 12. Фрагмент If Else

        Отладка в Visual Studio Code для Python

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

        Рисунок 13. Запуск и отладка кода

        Выберите «Файл Python» в раскрывающемся списке «Конфигурация отладки». Вот и все. Теперь вы можете видеть, что ваш код был успешно выполнен отладчиком, а вывод доступен в окне терминала ниже:

        Рисунок 14. Отладка кода Python в Visual Studio Code

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

        Рисунок 15. Сеанс отладки в VS Code

        Заключение

        В этой статье я объяснил, как загрузить и установить Visual Studio Code на локальный компьютер и как установить расширение внутри VS Code. Я также объяснил, как настроить Visual Studio Code для программирования на Python, установив необходимые расширения, которые предлагают разработчикам гораздо большую гибкость и IntelliSense, а также помогают писать код быстрее и продуктивнее. Хотя в статье я упомянул только одно расширение, поскольку я его использую, существует множество расширений, которые вы можете использовать для соответствующей настройки и настройки среды разработки. Все расширения для Visual Studio Code можно найти на рынке Visual Studio Code. Я напишу еще одну статью с еще несколькими важными статьями, которые мы можем использовать, чтобы сделать или работать более продуктивно.

        Настройка VS Code IDE для разработки на Python — TutLinks

        В этом руководстве мы рассмотрим IDE VS Code с открытым исходным кодом и почему мы выбрали его для разработки на Python. Мы также увидим, как настроить Visual Studio Code для разработки на Python и настроить его для примера проекта Flask hello world на основе Python.

        • Краткое введение и обзор Visual Studio Code.
        • Почему мы выбираем VS Code для разработки приложений Python.
        • Установка подключаемых модулей VS Code, упрощающих разработку Python.
        • Настройка подключаемых модулей VS Code для простого проекта Flask.

        Обзор Visual Studio Code IDE

        Visual Studio Code — это интегрированная среда разработки, просто редактор для кодирования, написания и отладки программных приложений, написанных на различных языках программирования. Visual Studio Code — это предложение с открытым исходным кодом от Microsoft. VS Code оказалась лучшей среди любых других IDE в мире разработки программного обеспечения благодаря большому сообществу, поддержке, огромному количеству плагинов, чем любая другая IDE, и огромному количеству загрузок. VS Code предлагает различные возможности с помощью подключаемых модулей и многие разработчики программного обеспечения используют IDE.

        Почему я предпочитаю VS Code для разработки приложений на Python

        Вы можете настроить редактор с помощью предпочтений и настроек или изменить его внешний вид, выбрав различные цветовые темы (Ctrl+K Ctrl+T), которые он предлагает. VS Code поставляется с минимальным пользовательским интерфейсом и меню с высоким контролем над аспектами графического интерфейса IDE с помощью богатого набора настраиваемых сочетаний клавиш, которые нравятся большинству разработчиков. Почти все языки программирования поддерживают IntelliSense через соответствующие плагины.

        Другими популярными альтернативами VS Code IDE для разработки на Python являются PyCharm, Visual Studio, Atom и многие другие. Я буду использовать Visual Studio Code и буду настраивать IDE для разработки программирования на Python.

        Настроить IDE VS Code для разработки на Python

        Сначала мы установим основные подключаемые модули VS Code, чтобы облегчить разработку Python. Позже мы настроим установленные плагины для примера проекта Flask на основе Python, с которым мы хотим работать.

        Установка расширений/плагинов Python для IDE VS Code

        • Расширение ms-python.python для разработки на Python с такими возможностями, как Linting, отладка (многопоточная, удаленная), Intellisense, Jupyter Notebooks, форматирование кода, рефакторинг, модульные тесты, фрагменты кода и многое другое.
        • eamodio.gitlens , GitLens — расширенное расширение Git для управления системой контроля версий через Git. Вот описание из официального плагина GitLens о том, что он предлагает. GitLens расширяет возможности Git, встроенные в Visual Studio Code. Это поможет вам с первого взгляда визуализировать авторство кода с помощью аннотаций вины Git и линзы кода, легко перемещаться и исследовать репозитории Git, получать ценную информацию с помощью мощных команд сравнения и многое другое.
        • donjayamanne.githistory Git History для просмотра журнала git, истории файлов, сравнения веток или коммитов.

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

        Настройка подключаемых модулей VS Code для Python

        После установки этих расширений настройте IDE VS Code для разработки на Python.

        Обратите внимание, что при создании нового проекта Python или в существующем проекте Python необходимо выполнить следующие настройки. Вы также можете создать базовое приложение Python на основе Hello World Flask и попробовать настроить подключаемые модули Python для VS Code IDE.

        Вам необходимо создать виртуальную среду, прежде чем настраивать IDE VS Code. Для этого вы можете обратиться к этому подробному руководству по работе с виртуальными средами в Python для начинающих. В противном случае вы также можете обратиться к этому видео, в котором подробно рассказывается о том, как управлять проектами Python с помощью Virtualenv

        Настройка интерпретатора Python в VS Code

        В IDE VS Code нажмите клавиши Ctrl+Shift+P и введите Python:Select Interpreter в текстовом поле, которое появляется в верхней середине IDE VS Code, чтобы выбрать интерпретатор. Выберите путь, который указывает на вашу виртуальную среду.

        Настроить Линтер

        Линтер — это, как правило, программа, выполняющая статический анализ кода. Линтер поможет уменьшить ошибки времени компиляции, возникающие из-за синтаксических ошибок. Каждая программа имеет свой собственный статический анализатор кода, также известный как линтер, и может быть установлена ​​как расширение, если оно доступно в VS Code.

        В VS Code нажмите клавиши Ctrl+Shift+P и введите Python:Select Linter в текстовом поле, которое появляется в верхней середине IDE VS Code, чтобы выбрать linter. Нажав Enter, выберите линтер по вашему выбору. Давайте выберем пилинт .

        Будет создан файл с именем settings.json со ссылками на Interpreter и Linter. В файле settings.json, расположенном в каталоге .vscode в корне проекта.

        Убедитесь, что вы указываете python.pythonPath на исполняемый файл python виртуальной среды. Также убедитесь, что настройки линтера включены. В ОС Windows файл .vscode\settings.json должен выглядеть примерно так, как показано ниже.

        Вернуться в каталог .vscode для контроля версий

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

        Видеоруководство

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