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

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

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

См. PEP 405 для получения дополнительной информации о виртуальных средах Python.

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

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

python3 -m venv /path/to/new/virtual/environment

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

В Windows вызывайте команду venv следующим образом:

c:\>c:\Python35\python -m venv c:\path\to\myenv

В качестве альтернативы, если вы настроили переменные PATH и PATHEXT для вашей установки Python:

c:\>python -m venv c:\path\to\myenv

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

usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
            [--upgrade] [--without-pip]
            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 the virtual environment access to the system
                        site-packages dir.
  --symlinks            Try to use symlinks rather than copies, when symlinks
                        are not the default for the platform.
  --copies              Try to use copies rather than symlinks, even when
                        symlinks are the default for the platform.
  --clear               Delete the contents of the environment directory if it
                        already exists, before environment creation.
  --upgrade             Upgrade the environment directory to use this version
                        of Python, assuming Python has been upgraded in-place.
  --without-pip         Skips installing or upgrading pip in the virtual
                        environment (pip is bootstrapped by default)

Once an environment has been created, you may wish to activate it, e.g. by
sourcing an activate script in its bin directory.

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

Если не указан параметр --without-pip, ensurepip будет вызван для подготовки pip в виртуальной среде.

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

После создания виртуальной среды её можно «активировать», используя скрипт в каталоге бинарных файлов виртуальной среды. Вызов скрипта зависит от платформы (<venv> должен быть заменён путём к каталогу, содержащему виртуальную среду):

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

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

28.3.2. API

Вышеописанный высокоуровневый метод использует простой API, который предоставляет механизмы для сторонних создателей виртуальных сред для настройки создания среды в соответствии с их потребностями, класс EnvBuilder.

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

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

• system_site_packages – логическое значение, указывающее, что системные пакеты Python site-packages должны быть доступны в среде (по умолчанию False).
• clear – логическое значение, которое, если истинно, удалит содержимое любой существующей целевой директории перед созданием среды.
• symlinks – логическое значение, указывающее, следует ли использовать символические ссылки на двоичный файл Python (и все необходимые DLL или другие двоичные файлы, например, pythonw.exe), а не копировать.
• upgrade – логическое значение, которое, если истинно, обновит существующую среду с помощью работающего Python - для использования в случае, если этот Python был обновлён на месте (по умолчанию False).
• with_pip – логическое значение, которое, если истинно, гарантирует установку pip в виртуальной среде. Для этого используется ensurepip с параметром --default-pip.
• prompt – строка, используемая после активации виртуальной среды (по умолчанию None, что означает, что будет использовано имя каталога среды).

Изменено в версии 3.4: Добавлен параметр with_pip

Введено в версии 3.6: Добавлен параметр prompt

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

Возвращаемый объект env-builder имеет метод create:

create(env_dir)

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

Метод create класса EnvBuilder демонстрирует доступные для настройки подклассов хуки:

def create(self, env_dir):
    """
    Create a virtualized Python environment in a directory.
    env_dir is the target directory to create an environment in.
    """
    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_PROMPT__ заменяется приглашением (имя среды в скобках с последующим пробелом)
• __VENV_BIN_NAME__ заменяется именем директории bin (либо bin либо Scripts).
• __VENV_PYTHON__ заменяется абсолютным путём к исполняемому файлу среды.

Директории могут уже существовать (при обновлении существующей среды).

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

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

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

Изменено в версии 3.4: Добавлен параметр with_pip

28.3.3. Пример расширения EnvBuilder

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

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 virtual environment.

    :param nodist: If True, setuptools and pip are not installed into the
                   created virtual environment.
    :param nopip: If True, pip is not installed into the created
                  virtual 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
        virtual environment being created.

        :param context: The information for the virtual 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 virtual environment'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 virtual environment
        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 virtual environment.

        :param context: The information for the virtual 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 virtual environment.

        :param context: The information for the virtual 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 in which to create the
                                 'virtual environment.')
        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 '
                                               'virtual environment '
                                               'directory if it already '
                                               'exists, before virtual '
                                               'environment creation.')
        parser.add_argument('--upgrade', default=False, action='store_true',
                            dest='upgrade', help='Upgrade the virtual '
                                                 '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)

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

© 2001–2020 Python Software Foundation
Licensed under the PSF License.
https://docs.python.org/3.6/library/venv.html

END_OF_DOCUMENT_MARKER