"venv" --- Creación de entornos virtuales
*****************************************

Nuevo en la versión 3.3.

**Código fuente:** Lib/venv/

======================================================================

El módulo "venv" proporciona soporte para crear "entornos virtuales"
ligeros con sus propios directorios de ubicación, aislados
opcionalmente de los directorios de ubicación del sistema. Cada
entorno virtual tiene su propio binario Python (que coincide con la
versión del binario que se utilizó para crear este entorno) y puede
tener su propio conjunto independiente de paquetes Python instalados
en sus directorios de ubicación.

Ver **PEP 405** para más información sobre los entornos virtuales de
Python.

Ver también:

  Python Packaging User Guide: Creating and using virtual environments


Creación de entornos virtuales
==============================

La creación de entornos virtuales se hace ejecutando el comando
"venv":

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

Al ejecutar este comando se crea el directorio de destino (creando
cualquier directorio padre que todavía no exista) y coloca un archivo
"pyvenv.cfg" en él con una clave "home" apuntando a la instalación
Python desde la que el comando se lanzó (un nombre común para el
directorio destino es ".venv"). También crea un subdirectorio "bin" (o
"Scripts" en Windows) conteniendo una copia/enlace simbólico del
binario/s Python (según lo apropiado para la plataforma o los
argumentos usados en el momento de la creación del entorno). También
crea un directorio (inicialmente vacío) "lib/pythonX.Y/site-packages"
(en Windows, este es "Lib\site-packages"). Si se especifica un
directorio existente, será reutilizado.

Obsoleto desde la versión 3.6: "pyvenv" fue la herramienta recomendada
para la creación de entornos virtuales en Python 3.3 y 3.4, y es
obsoleta para Python 3.6.

Distinto en la versión 3.5: Ahora se recomienda el uso de "venv" para
crear entornos virtuales.

En Windows, invoca el comando "venv" de la siguiente manera:

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

Como alternativa, si configuraste las variables "PATH" y "PATHEXT"
para tu instalación de Python:

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

El comando, si se ejecuta con "-h", mostrará las opciones disponibles:

   usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
               [--upgrade] [--without-pip] [--prompt PROMPT]
               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)
     --prompt PROMPT       Provides an alternative prompt prefix for this
                           environment.

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

Distinto en la versión 3.4: Instala pip por defecto, añadidas las
opciones "--without-pip"  y "--copies"

Distinto en la versión 3.4: En versiones anteriores, si el directorio
objetivo ya existía, se producía un error, a menos que se incluyera la
opción "--clear" or "--upgrade".

Nota:

  Aunque los enlaces simbólicos están soportados en Windows, no se
  recomiendan. Cabe destacar que al hacer doble clic en "python.exe"
  en el Explorador de Archivos, el enlace simbólico se resolverá con
  rapidez e ignorará el entorno virtual.

Nota:

  En Microsoft Windows, puede ser necesario habilitar el *script*
  "Activate.ps1" estableciendo la política de ejecución para el
  usuario. Puedes hacer esto ejecutando el siguiente comando de
  PowerShell:PS C:> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned
  -Scope CurrentUserSee About Execution Policies for more information.

El archivo creado "pyvenv.cfg" también incluye la clave "include-
system-site-packages", fijada a "true" si "venv" se ejecuta con la
opción "--system-site-packages", "false" en caso contrario.

A menos que se use la opción "--without-pip", se invocará "ensurepip"
para arrancar "pip" en el entorno virtual.

Se pueden dar múltiples rutas a "venv", en cuyo caso se creará un
entorno virtual idéntico, de acuerdo a las opciones dadas, en cada
ruta proporcionada.

Una vez que se ha creado un entorno virtual, puede ser "activado"
usando un *script* en el directorio binario del entorno virtual. La
ejecución del *script* es específica de la plataforma (*<venv>* debe
ser reemplazado por la ruta del directorio que contiene el entorno
virtual):

+---------------+-------------------+-------------------------------------------+
| Plataforma    | Consola           | Comando para activar el entorno virtual   |
|===============|===================|===========================================|
| POSIX         | bash/zsh          | $ source <venv>/bin/activate              |
+---------------+-------------------+-------------------------------------------+
|               | fish              | $ . <venv>/bin/activate.fish              |
+---------------+-------------------+-------------------------------------------+
|               | csh/tcsh          | $ source <venv>/bin/activate.csh          |
+---------------+-------------------+-------------------------------------------+
|               | PowerShell Core   | $ <venv>/bin/Activate.ps1                 |
+---------------+-------------------+-------------------------------------------+
| Windows       | cmd.exe           | C:\> <venv>\Scripts\activate.bat          |
+---------------+-------------------+-------------------------------------------+
|               | PowerShell        | PS C:\> <venv>\Scripts\Activate.ps1       |
+---------------+-------------------+-------------------------------------------+

