Документация Python неофициальный перевод
Содержание страницы

26.9. venv – Создание виртуальных окруженийvenv – Creation of virtual environments

Новое в версии 3.3.

Исходный код: Lib/venv


Модуль venv предоставляет поддержку для создания легковесных «виртуальных окружений» с собственными каталогами site, которые могут быть изолированы от системных каталогов site. Каждое виртуальное окружение имеет собственный двоичный файл Python (что позволяет создавать окружения с разными версиями Python) и может иметь собственный независимый набор установленных пакетов Python в своих каталогах site.

За дополнительной информацией о виртуальных окружениях Python обращайтесь к PEP 405.

26.9.1. Создание виртуальных окруженийCreating virtual environments

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

pyvenv /path/to/new/virtual/environment

Выполнение этой команды создает целевой каталог (создавая все родительские каталоги, которых еще нет) и помещает в него файл pyvenv.cfg с ключом home, указывающим на установку Python, из которой была запущена команда. Она также создает подкаталог bin (или Scripts в Windows), содержащий копию двоичного файла python (или нескольких файлов в случае Windows). Также создается (изначально пустой) подкаталог lib/pythonX.Y/site-packages (в Windows это Lib\site-packages).

В Windows может потребоваться запускать скрипт pyvenv следующим образом, если не заданы соответствующие переменные PATH и PATHEXT:

c:\Temp>c:\Python33\python c:\Python33\Tools\Scripts\pyvenv.py myenv

или, что то же самое:

c:\Temp>c:\Python33\python -m venv myenv

Команда, запущенная с -h, покажет доступные параметры:

usage: pyvenv [-h] [--system-site-packages] [--symlinks] [--clear]
              [--upgrade] ENV_DIR [ENV_DIR ...]

Creates virtual Python environments in one or more target directories.

positional arguments:
  ENV_DIR             A directory to create the environment in.

optional arguments:
  -h, --help             show this help message and exit
  --system-site-packages Give access to the global site-packages dir to the
                         virtual environment.
  --symlinks             Try to use symlinks rather than copies, when symlinks
                         are not the default for the platform.
  --clear                Delete the environment directory if it already exists.
                         If not specified and the directory exists, an error is
                         raised.
  --upgrade              Upgrade the environment directory to use this version
                         of Python, assuming Python has been upgraded in-place.

Если целевой каталог уже существует, будет вызвано исключение, если только не указан параметр --clear или --upgrade.

Созданный файл pyvenv.cfg также содержит ключ include-system-site-packages, установленный в true, если venv был запущен с параметром --system-site-packages, и в false в противном случае.

Можно указать несколько путей для pyvenv; в этом случае идентичное виртуальное окружение будет создано в соответствии с заданными параметрами по каждому указанному пути.

После создания venv его можно «активировать» с помощью скрипта в каталоге bin виртуального окружения. Вызов скрипта зависит от платформы: на платформе Posix обычно используется:

$ source <venv>/bin/activate

тогда как в Windows обычно используется:

C:\> <venv>/Scripts/activate

если используется оболочка cmd.exe, или:

PS C:\> <venv>/Scripts/Activate.ps1

если используется PowerShell.

Строго говоря, нет необходимости активировать окружение; активация просто добавляет каталог с исполняемыми файлами venv в начало пути, так что «python» вызывает интерпретатор Python из venv, и можно запускать установленные скрипты без указания полного пути. Однако все скрипты, установленные в venv, должны быть работоспособны и без активации, и автоматически использовать Python из venv.

Деактивировать venv можно, набрав «deactivate» в оболочке. Точный механизм зависит от платформы: например, скрипт активации Bash определяет функцию «deactivate», тогда как в Windows есть отдельные скрипты deactivate.bat и Deactivate.ps1, которые устанавливаются при создании venv.

Примечание

Виртуальное окружение (также называемое venv) – это среда Python, в которой интерпретатор, библиотеки и скрипты, установленные в нее, изолированы от установленных в других виртуальных окружениях, а также (по умолчанию) от любых библиотек, установленных в «системном» Python, т.е. том, который установлен как часть вашей операционной системы.

Venv – это дерево каталогов, содержащее исполняемые файлы Python и другие файлы, указывающие на то, что это venv.

Обычные инструменты установки, такие как Setuptools и pip, работают с venvs как ожидается – т.е. когда venv активен, они устанавливают пакеты Python в venv без необходимости явного указания. Конечно, сначала нужно установить их в venv: это можно сделать, запустив ez_setup.py при активном venv, а затем запустив easy_install pip. В качестве альтернативы можно загрузить исходные архивы и после распаковки запустить python setup.py install при активном venv.

Когда venv активен (т.е. работает интерпретатор Python из этого venv), атрибуты sys.prefix и sys.exec_prefix указывают на базовый каталог venv, тогда как sys.base_prefix и sys.base_exec_prefix указывают на установку Python вне venv, которая использовалась для создания venv. Если venv не активен, то sys.prefix совпадает с sys.base_prefix, а sys.exec_prefix совпадает с sys.base_exec_prefix (все они указывают на установку Python вне venv).

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

При работе в командной оболочке пользователи могут активировать venv, запустив скрипт activate в каталоге исполняемых файлов venv (точное имя файла зависит от оболочки); этот скрипт добавляет каталог исполняемых файлов venv в начало переменной окружения PATH для текущей оболочки. В других случаях активировать venv не требуется – скрипты, установленные в venv, содержат строку shebang, указывающую на интерпретатор Python из этого venv. Это означает, что скрипт будет запущен с этим интерпретатором независимо от значения PATH. В Windows обработка строки shebang поддерживается, если установлен Python Launcher for Windows (это было добавлено в Python 3.3 – см. PEP 397 для подробностей). Таким образом, двойной щелчок по установленному скрипту в окне Проводника Windows должен запускать скрипт с правильным интерпретатором, без необходимости указывать на его venv в PATH.

26.9.2. API

Описанный выше высокоуровневый метод использует простой API, предоставляющий механизмы для создателей сторонних виртуальных окружений, чтобы настраивать создание окружений в соответствии с их потребностями, – класс EnvBuilder.

class venv.EnvBuilder(system_site_packages=False, clear=False, symlinks=False, upgrade=False)

Класс EnvBuilder принимает следующие именованные аргументы при создании экземпляра:

  • system_site_packages – логическое значение, указывающее, что системные пакеты site-packages Python должны быть доступны в окружении (по умолчанию False).
  • clear – логическое значение; если равно true, удаляет существующий целевой каталог вместо того, чтобы вызывать исключение (по умолчанию False).
  • symlinks – логическое значение, указывающее, следует ли пытаться создавать символические ссылки на исполняемый файл Python (и любые необходимые DLL или другие двоичные файлы, например pythonw.exe) вместо копирования. По умолчанию True в Linux и Unix-системах, и False в Windows.
  • upgrade – логическое значение, которое при значении true обновляет существующее окружение с помощью запущенного Python – для случаев, когда этот Python был обновлён на месте (по умолчанию False).

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

Возвращаемый построитель окружения (env-builder) – это объект, имеющий метод create:

create(env_dir)

Этот метод принимает в качестве обязательного аргумента путь (абсолютный или относительный к текущей директории) к целевой директории, в которой должно быть создано виртуальное окружение. Метод create либо создаст окружение в указанной директории, либо возбудит соответствующее исключение.

Метод create класса EnvBuilder иллюстрирует точки расширения (hooks), доступные для настройки в подклассах:

def create(self, env_dir):
    """
    Создаёт виртуализированное окружение Python в указанном каталоге.
    Параметр env_dir – это целевой каталог, в котором создаётся окружение.
    """
    env_dir = os.path.abspath(env_dir)
    context = self.ensure_directories(env_dir)
    self.create_configuration(context)
    self.setup_python(context)
    self.setup_scripts(context)
    self.post_setup(context)

Каждый из методов ensure_directories(), create_configuration(), setup_python(), setup_scripts() и post_setup() может быть переопределён.

ensure_directories(env_dir)

Создаёт директорию окружения и все необходимые каталоги, и возвращает объект контекста. Это просто контейнер для атрибутов (таких как пути), используемый другими методами. Директории могут уже существовать, если были указаны clear или upgrade, чтобы разрешить работу с существующей директорией окружения.

create_configuration(context)

Создаёт конфигурационный файл pyvenv.cfg в окружении.

setup_python(context)

Создаёт копию исполняемого файла Python (и, в Windows, DLL) в окружении. В POSIX-системе, если использовался конкретный исполняемый файл python3.x, будут созданы символические ссылки на python и python3, указывающие на этот исполняемый файл, если файлы с такими именами уже не существуют.

setup_scripts(context)

Устанавливает скрипты активации, соответствующие платформе, в виртуальное окружение.

post_setup(context)

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

Кроме того, EnvBuilder предоставляет вспомогательный метод, который можно вызывать из setup_scripts() или post_setup() в подклассах для помощи в установке пользовательских скриптов в виртуальное окружение.

install_scripts(context, path)

path – это путь к директории, которая должна содержать подкаталоги «common», «posix», «nt», каждый из которых содержит скрипты, предназначенные для каталога bin в окружении. Содержимое «common» и каталога, соответствующего os.name, копируется после замены некоторых плейсхолдеров в тексте:

  • __VENV_DIR__ заменяется на абсолютный путь к директории окружения.
  • __VENV_NAME__ заменяется на имя окружения (последний сегмент пути директории окружения).
  • __VENV_BIN_NAME__ заменяется на имя каталога bin (либо bin, либо Scripts).
  • __VENV_PYTHON__ заменяется на абсолютный путь к исполняемому файлу окружения.

Каталоги могут существовать (на случай, когда обновляется существующее окружение).

Также существует удобная функция уровня модуля:

venv.create(env_dir, system_site_packages=False, clear=False, symlinks=False)

Создаёт EnvBuilder с заданными именованными аргументами и вызывает его create() метод с аргументом env_dir.

26.9.3. Пример расширения EnvBuilderAn example of extending EnvBuilder

Следующий скрипт показывает, как расширить EnvBuilder, реализовав подкласс, который устанавливает setuptools и pip в созданную виртуальную среду venv:

import os
import os.path
from subprocess import Popen, PIPE
import sys
from threading import Thread
from urllib.parse import urlparse
from urllib.request import urlretrieve
import venv

class ExtendedEnvBuilder(venv.EnvBuilder):
    """
    This builder installs setuptools and pip so that you can pip or
    easy_install other packages into the created environment.

    :param nodist: If True, setuptools and pip are not installed into the
                   created environment.
    :param nopip: If True, pip is not installed into the created
                  environment.
    :param progress: If setuptools or pip are installed, the progress of the
                     installation can be monitored by passing a progress
                     callable. If specified, it is called with two
                     arguments: a string indicating some progress, and a
                     context indicating where the string is coming from.
                     The context argument can have one of three values:
                     'main', indicating that it is called from virtualize()
                     itself, and 'stdout' and 'stderr', which are obtained
                     by reading lines from the output streams of a subprocess
                     which is used to install the app.

                     If a callable is not specified, default progress
                     information is output to sys.stderr.
    """

    def __init__(self, *args, **kwargs):
        self.nodist = kwargs.pop('nodist', False)
        self.nopip = kwargs.pop('nopip', False)
        self.progress = kwargs.pop('progress', None)
        self.verbose = kwargs.pop('verbose', False)
        super().__init__(*args, **kwargs)

    def post_setup(self, context):
        """
        Set up any packages which need to be pre-installed into the
        environment being created.

        :param context: The information for the environment creation request
                        being processed.
        """
        os.environ['VIRTUAL_ENV'] = context.env_dir
        if not self.nodist:
            self.install_setuptools(context)
        # Can't install pip without setuptools
        if not self.nopip and not self.nodist:
            self.install_pip(context)

    def reader(self, stream, context):
        """
        Read lines from a subprocess' output stream and either pass to a progress
        callable (if specified) or write progress information to sys.stderr.
        """
        progress = self.progress
        while True:
            s = stream.readline()
            if not s:
                break
            if progress is not None:
                progress(s, context)
            else:
                if not self.verbose:
                    sys.stderr.write('.')
                else:
                    sys.stderr.write(s.decode('utf-8'))
                sys.stderr.flush()
        stream.close()

    def install_script(self, context, name, url):
        _, _, path, _, _, _ = urlparse(url)
        fn = os.path.split(path)[-1]
        binpath = context.bin_path
        distpath = os.path.join(binpath, fn)
        # Download script into the env's binaries folder
        urlretrieve(url, distpath)
        progress = self.progress
        if self.verbose:
            term = '\n'
        else:
            term = ''
        if progress is not None:
            progress('Installing %s ...%s' % (name, term), 'main')
        else:
            sys.stderr.write('Installing %s ...%s' % (name, term))
            sys.stderr.flush()
        # Install in the env
        args = [context.env_exe, fn]
        p = Popen(args, stdout=PIPE, stderr=PIPE, cwd=binpath)
        t1 = Thread(target=self.reader, args=(p.stdout, 'stdout'))
        t1.start()
        t2 = Thread(target=self.reader, args=(p.stderr, 'stderr'))
        t2.start()
        p.wait()
        t1.join()
        t2.join()
        if progress is not None:
            progress('done.', 'main')
        else:
            sys.stderr.write('done.\n')
        # Clean up - no longer needed
        os.unlink(distpath)

    def install_setuptools(self, context):
        """
        Install setuptools in the environment.

        :param context: The information for the environment creation request
                        being processed.
        """
        url = 'https://bitbucket.org/pypa/setuptools/downloads/ez_setup.py'
        self.install_script(context, 'setuptools', url)
        # clear up the setuptools archive which gets downloaded
        pred = lambda o: o.startswith('setuptools-') and o.endswith('.tar.gz')
        files = filter(pred, os.listdir(context.bin_path))
        for f in files:
            f = os.path.join(context.bin_path, f)
            os.unlink(f)

    def install_pip(self, context):
        """
        Install pip in the environment.

        :param context: The information for the environment creation request
                        being processed.
        """
        url = 'https://raw.github.com/pypa/pip/master/contrib/get-pip.py'
        self.install_script(context, 'pip', url)

