Как создать виртуальное окружение python в visual studio code
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Open with Desktop
- View raw
- Copy raw contents Copy raw contents
Copy raw contents
Copy raw contents
Общие сведения и шаг 1 базового пошагового руководства, посвященного возможностям Python в Visual Studio. Здесь приведены предварительные требования и описано создание проекта Python.
Руководство. Работа с Python в Visual Studio
Python — это популярный язык программирования, который отличается надежностью, гибкостью и простотой освоения. Его можно бесплатно использовать на любых операционных системах. Он поддерживается широким сообществом разработчиков. Кроме того, для него доступно множество бесплатных библиотек. Этот язык поддерживает все виды разработки, в том числе веб-приложения, веб-службы, классические приложения, создание сценариев и научные вычисления. Поэтому Python используется множеством университетов, ученых, разработчиков-любителей и профессиональных разработчиков.
Visual Studio обеспечивает первоклассную поддержку языка Python. В этом учебнике рассматриваются перечисленные ниже действия.
Шаг 1. Создание проекта Python
С помощью проекта в Visual Studio производится управление всеми файлами, составляющими приложение. К файлам приложения можно отнести исходный код, ресурсы, конфигурации. Проект формализует и поддерживает связи между всеми файлами проекта. Проект также управляет внешними ресурсами, которые являются общими для нескольких проектов. Проект позволяет приложению легко расширяться и увеличивать свой размер. Использовать проекты гораздо проще, чем вручную контролировать связи с помощью специальных папок, скриптов, текстовых файлов и собственной памяти.
В этом учебнике вы начнете работу с простого проекта, содержащего один пустой файл кода.
В Visual Studio выберите Файл > Создать > Проект (CTRL+SHIFT+N), после чего откроется диалоговое окно Создание проекта. В нем можно просмотреть шаблоны для разных языков, после чего выбрать один из них для вашего проекта и указать, куда среда Visual Studio должна поместить файлы.
Чтобы просмотреть шаблоны Python, выберите Установленные > Python в области слева или выполните поиск по слову "Python". Поиск — это отличный способ найти шаблон, если вы не помните, где он находится в дереве языков.
Поддержка Python в Visual Studio включает в себя несколько шаблонов проектов, включая веб-приложения на платформах Bottle, Flask и Django. Однако для целей данного пошагового руководства мы начнем с пустого проекта.
Выберите шаблон Приложение Python, укажите имя проекта и нажмите кнопку ОК.
Через несколько секунд в окне обозревателя решений Visual Studio (1) будет показана структура проекта. Файл кода по умолчанию откроется в редакторе (2). Кроме того, откроется окно Свойства (3), в котором приводятся дополнительные сведения для элемента, выбранного в обозревателе решений, включая его точное расположение на диске.
Потратьте несколько минут на знакомство с обозревателем решений, который служит для просмотра файлов и папок проекта.
(1) Полужирным шрифтом выделен ваш проект, имя которого вы указали в окне Создание проекта. На диске этот проект представлен файлом .pyproj в папке проекта.
(2) На верхнем уровне находится решение, имя которого по умолчанию совпадает с именем проекта. Решение, представленное на диске файлом SLN, является контейнером для одного или нескольких связанных проектов. Например, если вы создаете расширение C++ для приложения Python, этот проект C++ может входить в то же решение. Решение также может включать в себя проект веб-службы и проекты специальных тестовых программ.
(3) В проекте можно увидеть файлы исходного кода. В нашем примере это один файл .py. При выборе файла его свойства приводятся в окне Свойства. Если дважды щелкнуть файл, он откроется в соответствующем средстве.
(4) Кроме того, в проекте есть узел Окружения Python. Если развернуть его, можно увидеть доступные интерпретаторы Python. Развернув узел интерпретатора, вы увидите библиотеки, установленные в этой среде (5).
Щелкните правой кнопкой мыши любой узел или элемент в обозревателе решений, чтобы открыть меню с применимыми командами. Например, команда Переименовать позволяет изменить имя любого узла или элемента, включая проект и решение.
В Visual Studio последовательно выберите Файл > Создать > Проект или нажмите комбинацию клавиш CTRL+SHIFT+N. Откроется экран Создание проекта, где можно искать и просматривать шаблоны на разных языках.
Чтобы просмотреть шаблоны Python, выполните поиск по слову python. Поиск — это отличный способ найти шаблон, если вы не помните, где он находится в дереве языков.
Поддержка Python в Visual Studio включает в себя несколько шаблонов проектов, таких как веб-приложения на платформах Bottle, Flask и Django. Для целей этого учебника мы начнем работу с пустого проекта.
Выберите шаблон PythonConsoleApp и нажмите кнопку Далее.
На экране Настроить новый проект укажите имя и расположение файла проекта, а затем нажмите кнопку Создать.
Новый проект откроется в Visual Studio.
- В окне Обозреватель решений Visual Studio будет показана структура проекта (1) .
- Файл кода по умолчанию откроется в редакторе (2) .
- Откроется окно Свойства, в котором приводятся дополнительные сведения для элемента, выбранного в Обозревателе решений, включая его точное расположение на диске (3) .
Ознакомьтесь с Обозревателем решений, который можно использовать для просмотра файлов и папок проекта.
На верхнем уровне находится решение, имя которого по умолчанию совпадает с именем проекта (1).
Решение, представленное на диске файлом .sln, является контейнером для одного или нескольких связанных проектов. Например, если вы создаете расширение C++ для приложения Python, этот проект C++ может входить в то же решение. Решение также может включать в себя проект веб-службы и проекты специальных тестовых программ.
Ваш проект, имя которого вы указали в диалоговом окне Создание проекта, будет выделен полужирным шрифтом (2) . На диске проект представлен файлом PYPROJ в папке проекта.
В проекте можно увидеть исходные файлы. В нашем примере это один файл PY ( (3) ). При выборе файла его свойства приводятся в окне Свойства. Если дважды щелкнуть файл, он откроется в соответствующем средстве.
Кроме того, в проекте есть узел Окружения Python ( (4) ). Разверните узел, чтобы отобразить доступные интерпретаторы Python.
Развернув узел интерпретатора, вы увидите библиотеки, установленные в этой среде (5) .
Щелкните правой кнопкой мыши любой узел или элемент в Обозревателе решений, чтобы открыть контекстное меню с применимыми командами. Например, с помощью команды Переименовать можно изменить имя любого узла или элемента, в том числе проекта и решения. . moniker-end
Весь код в проекте Python выполняется в контексте определенного окружения, например в глобальном окружении Python, окружении Anaconda, виртуальном окружении или окружении Conda. Visual Studio использует это же окружение для отладки, импорта, автозавершения элементов, проверки синтаксиса и других задач, требующих языковые службы, которые характерны для данной версии Python и набора установленных пакетов.
Для всех новых проектов Python в Visual Studio настраивается глобальное окружение по умолчанию, которое указано в узле Окружения Python в обозревателе решений:
Чтобы изменить окружение для проекта, щелкните правой кнопкой мыши узел Окружения Python и выберите Добавление и удаление окружений Python. В появившемся списке глобальных, виртуальных окружений и окружений Conda выберите все окружения, которые должны отображаться в узле Окружения Python:
Когда вы щелкнете ОК, все выбранные окружения отобразятся в узле Окружения Python. Полужирным шрифтом здесь выделено окружение, которое сейчас активно:
Чтобы быстро активировать другое окружение, щелкните его имя правой кнопкой мыши и выберите команду Активировать окружение. Ваш выбор сохраняется в проекте, и выбранное окружение применяется при каждом последующем открытии проекта. Если вы снимете все флажки в диалоговом окне Добавление и удаление окружений Python, в Visual Studio будет активировано глобальное окружение по умолчанию.
В контекстном меню узла Окружения Python также доступны дополнительные команды:
Команда | Описание |
---|---|
Добавить виртуальное окружение | Запускает процесс создания виртуального окружения в проекте. Дополнительные сведения см. в разделе Создание виртуального окружения. |
Добавить существующее виртуальное окружение | Выводит запрос на выбор папки, содержащей виртуальное окружение, и добавляет окружение в список в узле Окружения Python, но не активирует его. См. дополнительные сведения об активации существующего виртуального окружения. |
Создать окружение Conda | Переключается в окно Окружения Python, в котором нужно ввести имя окружения и указать для него базовый интерпретатор. См. Окружения Conda. |
Чтобы изменить окружение для проекта, щелкните правой кнопкой мыши узел Окружения Python и выберите Добавить окружение. Можно также выбрать пункт Добавить окружение в раскрывающемся списке сред на панели инструментов Python.
Когда откроется диалоговое окно Добавление окружения, перейдите на вкладку Существующее окружение и выберите новое окружение из раскрывающегося списка Окружение:
Если вы уже добавили в проект окружение, отличное от стандартного глобального окружения, для него может потребоваться активация. Щелкните окружение правой кнопкой мыши в узле Окружения Python и выберите действие Активировать окружение. Чтобы удалить из проекта окружение, выберите действие Удалить.
Использование виртуальных окружений
Виртуальное окружение — это уникальное сочетание интерпретатора Python и набора библиотек, которое не повторяется в других глобальных окружениях и окружениях Conda. Виртуальное окружение предназначено для конкретного проекта, и данные о нем хранятся в папке проекта. В этой папке содержатся установленные библиотеки окружения и файл pyvenv.cfg, в котором указан путь к базовому интерпретатору, расположенному в другом месте файловой системы. То есть в виртуальном окружении нет копии интерпретатора, а только ссылка на него.
Преимуществом виртуального окружения является то, что в нем по мере разработки проекта всегда будут отражаться точные зависимости проекта. (С другой стороны, в общем глобальном окружении можно хранить любое число библиотек, используемых или неиспользуемых в проекте.) В виртуальном окружении можно легко создать файл requirements.txt, который будет использоваться для переустановки этих зависимостей на другой рабочий компьютер или компьютер разработки. Дополнительные сведения см. в руководстве по управлению необходимыми пакетами с помощью requirements.txt.
Если в Visual Studio открыть проект, который содержит файл requirements.txt, Visual Studio автоматически позволит воссоздать виртуальное окружение. На тех компьютерах, где не установлена среда Visual Studio, можно восстанавливать пакеты с помощью команды pip install -r requirements.txt .
Учитывая то, что в виртуальном окружении жестко запрограммирован путь к базовому интерпретатору и можно воссоздать окружение с помощью файла requirements.txt, обычно вся папка виртуального окружения не указывается в системе управления версиями.
В следующих разделах объясняется, как активировать существующее виртуальное окружение в проекте и создать новое виртуальное окружение.
В Visual Studio виртуальное окружение для проекта активируется так же, как и любое другое окружение: с помощью узла Окружения Python в обозревателе решений.
Если виртуальное окружение добавлено в проект, оно появится в окне Окружения Python. После этого вы сможете активировать его, как и любое другое окружение, и управлять его пакетами.
Создание виртуальной среды
Виртуальное окружение можно создать напрямую в Visual Studio, выполнив следующие действия.
В обозревателе решений выберите Добавить виртуальное окружение, щелкнув правой кнопкой мыши Окружения Python. Откроется следующее диалоговое окно:
В поле Расположение виртуального окружения укажите путь к виртуальному окружению. Если вы укажете только имя, для виртуального окружения в текущем проекте создается вложенная папка с таким же именем.
Выберите среду в качестве базового интерпретатора и щелкните Создать. В Visual Studio отобразится индикатор выполнения, который позволяет отслеживать процесс настройки окружения и скачивания необходимых пакетов. После завершения процесса виртуальное окружение отобразится в окне Окружения Python для проекта, в котором оно размещено.
Виртуальное окружение не активируется по умолчанию. Чтобы активировать виртуальное окружение для проекта, щелкните проект правой кнопкой мыши и выберите Активировать окружение.
Если указан путь к расположению существующего виртуального окружения, Visual Studio автоматически обнаруживает базовый интерпретатор (для этого используется файл orig-prefix.txt в каталоге окружения lib). Вместо кнопки Создать отобразится кнопка Добавить.
Если в добавляемом виртуальном окружении уже есть файл requirements.txt, в диалоговом окне Добавление виртуального окружения отображается запрос на автоматическую установку пакетов. Этот механизм упрощает восстановление окружения на другом компьютере:
В любом случае результат будет такой же, как и при добавлении существующего виртуального окружения.
Активация существующего виртуального окружения
Если у вас уже есть виртуальное окружение, его можно активировать для проекта следующим образом:
В обозревателе решений выберите Добавить существующее виртуальное окружение, щелкнув правой кнопкой мыши Окружения Python.
Откроется диалоговое окно Обзор. Найдите и выберите здесь папку с виртуальным окружением, а затем нажмите кнопку ОК. Если Visual Studio обнаружит в этом окружении файл requirements.txt, появится запрос на установку обнаруженных пакетов.
Через несколько секунд виртуальное окружение появится в узле Окружения Python****обозревателя решений. Виртуальное окружение не активируется по умолчанию, поэтому щелкните его правой кнопкой мыши и выберите действие Активировать окружение.
Создание виртуальной среды
Виртуальное окружение можно создать напрямую в Visual Studio, выполнив следующие действия.
Чтобы изменить окружение для проекта, щелкните правой кнопкой мыши узел Окружения Python в обозревателе решений и выберите Добавить окружение или выберите Добавить окружение из раскрывающегося списка окружений на панели инструментов Python. В открывшемся диалоговом окне Добавление окружения выберите вкладку Виртуальное окружение:
Укажите имя виртуального окружения, выберите базовый интерпретатор и проверьте его расположение. В разделе Install packages from file (Устанавливать пакеты из файла) укажите путь к файлу requirements.txt, если нужно.
Проверьте другие параметры в диалоговом окне.
Выберите Создать, чтобы завершить создание виртуального окружения. В Visual Studio отобразится индикатор выполнения, который позволяет отслеживать процесс настройки окружения и скачивания необходимых пакетов. После завершения процесса виртуальное окружение активируется и отображается в узле Окружения Python в обозревателе решений и в окне Окружения Python для проекта, в который оно включено.
Активация существующего виртуального окружения
Если у вас уже есть виртуальное окружение, его можно активировать для проекта следующим образом:
В обозревателе решений щелкните правой кнопкой мыши Окружения Python и выберите Добавить окружение.
Откроется диалоговое окно Обзор. Найдите и выберите здесь папку с виртуальным окружением, а затем нажмите кнопку ОК. Если Visual Studio обнаружит в этом окружении файл requirements.txt, появится запрос на установку обнаруженных пакетов.
Через несколько секунд виртуальное окружение появится в узле Окружения Python****обозревателя решений. Виртуальное окружение не активируется по умолчанию, поэтому щелкните его правой кнопкой мыши и выберите действие Активировать окружение.
Удаление виртуального окружения
В обозревателе решений щелкните правой кнопкой мыши виртуальное окружение и выберите Удалить.
В Visual Studio вам будет предложено выбрать нужное действие (убрать или удалить виртуальное окружение). Вариант Убрать означает, что окружение исчезнет из проекта, но сохранится в файловой системе. Если выбрать Удалить, окружение убирается из проекта и все его файлы удаляются из файловой системы. Это действие не затрагивает базовый интерпретатор.
Просмотр установленных пакетов
В Обозревателе решений можно развернуть узел любого окружения, чтобы быстро просмотреть установленные в нем пакеты (те, которые можно импортировать и применять в коде, когда активно это окружение):
Чтобы установить пакеты, щелкните окружение правой кнопкой мыши и выберите действие Установить пакет Python. В окне Окружения Python откроется соответствующая вкладка Пакеты. Введите условие поиска (лучше всего имя пакета), и в Visual Studio отобразятся все подходящие пакеты.
Чтобы установить новые пакеты, щелкните окружение правой кнопкой мыши и выберите действие Manage Python Packages (Управление пакетами Python). В окне Окружения Python откроется соответствующая вкладка Пакеты. На вкладке Пакеты введите условие поиска (обычно это имя пакета), и Visual Studio отобразит все подходящие пакеты.
Пакеты (и зависимости) в Visual Studio для большинства окружений скачиваются из репозитория Python Package Index (PyPI). В нем же вы можете искать доступные пакеты. В строке состояния Visual Studio и окне вывода отображаются сведения об установке. Чтобы удалить пакет, щелкните его правой кнопкой мыши и выберите Удалить.
Не забывайте, что отображаемые записи могут быть неточными, а задания установки и удаления — ненадежными или недоступными. Visual Studio использует диспетчер пакетов pip, если он доступен, и при необходимости скачивает и устанавливает его. Visual Studio также может использовать диспетчер пакетов простой установки (easy_install). Здесь же отображаются пакеты, установленные с помощью команд pip или easy_install из командной строки.
Обратите внимание, что сейчас Visual Studio не поддерживает использование conda для установки пакетов в окружении Conda. Вместо этого используйте conda из командной строки.
In this tutorial, you use Python 3 to create the simplest Python "Hello World" application in Visual Studio Code. By using the Python extension, you make VS Code into a great lightweight Python IDE (which you may find a productive alternative to PyCharm).
This tutorial introduces you to VS Code as a Python environment, primarily how to edit, run, and debug code through the following tasks:
- Write, run, and debug a Python "Hello World" Application
- Learn how to install packages by creating Python virtual environments
- Write a simple Python script to plot figures within VS Code
If you have any problems, feel free to file an issue for this tutorial in the VS Code documentation repository.
Prerequisites
To successfully complete this tutorial, you need to first setup your Python development environment. Specifically, this tutorial requires:
- VS Code
- VS Code Python extension
- Python 3
Install Visual Studio Code and the Python Extension
If you have not already done so, install VS Code.
Next, install the Python extension for VS Code from the Visual Studio Marketplace. For additional details on installing extensions, see Extension Marketplace. The Python extension is named Python and it's published by Microsoft.
Install a Python interpreter
Along with the Python extension, you need to install a Python interpreter. Which interpreter you use is dependent on your specific needs, but some guidance is provided below.
Windows
Note: If you don't have admin access, an additional option for installing Python on Windows is to use the Microsoft Store. The Microsoft Store provides installs of Python 3.7, Python 3.8, Python 3.9, and Python 3.10. Be aware that you might have compatibility issues with some packages using this method.
macOS
The system install of Python on macOS is not supported. Instead, an installation through Homebrew is recommended. To install Python using Homebrew on macOS use brew install python3 at the Terminal prompt.
Note On macOS, make sure the location of your VS Code installation is included in your PATH environment variable. See these setup instructions for more information.
Linux
The built-in Python 3 installation on Linux works well, but to install other Python packages you must install pip with get-pip.py.
Other options
Data Science: If your primary purpose for using Python is Data Science, then you might consider a download from Anaconda. Anaconda provides not just a Python interpreter, but many useful libraries and tools for data science.
Windows Subsystem for Linux: If you are working on Windows and want a Linux environment for working with Python, the Windows Subsystem for Linux (WSL) is an option for you. If you choose this option, you'll also want to install the Remote - WSL extension. For more information about using WSL with VS Code, see VS Code Remote Development or try the Working in WSL tutorial, which will walk you through setting up WSL, installing Python, and creating a Hello World application running in WSL.
Verify the Python installation
To verify that you've installed Python successfully on your machine, run one of the following commands (depending on your operating system):
Linux/macOS: open a Terminal Window and type the following command:
Windows: open a command prompt and run the following command:
If the installation was successful, the output window should show the version of Python that you installed.
Note You can use the py -0 command in the VS Code integrated terminal to view the versions of python installed on your machine. The default interpreter is identified by an asterisk (*).
Start VS Code in a project (workspace) folder
Using a command prompt or terminal, create an empty folder called "hello", navigate into it, and open VS Code ( code ) in that folder ( . ) by entering the following commands:
Note: If you're using an Anaconda distribution, be sure to use an Anaconda command prompt.
By starting VS Code in a folder, that folder becomes your "workspace". VS Code stores settings that are specific to that workspace in .vscode/settings.json , which are separate from user settings that are stored globally.
Alternately, you can run VS Code through the operating system UI, then use File > Open Folder to open the project folder.
Select a Python interpreter
Python is an interpreted language, and in order to run Python code and get Python IntelliSense, you must tell VS Code which interpreter to use.
From within VS Code, select a Python 3 interpreter by opening the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ), start typing the Python: Select Interpreter command to search, then select the command. You can also use the Select Python Environment option on the Status Bar if available (it may already show a selected interpreter, too):
The command presents a list of available interpreters that VS Code can find automatically, including virtual environments. If you don't see the desired interpreter, see Configuring Python environments.
Note: When using an Anaconda distribution, the correct interpreter should have the suffix ('base':conda) , for example Python 3.7.3 64-bit ('base':conda) .
Selecting an interpreter sets which interpreter will be used by the Python extension for that workspace.
Note: If you select an interpreter without a workspace folder open, VS Code sets python.defaultInterpreterPath in User scope instead, which sets the default interpreter for VS Code in general. The user setting makes sure you always have a default interpreter for Python projects. The workspace settings lets you override the user setting.
Create a Python Hello World source code file
From the File Explorer toolbar, select the New File button on the hello folder:
Name the file hello.py , and it automatically opens in the editor:
By using the .py file extension, you tell VS Code to interpret this file as a Python program, so that it evaluates the contents with the Python extension and the selected interpreter.
Note: The File Explorer toolbar also allows you to create folders within your workspace to better organize your code. You can use the New folder button to quickly create a folder.
Now that you have a code file in your Workspace, enter the following source code in hello.py :
When you start typing print , notice how IntelliSense presents auto-completion options.
IntelliSense and auto-completions work for standard Python modules as well as other packages you've installed into the environment of the selected Python interpreter. It also provides completions for methods available on object types. For example, because the msg variable contains a string, IntelliSense provides string methods when you type msg. :
Feel free to experiment with IntelliSense some more, but then revert your changes so you have only the msg variable and the print call, and save the file ( ⌘S (Windows, Linux Ctrl+S ) ).
For full details on editing, formatting, and refactoring, see Editing code. The Python extension also has full support for Linting.
Run Hello World
It's simple to run hello.py with Python. Just click the Run Python File in Terminal play button in the top-right side of the editor.
The button opens a terminal panel in which your Python interpreter is automatically activated, then runs python3 hello.py (macOS/Linux) or python hello.py (Windows):
There are three other ways you can run Python code within VS Code:
Right-click anywhere in the editor window and select Run Python File in Terminal (which saves the file automatically):
Select one or more lines, then press Shift+Enter or right-click and select Run Selection/Line in Python Terminal. This command is convenient for testing just a part of a file.
From the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ), select the Python: Start REPL command to open a REPL terminal for the currently selected Python interpreter. In the REPL, you can then enter and run lines of code one at a time.
Configure and run the debugger
Let's now try debugging our simple Hello World program.
First, set a breakpoint on line 2 of hello.py by placing the cursor on the print call and pressing F9 . Alternately, just click in the editor's left gutter, next to the line numbers. When you set a breakpoint, a red circle appears in the gutter.
Next, to initialize the debugger, press F5 . Since this is your first time debugging this file, a configuration menu will open from the Command Palette allowing you to select the type of debug configuration you would like for the opened file.
Note: VS Code uses JSON files for all of its various configurations; launch.json is the standard name for a file containing debugging configurations.
These different configurations are fully explained in Debugging configurations; for now, just select Python File, which is the configuration that runs the current file shown in the editor using the currently selected Python interpreter.
You can also start the debugger by clicking on the down-arrow next to the run button on the editor, and selecting Debug Python File in Terminal.
The debugger will stop at the first line of the file breakpoint. The current line is indicated with a yellow arrow in the left margin. If you examine the Local variables window at this point, you will see now defined msg variable appears in the Local pane.
A debug toolbar appears along the top with the following commands from left to right: continue ( F5 ), step over ( F10 ), step into ( F11 ), step out ( ⇧F11 (Windows, Linux Shift+F11 ) ), restart ( ⇧⌘F5 (Windows, Linux Ctrl+Shift+F5 ) ), and stop ( ⇧F5 (Windows, Linux Shift+F5 ) ).
The Status Bar also changes color (orange in many themes) to indicate that you're in debug mode. The Python Debug Console also appears automatically in the lower right panel to show the commands being run, along with the program output.
To continue running the program, select the continue command on the debug toolbar ( F5 ). The debugger runs the program to the end.
Tip Debugging information can also be seen by hovering over code, such as variables. In the case of msg , hovering over the variable will display the string Hello world in a box above the variable.
You can also work with variables in the Debug Console (If you don't see it, select Debug Console in the lower right area of VS Code, or select it from the . menu.) Then try entering the following lines, one by one, at the > prompt at the bottom of the console:
Select the blue Continue button on the toolbar again (or press F5) to run the program to completion. "Hello World" appears in the Python Debug Console if you switch back to it, and VS Code exits debugging mode once the program is complete.
If you restart the debugger, the debugger again stops on the first breakpoint.
To stop running a program before it's complete, use the red square stop button on the debug toolbar ( ⇧F5 (Windows, Linux Shift+F5 ) ), or use the Run > Stop debugging menu command.
For full details, see Debugging configurations, which includes notes on how to use a specific Python interpreter for debugging.
Tip: Use Logpoints instead of print statements: Developers often litter source code with print statements to quickly inspect variables without necessarily stepping through each line of code in a debugger. In VS Code, you can instead use Logpoints. A Logpoint is like a breakpoint except that it logs a message to the console and doesn't stop the program. For more information, see Logpoints in the main VS Code debugging article.
Install and use packages
Let's now run an example that's a little more interesting. In Python, packages are how you obtain any number of useful code libraries, typically from PyPI. For this example, you use the matplotlib and numpy packages to create a graphical plot as is commonly done with data science. (Note that matplotlib cannot show graphs when running in the Windows Subsystem for Linux as it lacks the necessary UI support.)
Return to the Explorer view (the top-most icon on the left side, which shows files), create a new file called standardplot.py , and paste in the following source code:
Tip: If you enter the above code by hand, you may find that auto-completions change the names after the as keywords when you press Enter at the end of a line. To avoid this, type a space, then Enter .
Next, try running the file in the debugger using the "Python: Current file" configuration as described in the last section.
Unless you're using an Anaconda distribution or have previously installed the matplotlib package, you should see the message, "ModuleNotFoundError: No module named 'matplotlib'". Such a message indicates that the required package isn't available in your system.
To install the matplotlib package (which also installs numpy as a dependency), stop the debugger and use the Command Palette to run Terminal: Create New Terminal ( ⌃⇧` (Windows, Linux Ctrl+Shift+` ) ). This command opens a command prompt for your selected interpreter.
A best practice among Python developers is to avoid installing packages into a global interpreter environment. You instead use a project-specific virtual environment that contains a copy of a global interpreter. Once you activate that environment, any packages you then install are isolated from other environments. Such isolation reduces many complications that can arise from conflicting package versions. To create a virtual environment and install the required packages, enter the following commands as appropriate for your operating system:
Note: For additional information about virtual environments, see Environments.
Create and activate the virtual environment
Note: When you create a new virtual environment, you should be prompted by VS Code to set it as the default for your workspace folder. If selected, the environment will automatically be activated when you open a new terminal.
For Windows
If the activate command generates the message "Activate.ps1 is not digitally signed. You cannot run this script on the current system.", then you need to temporarily change the PowerShell execution policy to allow scripts to run (see About Execution Policies in the PowerShell documentation):
For macOS/Linux
Select your new environment by using the Python: Select Interpreter command from the Command Palette.
Install the packages
Rerun the program now (with or without the debugger) and after a few moments a plot window appears with the output:
Once you are finished, type deactivate in the terminal window to deactivate the virtual environment.
For additional examples of creating and activating a virtual environment and installing packages, see the Django tutorial and the Flask tutorial.
Next steps
You can configure VS Code to use any Python environment you have installed, including virtual and conda environments. You can also use a separate environment for debugging. For full details, see Environments.
To learn to build web apps with the Django and Flask frameworks, see the following tutorials:
Управление зависимостями играет важную роль для разработчиков пакетов и ПО. Но как насчет специалистов по науке о данных, которые не занимаются развертыванием PyPI или conda-forge?
Если вы уже работали с Python, то знаете, как тяжело разобраться в этой загроможденной среде разработки с большим количеством установленных пакетов. Поиск действительно необходимых для проекта пакетов — непростая задача для выполнения вручную .
Пакеты не всегда обновляются одновременно, а многие из них несовместимы друг с другом или даже с используемой версией Python или Anaconda. Нет никаких гарантий, что пакеты из разных каналов в conda не будут конфликтовать. При загрузке всех элементов в одну большую среду возникновение противоречивых зависимостей неизбежно. Не говоря уже о различных инструментах, таких как pip, pipx, conda, poetry, hatch, pipenv, pyenv, virtualenv, pyvenv, pyenv-virtualenv, virtualenvwrapper, pyenv-virtualenvwrapper и venv… которые, несмотря на похожие названия, зачастую даже не совместимы друг с другом.
Еще одна причина не использовать anaconda вне контейнера — вы не знаете, что именно запускаете. В некоторых случаях сценарий активации anaconda настолько сильно искажает очистку среды системы pre-pyenv, что единственный способ быстро решить эту проблему — добавить HOST=$(hostname) к .zshrc.
Здесь можно найти краткое руководство по настройке системы с помощью pyenv и pyenv-virtualenv. Преимущества такого способа управления:
- чистый, гибкий и реверсивный;
- устойчивый к ошибкам пользователей;
- хорошая защита от ошибок, возникающих в среде при работе с anaconda.
Для защиты важных файлов перед установкой новой системы с помощью этого метода также рекомендую использовать Arq Cloud Backup, который работает аналогично git и почти полностью автоматизирован.
После завершения установки pyenv можно приступать к созданию рабочих процессов в виртуальных средах. Рассмотрим создание проекта с дистрибутивом Anaconda, чтобы узнать, как можно использовать Visual Studio Code для разработки Jupyter notebooks и их конвертирования в сценарии .py.
У каждого проекта должна быть своя директория, а у каждой директории — своя виртуальная среда. Эта структура выполняет две важные функции:
- Обеспечивает правильную организацию всех элементов, что упрощает разделение проектов, управление зависимостями и исключает лишние элементы.
- Позволяет создать отдельный .python-version file для каждой директории (и, следовательно, для каждого проекта). Это означает, что pyenv-virtualenv может автоматически переключаться на соответствующую среду при смене директории.
TL;DR-версия для установки проекта:
- Создайте папку проекта и перейдите ( cd ) в нее.
- Установите проект Python с помощью pyenv local $PYTHON_VERSION .
- Запустите эту команду для создания виртуальной среды: pyenv virtualenv anaconda3–2019.10 venv-cool_project . Если версия Python не указана, то среда будет использовать ту, которая работает локально на данный момент.
- Установите новую среду в качестве локального Python-проекта с помощью команды pyenv local с именем venv и активируйте ее с помощью conda activate venv-cool_project .
При запуске приведенного ниже однострочника при каждом создании нового проекта вы получаете возможность входить и выходить ( cd ) из директорий, а виртуальные среды будут автоматически активироваться и деактивироваться (вам также нужно изменить имя среды и интерпретатор Python).
Ниже представлен GitHub gist со сценарием, который сделает всю работу за вас. Загрузите его (потребуется запустить chmod +x newproj.sh , чтобы убедиться, что он выполняемый). Затем просто используйте его для создания новых проектов, передав ему нужную версию Python и имя проекта:
Visual Studio Code сочетает в себе множество классных функций. Например, он может автоматически выбирать подходящий виртуальный интерпретатор для директории проекта, если вы установите его в соответствии с инструкциями выше.
Для начала воспользуемся brew cask install visual-studio-code .
Затем переходим к настройкам VS Code:
- Убедитесь, что терминал системы синхронизирован с терминалом приложения: VS Code должен использовать приложение терминала вашей ОС с переменной «External».
- Включите встроенную функцию терминала, чтобы использовать эмулятор в приложении VSCode.
- Откройте палитру команд с помощью ⌘+⇧+P и выберите Shell Command: Install 'code' command in PATH . Таким образом вы запустите VS Code из внешнего терминала: code -- запускает приложение, code. открывает текущую рабочую директорию, а code path/to/file/or/dir открывает определённый файл или директорию.
- Установите расширение Python для VS Code. Таким образом, при сохранении файла с расширением Python редактор будет знать, что нужно интерпретироваться в контексте Python.
При входе и выходе из директорий проектов в интегрированном терминале интерпретатор python автоматически определяет venvs при наличии файла .python-version (файл должен существовать при правильном использовании pyenv-virtualenv).
Чтобы указать приложению, какой интерпретатор Python нужно использовать, нажмите на имя интерпретатора Python на нижней панели инструментов или откройте палитру команд и введите Python: Select Interpreter .
Находясь в терминале, также можно создавать и активировать новые venvs привычным образом.
Чтобы воспользоваться ноутбуками, просто откройте файл .ipynb или выберите Python: Create New Blank Jupyter Notebook из палитры команд, находясь в среде conda. Теперь можно запускать ячейки и создавать ноутбуки в обычном режиме, но с дополнительным преимуществом, которое не зависит от веб-браузера.
Ноутбук также можно конвертировать в сценарий Python одним щелчком мыши или с помощью Python: Convert to python script :
Это удобный способ превращения разведочного анализа в готовые к выполнению, воспроизводимые программы.
Мы рассмотрели управление пакетами в среде разработки, простое превращение conda envs в файлы requirements.txt и более эффективную очистку ноутбуков для создания работоспособных сценариев. VS Code предлагает еще больше инструментов, таких как подсветка синтаксиса, линтинг, интеграция тестов и интерфейсы с GitHub, Docker, различными базами данных и многим другим для активизации проектов. Добавьте эти инструменты в рабочий процесс науки о данных, чтобы стать более эффективным программистом и разработчиком!
В одной из прошлых статей я разбирался как настроить python и virualenv на Mac OS. Но, в связи с переездом на Windows, в этой статье коротко расскажу как настроить python, visual studio code и virtualenv на этой операционно.
- Запуск PowerShell
- Установка Chocolately.
- Установка Python 3.
- Установка Visual Studio Code.
- Установка virtualenv.
- Создание виртуального окружения.
Так как я работаю на Windows 10, я использую оболочку PowerShell. Чтобы запустить powershell, на рабочем столе нажимаем сочетание клавиш CTRL+X, в открывшемся меню выбираем “Window PowerShell (администратор)”.
Замена командной строки на PowerShell
Если вы работаете на Windows 10, но в указанном месте у вас опции “Командная строка”, надо перейти в настройки панели задач и выбрать вариант замены командной строки на PowerShell. Для этого:
- На панели инструментов нажимаем правую кнопку мыши и выбираем опцию “Параметры панели задач”.
2. В открывшемся окне активируем опцию “Заменить командную строку оболочкой Windows PowerShell…”.
Несколько полезных команд PowerShell / командной строки
Создать новую папку:
Где folder_name — название папки.
Перейти в папку:
Перейти из папки на уровень выше:
Перейти на другой диск:
Показать содержимое папки:
Очистить экран PowerShell / командной строки
Chocolately — это пакетный менеджер, используя который можно устанавливать некоторые программы из командной строки.
Для установки менеджера в запущенном от имени администратора PowerShell вставляем код ниже:
После установки этого менеджера, другие программы можно установить через командную строку набрав следующий код:
Продолжаем устанавливать нужные программы через командную строку. Для установки Python 3 вводим код:
Visual Studio Code — GUI, который помогает более комфортно работать с кодом (писать, тестировать, сохранять и т.д.).
Для установки Visual Studio Code через PowerShell / командную строку вводим команду:
Эта команда, кроме установки VSC так же установит GIT (менеджер контроля версий).
Virtualenv — средство для создания виртуальных окружений, которое поможет решать проблемы совместимости разных версий пакетов.
Все также в PowerShell вводим команду:
6. Создание виртуального окружения
Создаем папку, в которой будет храниться нужное виртуально окружение. Переходим в нее и набираем в PowerShell команду создания нового виртуального окружения:
Где env_name — название окружения.
Чтобы запустить созданное виртуальное окружение, набираем команду:
Если все сделано верно и виртуально окружение запустилось, в PowerShell напротив активной строки появится название виртуального окружения.
Чтобы выключить виртуальное окружение, достаточно набрать команду:
Надеюсь, эта инструкция поможет вам быстро установить и настроить Chocolately, Python 3, Visual Studio Code и virtualenv на Windows.
Читайте также: