# 28.3. `venv`— Criação de ambientes virtuais

Novo na versão 3.3.

Código-fonte: Lib/venv/

O módulo `venv` provê suporte à criação se simples ^ambientes virtuais” com seus próprios siretórios sie, opcionalmente isolado dos diretórios site do sistema. Cada ambiente virtual tem seu próprio binário de Python (permitindo a criação de ambientes com várias versões de Python) e pode ter seu próprio conjnto indpendente de pacote Pythn instalados em seus diretóios site.

Veja PEP 405 para mais informações sonre Ambientes virtuais em Python.

Nota

The `pyvenv` script has been deprecated as of Python 3.6 in favor of using `python3 -m venv` to help prevent any potential confusion as to which Python interpreter a virtual environment will be based on.

## 28.3.1. Criando ambientes virtuais

A criação de ambientes virtuais é feita executando o comando `venv`:

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

Running this command creates the target directory (creating any parent directories that don’t exist already) and places a `pyvenv.cfg` file in it with a `home` key pointing to the Python installation from which the command was run. It also creates a `bin` (or `Scripts` on Windows) subdirectory containing a copy/symlink of the Python binary/binaries (as appropriate for the platform or arguments used at environment creation time). It also creates an (initially empty) `lib/pythonX.Y/site-packages` subdirectory (on Windows, this is `Lib\site-packages`). If an existing directory is specified, it will be re-used.

Obsoleto desde a versão 3.6: `pyvenv` era a ferramenta recomendada para criar ambientes virtuais para Python 3.3 e 3.4, e foi descontinuado no Python 3.6.

Alterado na versão 3.5: O uso de `venv` agora é recomendado para a criação de ambientes virtuais.

Ver também

Python Packaging User Guide: Creating and using virtual environments

No Windows, invoque o comando `venv` da seguinte forma:

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

Como alternativa, se você configurou as variáveis `PATH` e `PATHEXT` para a sua instalação do Python:

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

O comando, se executado com `-h`, mostrará as opções disponíveis:

    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.

Alterado na versão 3.4: Instala o pip por padrão, adicionadas as opções `--without-pip` e `--copies`.

Alterado na versão 3.4: Nas versões anteriores, se o diretório de destino já existia, era levantado um erro, a menos que a opção `--clear` ou `--upgrade` fosse fornecida.

O arquivo `pyvenv.cfg` criado também inclui a chave `include-system-site-packages`, definida como `true` se `venv` for executado com a opção `--system-site-packages`; caso contrário, `false`.

A menos que a opção `--without-pip` seja dada, `ensurepip` será chamado para inicializar o `pip` no ambiente virtual.

Vários caminhos podem ser dados para `venv`, caso em que um ambiente virtual idêntico será criado, de acordo com as opções fornecidas, em cada caminho fornecido.

Depois que um ambiente virtual é criado, ele pode ser “ativado” usando um script no diretório binário do ambiente virtual. A chamada do script é específica da plataforma (<venv> deve ser substituído pelo caminho do diretório que contém o ambiente virtual):

Plataforma | Shell | Comando para ativar o ambiente virtual
--- | --- | ---
Posix | bash/zsh | $ source <venv>/bin/activate
| fish | $ . <venv>/bin/activate.fish
| csh/tcsh | $ source <venv>/bin/activate.csh
Windows | cmd.exe | C:\> <venv>\Scripts\activate.bat
| PowerShell | PS C:\> <venv>\Scripts\Activate.ps1

Você não precisa especificamente ativar um ambiente; a ativação apenas anexa o diretório binário do ambiente virtual ao seu caminho, para que “python” invoque o interpretador Python do ambiente virtual e você possa executar scripts instalados sem precisar usar o caminho completo. No entanto, todos os scripts instalados em um ambiente virtual devem ser executáveis sem ativá-lo e executados com o Python do ambiente virtual automaticamente.

You can deactivate a virtual environment by typing “deactivate” in your shell. The exact mechanism is platform-specific: for example, the Bash activation script defines a “deactivate” function, whereas on Windows there are separate scripts called `deactivate.bat` and `Deactivate.ps1` which are installed when the virtual environment is created.

Novo na versão 3.4: Scripts de ativação de `fish` e `csh`.

Nota

Um ambiente virtual é um ambiente Python, de modo que o interpretador, as bibliotecas e os scripts instalados nele são isolados daqueles instalados em outros ambientes virtuais e (por padrão) quaisquer bibliotecas instaladas em um Python do “sistema”, ou seja, instalado como parte do seu sistema operacional.

Um ambiente virtual é uma árvore de diretórios que contém arquivos executáveis em Python e outros arquivos que indicam que é um ambiente virtual.

Common installation tools such as `Setuptools` and `pip` work as expected with virtual environments. In other words, when a virtual environment is active, they install Python packages into the virtual environment without needing to be told to do so explicitly.

Quando um ambiente virtual está ativo (ou seja, o interpretador Python do ambiente virtual está em execução), os atributos `sys.prefix` e `sys.exec_prefix` apontam para o diretório base do ambiente virtual, enquanto `sys.base_prefix` e `sys.base_exec_prefix` apontam para a instalação Python do ambiente não virtual que foi usada para criar o ambiente virtual. Se um ambiente virtual não estiver ativo, então `sys.prefix` é o mesmo que `sys.base_prefix` e `sys.exec_prefix` é o mesmo que `sys.base_exec_prefix` (todos eles apontam para uma instalação Python de ambiente não virtual).

When a virtual environment is active, any options that change the installation path will be ignored from all distutils configuration files to prevent projects being inadvertently installed outside of the virtual environment.