def main(args=None):
    compatible = True
    if sys.version_info < (3, 3):
        compatible = False
    elif not hasattr(sys, 'base_prefix'):
        compatible = False
    if not compatible:
        raise ValueError('This script is only for use with '
                         'Python 3.3 or later')
    else:
        import argparse

        parser = argparse.ArgumentParser(prog=__name__,
                                         description='Creates virtual Python '
                                                     'environments in one or '
                                                     'more target '
                                                     'directories.')
        parser.add_argument('dirs', metavar='ENV_DIR', nargs='+',
                            help='A directory to create the environment in.')
        parser.add_argument('--no-setuptools', default=False,
                            action='store_true', dest='nodist',
                            help="Don't install setuptools or pip in the "
                                 "virtual environment.")
        parser.add_argument('--no-pip', default=False,
                            action='store_true', dest='nopip',
                            help="Don't install pip in the virtual "
                                 "environment.")
        parser.add_argument('--system-site-packages', default=False,
                            action='store_true', dest='system_site',
                            help='Give the virtual environment access to the '
                                 'system site-packages dir.')
        if os.name == 'nt':
            use_symlinks = False
        else:
            use_symlinks = True
        parser.add_argument('--symlinks', default=use_symlinks,
                            action='store_true', dest='symlinks',
                            help='Try to use symlinks rather than copies, '
                                 'when symlinks are not the default for '
                                 'the platform.')
        parser.add_argument('--clear', default=False, action='store_true',
                            dest='clear', help='Delete the contents of the '
                                               'environment directory if it '
                                               'already exists, before '
                                               'environment creation.')
        parser.add_argument('--upgrade', default=False, action='store_true',
                            dest='upgrade', help='Upgrade the environment '
                                               'directory to use this version '
                                               'of Python, assuming Python '
                                               'has been upgraded in-place.')
        parser.add_argument('--verbose', default=False, action='store_true',
                            dest='verbose', help='Display the output '
                                               'from the scripts which '
                                               'install setuptools and pip.')
        options = parser.parse_args(args)
        if options.upgrade and options.clear:
            raise ValueError('you cannot supply --upgrade and --clear together.')
        builder = ExtendedEnvBuilder(system_site_packages=options.system_site,
                                       clear=options.clear,
                                       symlinks=options.symlinks,
                                       upgrade=options.upgrade,
                                       nodist=options.nodist,
                                       nopip=options.nopip,
                                       verbose=options.verbose)
        for d in options.dirs:
            builder.create(d)

if __name__ == '__main__':
    rc = 1
    try:
        main()
        rc = 0
    except Exception as e:
        print('Error: %s' % e, file=sys.stderr)
    sys.exit(rc)

Этот скрипт также доступен для загрузки онлайн.