Что такое venv и virtualenv в Python, и как их использовать

В этой статье будут показаны установка, настройка, а также проведен полный обзор всех возможностей использования утилит venv и virtualenv для Python. Но начнем мы с рассмотрения общих вопросов.

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

Чтобы решать подобные проблемы, разработчики придумали интересный способ: запускать каждое приложение со своим набором версий библиотек в изолированных средах. Таким образом, виртуальная среда (virtual environment) в языке Python позволяет управлять проектами изолированно друг от друга, то есть:

• у каждого проекта могут быть свои зависимости;
• зависимости одного проекта не влияют на зависимости другого проекта.

Создавать виртуальное окружение в Python можно при помощи различных утилит. И сегодня мы поговорим про venv и virtualenv.

Важно: перед началом работы у Вас должен быть установлен Python 3 и pip. Если Вы используете Windows, все следующие команды, кроме тех, где будет альтернативный вариант, выполняются таким же образом, но необходимо заменять pip3 на pip, а python3 на Python.

Содержание:

1. Работа с venv
   1. Создание проекта
   2. Создание виртуальной среды
   3. Активация виртуальной среды
   4. Проверка установленных пакетов
   5. Выход из виртуальной среды
   6. Перенос установленных пакетов
   7. Импорт пакетов в другую среду
2. Работа с virtualenv
   1. Установка virtualenv и создание виртуальной среды
3. Работа с virtualenvwrapper
   1. Установка virtualenvwrapper
   2. Создание виртуальной среды
   3. Просмотр всех созданных виртуальных сред
   4. Переключение между виртуальными средами
   5. Выход из виртуальной среды
   6. Копирование виртуальной среды
   7. Удаление виртуальной среды
4. Выводы

Работа с venv

Чтобы создать виртуальную среду, мы используем модуль venv. Это удобный инструмент для управления зависимостями и изоляции проектов, который выстроен в Python, начиная с версии Python 3.3+. Поэтому модуль venv нельзя использовать для изоляции программ Python 2.

Создание проекта

Приступим к созданию проекта. Первым делом следует создать папку проекта и перейти в нее, в Linux это можно сделать при помощи следующих команд:

$ mkdir my_python_project
cd my_python_project

Замените my_python_project на желаемое название проекта.

Создание виртуальной среды

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

$ python3 -m venv project_name_myproject

Замените project_name_myproject на желаемое название виртуальной среды.

Если у Вас возникает следующая ошибка:

The virtual environment was not created successfully because ensurepip is not
available. On Debian/Ubuntu systems, you need to install the python3-venv
package using the following command.

apt-get install python3-venv

You may need to use sudo with that command. After installing the python3-venv
package, recreate your virtual environment.

Failing command: ['/home/osboxes/my_python_project/project_name_myproject/bin/python3', '-Im', 'ensurepip', '--upgrade', '--default-pip']

То Вам необходимо установить venv. Например, в Ubuntu для этого требуется выполнить следующую команду:

$ sudo apt-get install python3-venv -y

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

Активация виртуальной среды

Осталось активировать виртуальную среду при помощи команды:

$ source project_name_myproject/bin/activate

Замените project_name_myproject на название виртуальной среды, созданной на прошлом шаге.

Если Вы используете Windows, и у Вас правильно установлен Python и pip, то Вы можете активировать виртуальную среду следующей командой:

$ project_name_myproject/Scripts/activate

Замените project_name_myproject на название виртуальной среды, созданной на прошлом шаге.

Проверка установленных пакетов

Теперь проверим установленные пакеты pip внутри виртуальной среды:

$ pip3 list

Вывод должен быть примерно такой:

Package Version
------------- -------
pip 20.3.4
pkg-resources 0.0.0
setuptools 44.1.1

Как мы видим, внутри виртуальной среды у нас нет никаких сторонних установленных библиотек pip. Можно установить какой-либо пакет, например, модуль requests:

$ pip3 install requests

Теперь снова проверим список установленных пакетов pip внутри виртуальной среды:

$ pip3 list

В выводе должен появиться наш только что установленный пакет:

Package Version
------------- ---------
certifi 2021.5.30
chardet 4.0.0
idna 2.10
pip 20.3.4
pkg-resources 0.0.0
requests 2.25.1
setuptools 44.1.1
urllib3 1.26.5

Выход из виртуальной среды

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

$ deactivate

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

Package Version
---------------------- -------------
apturl 0.5.2
bcrypt 3.1.7
blinker 1.4
Brlapi 0.8.2
certifi 2020.6.20
chardet 4.0.0
chrome-gnome-shell 0.0.0
click 7.1.2
colorama 0.4.4
command-not-found 0.3
cryptography 3.3.2

Перенос установленных пакетов

Для переноса установленных пакетов в другую среду на Linux можно использовать простую команду:

$ python3 -m pip freeze > requirements.txt

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

Импорт пакетов в другую среду

Теперь можно перейти в другую виртуальную среду и импортировать пакеты следующей командой:

$ pip3 install -r requirements.txt

Работа с virtualenv