When working in a command shell, users can make a virtual environment active by running an `activate` script in the virtual environment’s executables directory (the precise filename is shell-dependent), which prepends the virtual environment’s directory for executables to the `PATH` environment variable for the running shell. There should be no need in other circumstances to activate a virtual environment—scripts installed into virtual environments have a “shebang” line which points to the virtual environment’s Python interpreter. This means that the script will run with that interpreter regardless of the value of `PATH`. On Windows, “shebang” line processing is supported if you have the Python Launcher for Windows installed (this was added to Python in 3.3 - see PEP 397 for more details). Thus, double-clicking an installed script in a Windows Explorer window should run the script with the correct interpreter without there needing to be any reference to its virtual environment in `PATH`.

## 28.3.2. API

O método de alto nível descrito acima utiliza uma API simples que fornece mecanismos para que criadores de ambientes virtuais de terceiros personalizem a criação do ambiente de acordo com suas necessidades, a classe `EnvBuilder`.

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

  A classe `EnvBuilder` aceita os seguintes argumentos nomeados na instanciação:

  - `system_site_packages` – um valor booleano indicando que os pacotes de sites do sistema Python devem estar disponíveis para o ambiente (o padrão é `False`).

  - `clear` – um valor booleano que, se verdadeiro, excluirá o conteúdo de qualquer diretório de destino existente, antes de criar o ambiente.

  - `symlinks` – a Boolean value indicating whether to attempt to symlink the Python binary (and any necessary DLLs or other binaries, e.g. `pythonw.exe`), rather than copying.

  - `upgrade` – um valor booleano que, se verdadeiro, atualizará um ambiente existente com o Python em execução - para uso quando o Python tiver sido atualizado no local (o padrão é `False`).

  - `with_pip` – um valor booleano que, se verdadeiro, garante que o pip seja instalado no ambiente virtual. Isso usa `ensurepip` com a opção `--default-pip`.

  - `prompt` – uma String a ser usada após o ambiente virtual ser ativado (o padrão é `None`, o que significa que o nome do diretório do ambiente seria usado).

  Alterado na versão 3.4: Adicionado o parâmetro `with_pip`

  Novo na versão 3.6: Adicionado o parâmetro `prompt`

  Creators of third-party virtual environment tools will be free to use the provided `EnvBuilder` class as a base class.

  O env-builder retornado é um objeto que possui um método, `create`:

  `create`(env_dir)

    This method takes as required argument the path (absolute or relative to the current directory) of the target directory which is to contain the virtual environment. The `create` method will either create the environment in the specified directory, or raise an appropriate exception.

    The `create` method of the `EnvBuilder` class illustrates the hooks available for subclass customization:

        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)

    Cada um dos métodos `ensure_directories()`, `create_configuration()`, `setup_python()`, `setup_scripts()` e `post_setup()` pode ser substituído.

  `ensure_directories`(env_dir)

    Cria o diretório do ambiente e todos os diretórios necessários e retorna um objeto de contexto. Este é apenas um suporte para atributos (como caminhos), para uso pelos outros métodos. Os diretórios já podem existir, desde que `clear` ou `upgrade` tenham sido especificados para permitir a operação em um diretório de ambiente existente.

  `create_configuration`(context)

    Cria o arquivo de configuração `pyvenv.cfg` no ambiente.

  `setup_python`(context)

    Creates a copy of the Python executable (and, under Windows, DLLs) in the environment. On a POSIX system, if a specific executable `python3.x` was used, symlinks to `python` and `python3` will be created pointing to that executable, unless files with those names already exist.

  `setup_scripts`(context)

    Instala scripts de ativação apropriados para a plataforma no ambiente virtual.

  `post_setup`(context)

    Um método de espaço reservado que pode ser substituído em implementações de terceiros para pré-instalar pacotes no ambiente virtual ou executar outras etapas pós-criação.

  Além disso, `EnvBuilder` fornece este método utilitário que pode ser chamado de `setup_scripts()` ou `post_setup()` nas subclasses para ajudar na instalação de scripts personalizados no ambiente virtual.

  `install_scripts`(context, path)

    path é o caminho para um diretório que deve conter subdiretórios “common”, “posix” e “nt”, cada um contendo scripts destinados ao diretório bin no ambiente. O conteúdo de “common” e o diretório correspondente a `os.name` são copiados após alguma substituição de texto dos espaços reservados:

    - `__VENV_DIR__` é substituído pelo caminho absoluto do diretório do ambiente.

    - `__VENV_NAME__` é substituído pelo nome do ambiente (segmento do caminho final do diretório do ambiente).

    - `__VENV_PROMPT__` é substituído pelo prompt (o nome do ambiente entre parênteses e com o seguinte espaço)

    - `__VENV_BIN_NAME__` é substituído pelo nome do diretório bin (`bin` ou `Scripts`).

    - `__VENV_PYTHON__` é substituído pelo caminho absoluto do executável do ambiente.

    É permitido que os diretórios existam (para quando um ambiente existente estiver sendo atualizado).

Há também uma função de conveniência no nível do módulo:

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

  Cria um `EnvBuilder` com os argumentos nomeados fornecidos e chame seu método `create()` com o argumento env_dir.

  Alterado na versão 3.4: Adicionado o parâmetro `with_pip`

## 28.3.3. Um exemplo de extensão de `EnvBuilder`

O script a seguir mostra como estender `EnvBuilder` implementando uma subclasse que instala setuptools e pip em um ambiente virtual criado:

    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)

This script is also available for download online.