Что такое virtualenv в Python и как его использовать

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

Virtualenv (виртуальная среда) — это инструмент Python для управления зависимостями и изоляции проектов. Он позволяет устанавливать пакеты pip (сторонние библиотеки) локально в изолированном каталоге для конкретного проекта, а не глобально (этих пакетов не будет в других проектах Python).

Перед началом работы у вас должен быть установлен Python 3 и pip.

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

Содержание:

1. Создание проекта
2. Создание виртуальной среды
3. Активация виртуальной среды
4. Использование virtualenv
5. Установка virtualenvwrapper
6. Использование virtualenvwrapper
7. Выводы

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

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

mkdir my_python_project
cd my_python_project

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

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

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

python3 -m venv project_name_venv

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

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

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_venv/bin/python3', '-Im', 'ensurepip', '--upgrade', '--default-pip']

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

sudo apt-get install python3-venv -y

После повторите команду создания виртуальной среды Python

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

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

source project_name_venv/bin/activate

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

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

project_name_venv/Scripts/activate

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

Использование virtualenv

Теперь мы находимся внутри виртуальной cреды Python.

Давайте проверим установленные пакеты 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, в котором будет находится список всех установленных пакетов.

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

pip3 install -r requirements.txt

Установка virtualenvwrapper

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

Самый простой способ управлять virtualenv — установить virtualenvwrapper. Эта утилита помогает удобно управлять виртуальными средами virtualenv.

Для установки virtualenvwrapper на 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

Используя 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
(new-project) yurii@Sedicomm:~$

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

workon

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

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

workon new-project

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

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

deactivate

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

cpvirtualenv new-project new-project-copy

Copying new-project as new-project-copy...
(new-project-copy) yurii@Sedicomm:~$ workon
new-project
new-project-copy

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

rmvirtualenv new-project-copy

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

(new-project-copy) yurii@Sedicomm:~$ deactivate
yurii@Sedicomm:~$ rmvirtualenv new-project-copy
Removing new-project-copy...
yurii@Sedicomm:~$ workon
new-project

Выводы

На этом все, теперь вы можете как создавать, так и дублировать виртуальные среды Virtualenv в Python.

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

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

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

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