Утилита virtualenv — это наиболее популярный инструмент, который используется для создания изолированных сред в Python. Он создает папку, содержащую все необходимые исполняемые файлы для использования пакетов, которые потребуются проекту Python. В отличие от модуля venv, эту утилиту можно использовать как в Python 3, так и в версии 2.7.

Установка virtualenv и создание виртуальной среды

Чтобы установить утилиту virtualenv, используйте pip:

$ pip install virtualenv

Создание виртуальной среды virtualenv происходит так:

$ cd project_folder
$ virtualenv myproject

virtualenv myproject создаст папку в текущем каталоге. В ней будут находиться исполняемые файлы Python и копия библиотеки pip, которую Вы можете использовать для установки других пакетов. Имя виртуальной среды (в данном случае это было myproject) может быть любым. Если имя отсутствует, файлы будут помещены в текущий каталог. Таким образом создается копия Python в любом каталоге, в котором Вы запускали команду, помещая её в папку с именем myproject.

Вы также можете использовать интерпретатор Python по выбору. Пример использования python 2.7:

$ virtualenv -p /usr/bin/python2.7 myproject

Для версии python 3.7:

$ virtualenv -p /usr/bin/python3.7 myproject

Интерпретатор можно изменить глобально с помощью переменной env в ~/.bashrc:

$ export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3.7

Проверить версию Python и pip можно с помошью следующих команд:

$ python --version
$ pip --version

Работа с virtualenvwrapper

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

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

Установка virtualenvwrapper

Утилита virtualenvwrapper не поставляется вместе с virtualenv, поэтому для её установки на Linux необходимо выполнить следующие команды:

$ sudo pip3 install virtualenvwrapper
echo "export WORKON_HOME=$HOME/.virtualenvs" >> ~/.bashrc
echo "export PROJECT_HOME=$HOME/Devel" >> ~/.bashrc
echo "export VIRTUALENVWRAPPER_PYTHON='/usr/bin/python3'" >> ~/.bashrc
echo "source /usr/local/bin/virtualenvwrapper.sh" >> ~/.bashrc
source ~/.bashrc

Если Вы используете Windows, и у Вас правильно установлен Python и pip, то Вы можете установить virtualenvwrapper следующей командой:

pip install virtualenvwrapper-win

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

Важно: выполняйте следующую команду только в cmd! 

setx path "%path%;C:\Users\storm\AppData\Roaming\Python\Python39\Scripts"

Замените C:\Users\storm\AppData\Roaming\Python\Python39\Scripts на расположение, указанное в предупреждении.

Создание виртуальной среды

Начать использование virtualenvwrapper стоит с создания новой виртуальной среды. Сделать это можно следующим образом:

$ mkvirtualenv new-project

После создания виртуально среды, Вы автоматически окажетесь в ней:

created virtual environment CPython3.9.4.final.0-64 in 482ms
creator CPython3Posix(dest=/home/osboxes/.virtualenvs/new-project, clear=False, no_vcs_ignore=False, global=False)
seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/osboxes/.local/share/virtualenv)
added seed packages: pip==21.1.2, setuptools==57.0.0, wheel==0.36.2
activators BashActivator,CShellActivator,FishActivator,PowerShellActivator,PythonActivator,XonshActivator
virtualenvwrapper.user_scripts creating /home/osboxes/.virtualenvs/new-project/bin/predeactivate
virtualenvwrapper.user_scripts creating /home/osboxes/.virtualenvs/new-project/bin/postdeactivate
virtualenvwrapper.user_scripts creating /home/osboxes/.virtualenvs/new-project/bin/preactivate
virtualenvwrapper.user_scripts creating /home/osboxes/.virtualenvs/new-project/bin/postactivate
virtualenvwrapper.user_scripts creating /home/osboxes/.virtualenvs/new-project/bin/get_env_details

Просмотр всех созданных виртуальных сред

Просмотреть все созданные виртуальные среды можно так:

$ workon

Эта команда выведет список всех созданных через virtualenvwrapper виртуальных сред.

Переключение между виртуальными средами

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

$ workon new-project

Она переключит или включит выбранную Вами виртуальную среду.

Выход из виртуальной среды

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

$ deactivate

Копирование виртуальной среды

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

$ cpvirtualenv new-project new-project-copy
Copying new-project as new-project-copy...
$ workon
new-project
new-project-copy

Удаление виртуальной среды

Удалять виртуальные среды можно при помощи команды:

$ rmvirtualenv new-project-copy

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

$ deactivate
$ rmvirtualenv new-project-copy
Removing new-project-copy...
$ workon
new-project

Выводы

Вы познакомились с основами работы с виртуальными средами в Python. И теперь знаете про особенности установки и использования утилит venv, virtualenv и virtualenvwrapper в Python.

Спасибо за время, уделенное прочтению статьи!

Если возникли вопросы, задавайте их в комментариях.

Подписывайтесь на обновления нашего блога и оставайтесь в курсе новостей мира инфокоммуникаций!

Чтобы знать больше и выделяться знаниями среди толпы IT-шников, записывайтесь на курсы Cisco, курсы по кибербезопасности, полный курс по кибербезопасности, курсы DevNet / DevOps (программируемые системы) от Академии Cisco, курсы Linux от Linux Professional Institute на платформе SEDICOMM University (Университет СЭДИКОММ).