When a virtual environment is active, the "VIRTUAL_ENV" environment
variable is set to the path of the virtual environment. This can be
used to check if one is running inside a virtual environment.

No es *necesario* activar un entorno específicamente; la activación
sólo prepara el directorio binario del entorno virtual para tu ruta,
de modo que "python" invoque el intérprete de Python del entorno
virtual y puedas ejecutar los *scripts* instalados sin tener que usar
su ruta completa. Sin embargo, todos los *scripts* instalados en un
entorno virtual deberían ser ejecutables sin activarlo, y ejecutarse
con el Python del entorno virtual automáticamente.

Puedes desactivar un entorno virtual tecleando "*deactivate*" en tu
consola. El mecanismo exacto es específico de la plataforma y es un
detalle de implementación interna (típicamente se usará un *script* o
una función de la consola).

Nuevo en la versión 3.4: "fish" y "csh" *scripts* de activación.

Nuevo en la versión 3.8: *scripts* de activación PowerShell instalados
bajo POSIX para el soporte del PowerShell Core.

Nota:

  Un entorno virtual es un entorno Python en el que el intérprete
  Python, las bibliotecas y los *scripts* instalados en él están
  aislados de los instalados en otros entornos virtuales, y (por
  defecto) cualquier biblioteca instalada en un "sistema" Python, es
  decir, uno que esté instalado como parte de tu sistema operativo.Un
  entorno virtual es un árbol de directorios que contiene archivos
  ejecutables de Python y otros archivos que indican que es un entorno
  virtual.Las herramientas de instalación habituales como setuptools y
  pip funcionan como se espera con entornos virtuales. En otras
  palabras, cuando un entorno virtual está activo, instalan los
  paquetes Python en el entorno virtual sin necesidad de que se les
  diga explícitamente que lo hagan.Cuando un entorno virtual está
  activo (es decir, el intérprete de Python del entorno virtual se
  está ejecutando), los atributos "sys.prefix" y "sys.exec_prefix"
  apuntan al directorio base del entorno virtual, mientras que
  "sys.base_prefix" y "sys.base_exec_prefix" apuntan a la instalación
  Python del entorno no virtual que se utilizó para crear el entorno
  virtual. Si un entorno virtual no está activo, entonces "sys.prefix"
  es lo mismo que "sys.base_prefix" y "sys.exec_prefix" es lo mismo
  que "sys.base_exec_prefix" (todos ellos apuntan a una instalación
  Python de entorno no virtual).Cuando un entorno virtual está activo,
  cualquier opción que cambie la ruta de instalación será ignorada de
  todos los archivos de configuración de "distutils" para evitar que
  los proyectos se instalen inadvertidamente fuera del entorno
  virtual.Cuando se trabaja en una consola, las/los usuarias/os pueden
  hacer que un entorno virtual se active ejecutando un *script*
  "activate" en el directorio de ejecutables del entorno virtual (el
  nombre preciso del archivo y el comando para utilizarlo dependen del
  entorno de consola), que envía previamente el directorio de
  ejecutables del entorno virtual a la variable de entorno "PATH" para
  la consola en ejecución. En otras circunstancias no debería ser
  necesario activar un entorno virtual; los *scripts* instalados en
  entornos virtuales tienen una línea "*shebang*" que apunta al
  intérprete Python del entorno virtual. Esto significa que el
  *script* se ejecutará con ese intérprete sin importar el valor de
  "PATH". En Windows, el procesamiento de la línea "*shebang*" está
  soportado si tienes instalado el Python *Launcher* para Windows
  (este fue añadido a Python en 3.3 - ver **PEP 397** para más
  detalles). Por lo tanto, al hacer doble clic en un *script*
  instalado en una ventana del Explorador de Windows se debería
  ejecutar el *script* con el intérprete correcto sin necesidad de que
  haya ninguna referencia a su entorno virtual en "PATH".


API
===

El método de alto nivel descrito anteriormente utiliza una sencilla
API que proporciona mecanismos para que les creadores de entornos
virtuales de terceras/os puedan personalizar la creación de entornos
según sus necesidades, la clase "EnvBuilder".

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

   La clase "EnvBuilder" acepta los siguientes argumentos de palabras
   clave en la instanciación:

   * "system_site_packages" -- un valor booleano que indica que los
     *site-packages* del sistema Python deben estar disponibles para
     el entorno (por defecto es "False").

   * "clear" -- un valor booleano que, si es verdadero, borrará el
     contenido de cualquier directorio de destino existente, antes de
     crear el entorno.

   * "symlinks" -- un valor booleano que indica si se debe intentar
     crear un enlace simbólico del binario de Python en lugar de
     copiarlo.

   * "upgrade" -- un valor booleano que, si es verdadero, actualizará
     un entorno existente con el Python en ejecución -- para ser usado
     cuando ese Python haya sido actualizado in situ (por defecto es
     "False").

   * "with_pip" -- un valor booleano que, si es verdadero, asegura que
     pip está instalado en el entorno virtual. Esto usa "ensurepip"
     con la opción "--default-pip".

   * "prompt" -- una cadena que se usará después de que se active el
     entorno virtual (por defecto es "None" lo que significa que se
     usará el nombre de directorio del entorno).

   Distinto en la versión 3.4: Añadido el parámetro "with_pip"

   Nuevo en la versión 3.6: Añadido el parámetro "prompt"

   Las/Los creadoras/es de herramientas de entorno virtual de
   terceros/as serán libres de usar la clase "EnvBuilder"
   proporcionada como clase base.

   El *env-builder* retornado es un objeto que tiene un método,
   "create":

   create(env_dir)

      Crear un entorno virtual especificando el directorio de destino
      (de forma absoluta o relativa al directorio actual) que ha de
      contener el entorno virtual. El método "create" creará el
      entorno en el directorio especificado, o lanzará la
      correspondiente excepción.

      El método "create" de la clase "EnvBuilder" ilustra los enlaces
      disponibles para la personalización de la subclase:

         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 uno de los métodos "ensure_directories()",
      "create_configuration()", "setup_python()", "setup_scripts()" y
      "post_setup()" pueden ser anulados.

   ensure_directories(env_dir)

      Crea el directorio del entorno y todos los directorios
      necesarios, y retorna un objeto de contexto. Esto es sólo un
      soporte para atributos (como rutas), para ser usado por los
      otros métodos. Se permite que los directorios ya existan,
      siempre y cuando se haya especificado "clear" o "upgrade" para
      permitir operar en un directorio de entorno existente.

   create_configuration(context)

      Crea el archivo de configuración "pyvenv.cfg" en el entorno.

   setup_python(context)

      Crea una copia o enlace simbólico al ejecutable Python en el
      entorno. En los sistemas POSIX, si se usó un ejecutable
      específico "python3.x", se crearán enlaces simbólicos a "python"
      y "python3" apuntando a ese ejecutable, a menos que ya existan
      archivos con esos nombres.

   setup_scripts(context)

      Instala los *scripts* de activación apropiados para la
      plataforma en el entorno virtual.

   post_setup(context)

      Un método de marcador de posición que puede ser anulado en
      implementaciones de terceros/as para previo instalar paquetes en
      el entorno virtual o realizar otros pasos posteriores a la
      creación.

   Distinto en la versión 3.7.2: Windows ahora usa *scripts* de
   redireccionamiento para "python[w].exe" en lugar de copiar los
   propios binarios. Para 3.7.2 solamente "setup_python()" no hace
   nada a menos que se ejecute desde una compilación en el árbol de
   directorios fuente.

   Distinto en la versión 3.7.3: Windows copia los *scripts* de
   redireccionamiento como parte de "setup_python()" en lugar de
   "setup_scripts()". Este no era el caso para 3.7.2. Cuando se usan
   enlaces simbólicos, los ejecutables originales se enlazan.

   Además, "EnvBuilder" proporciona este método de utilidad que puede
   ser llamado desde "setup_scripts()" o "post_setup()" en subclases
   para ayudar a instalar *scripts* personalizados en el entorno
   virtual.

   install_scripts(context, path)

      *path* es la ruta a un directorio que debería contener los
      subdirectorios "*common*", "*posix*", "*nt*", cada uno de los
      cuales contiene *scripts* destinados al directorio *bin* del
      entorno. El contenido de "*common*" y el directorio
      correspondiente a "os.name" se copian después de algún reemplazo
      de texto de los marcadores de posición:

      * "__VENV_DIR__" se sustituye por la ruta absoluta del
        directorio del entorno.

      * "__VENV_NAME__" se sustituye por el nombre del entorno (parte
        final de la ruta del directorio del entorno).

      * "__VENV_PROMPT__" se sustituye por el *prompt* (el nombre del
        entorno entre paréntesis y con un espacio posterior)

      * "__VENV_BIN_NAME__" se sustituye con el nombre del directorio
        *bin* (ya sea "bin" o "Scripts").

      * "__VENV_PYTHON__" se sustituye con la ruta absoluta del
        ejecutable del entorno.

      Se permite la existencia de los directorios (para cuando se está
      actualizando un entorno existente).

También hay una función de conveniencia a nivel de módulo:

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

   Crea un "EnvBuilder" con los argumentos de la palabra clave dada, y
   llama a su método "create()" con el argumento *env_dir*.

   Nuevo en la versión 3.3.

   Distinto en la versión 3.4: Añadido el parámetro "with_pip"

   Distinto en la versión 3.6: Añadido el parámetro "prompt"


Un ejemplo de la extensión de "EnvBuilder"
==========================================

El siguiente *script* muestra como extender "EnvBuilder" implementando
una subclase que instala setuptools y pip en un entorno virtual
creado:

   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://bootstrap.pypa.io/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)

Este *script* está también disponible para su descarga online.
