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

Nuevo en la versión 3.3.

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

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

The "venv" module supports creating lightweight "virtual
environments", each with their own independent set of Python packages
installed in their "site" directories. A virtual environment is
created on top of an existing Python installation, known as the
virtual environment's "base" Python, and may optionally be isolated
from the packages in the base environment, so only those explicitly
installed in the virtual environment are available.

When used from within a virtual environment, common installation tools
such as pip will install Python packages into a virtual environment
without needing to be told to do so explicitly.

See **PEP 405** for more background on Python virtual environments.

Ver también:

  Guía del usuario de la Paquetería Python: Creación y uso de entornos
  virtuales


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

La creación de entornos virtuales se realiza al ejecutar el comando
"venv":

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

Al ejecutar este comando crea el directorio de destino (la creación de
los directorios principales que aún no existen) y coloca un archivo
"pyvenv.cfg" en él con una clave "home" que apunta a la instalación de
Python desde la cual se ejecutó el comando (un nombre común para el
directorio de destino es ".venv"). También crea un subdirectorio "bin"
(o "Scripts" en Windows) que contiene una copia / enlace simbólico de
los binarios Python (según sea apropiado para la plataforma o los
argumentos que se usaron en el momento de la creación del entorno).
También crea un subdirectorio (inicialmente vacío) "lib/pythonX.Y
/site-packages" ("Lib\site-packages" en Windows). Si se especifica un
directorio existente, se reutilizará.

Obsoleto desde la versión 3.6: "pyvenv" was the recommended tool for
creating virtual environments for Python 3.3 and 3.4, and is
deprecated in Python 3.6.

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

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

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

Alternativamente, si configuró las variables "PATH" y "PATHEXT" para
su instalación 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] [--upgrade-deps]
               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.
     --upgrade-deps        Upgrade core dependencies: pip setuptools to the
                           latest version in PyPI

   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.9: Agrega la opción "--upgrade-deps" para
actualizar pip + setuptools a la última versión en PyPI

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

Distinto en la versión 3.4: En versiones anteriores, si el directorio
de destino ya existía, se lanzaba un error, a menos que se
proporcionara la opción "--clear" o "--upgrade".

Nota:

  Aunque los enlaces simbólicos son compatibles en Windows, no se
  recomiendan. Es de interés particular que al hacer doble clic en
  "python.exe" en el explorador de archivos, el enlace simbólico se
  resolverá e ignorará el entorno virtual.

Nota:

  En Microsoft Windows puede ser necesario habilitar el script
  "Activate.ps1" estableciendo la directiva de ejecución para el
  usuario. Puede hacer esto escribiendo el siguiente comando de
  PowerShell:PS C:> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned
  -Scope CurrentUserVer Acerca de las directivas de ejecución para más
  información.

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

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

Se pueden asignar 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.


How venvs work
==============

When a Python interpreter is running from a virtual environment,
"sys.prefix" and "sys.exec_prefix" point to the directories of the
virtual environment, whereas "sys.base_prefix" and
"sys.base_exec_prefix" point to those of the base Python used to
create the environment. It is sufficient to check "sys.prefix ==
sys.base_prefix" to determine if the current interpreter is running
from a virtual environment.

A virtual environment may be "activated" using a script in its binary
directory ("bin" on POSIX; "Scripts" on Windows). This will prepend
that directory to your "PATH", so that running **python** will invoke
the environment's Python interpreter and you can run installed scripts
without having to use their full path. The invocation of the
activation script is platform-specific ("*<venv>*" must be replaced by
the path to the directory containing the virtual environment):

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

Nuevo en la versión 3.4: **fish** and **csh** activation scripts.

Nuevo en la versión 3.8: Scripts de activación de PowerShell
instalados en POSIX para compatibilidad con PowerShell Core.

You don't specifically *need* to activate a virtual environment, as
you can just specify the full path to that environment's Python
interpreter when invoking Python. Furthermore, all scripts installed
in the environment should be runnable without activating it.

In order to achieve this, scripts installed into virtual environments
have a "shebang" line which points to the environment's Python
interpreter, i.e. "#!/*<path-to-venv>*/bin/python". 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 Lanzador de Python para Windows installed. Thus, double-clicking
an installed script in a Windows Explorer window should run it with
the correct interpreter without the environment needing to be
activated or on the "PATH".

When a virtual environment has been activated, the "VIRTUAL_ENV"
environment variable is set to the path of the environment. Since
explicitly activating a virtual environment is not required to use it,
"VIRTUAL_ENV" cannot be relied upon to determine whether a virtual
environment is being used.

Advertencia:

  Because scripts installed in environments should not expect the
  environment to be activated, their shebang lines contain the
  absolute paths to their environment's interpreters. Because of this,
  environments are inherently non-portable, in the general case. You
  should always have a simple means of recreating an environment (for
  example, if you have a requirements file "requirements.txt", you can
  invoke "pip install -r requirements.txt" using the environment's
  "pip" to install all of the packages needed by the environment). If
  for any reason you need to move the environment to a new location,
  you should recreate it at the desired location and delete the one at
  the old location. If you move an environment because you moved a
  parent directory of it, you should recreate the environment in its
  new location. Otherwise, software installed into the environment may
  not work as expected.

You can deactivate a virtual environment by typing "deactivate" in
your shell. The exact mechanism is platform-specific and is an
internal implementation detail (typically, a script or shell function
will be used).


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, upgrade_deps=False)

   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 de caracteres que se utilizará después de
     que se active el entorno virtual (el valor predeterminado es
     "None", lo que significa que se utilizaría el nombre del
     directorio del entorno). Si se proporciona la cadena especial
     ""."", el nombre base del directorio actual se utiliza como
     indicador.

   * "upgrade_deps" -- actualiza los módulos venv base a lo último en
     PyPI

   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"

   Nuevo en la versión 3.9: Se agregó el parámetro "upgrade_deps"

   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)

      Creates the environment directory and all necessary
      subdirectories that don't already exist, and returns a context
      object.  This context object is just a holder for attributes
      (such as paths) for use by the other methods.  If the
      "EnvBuilder" is created with the arg "clear=True", contents of
      the environment directory will be cleared and then all necessary
      subdirectories will be recreated.

      The returned context object is a "types.SimpleNamespace" with
      the following attributes:

      * "env_dir" - The location of the virtual environment. Used for
        "__VENV_DIR__" in activation scripts (see
        "install_scripts()").

      * "env_name" - The name of the virtual environment. Used for
        "__VENV_NAME__" in activation scripts (see
        "install_scripts()").

      * "prompt" - The prompt to be used by the activation scripts.
        Used for "__VENV_PROMPT__" in activation scripts (see
        "install_scripts()").

      * "executable" - The underlying Python executable used by the
        virtual environment. This takes into account the case where a
        virtual environment is created from another virtual
        environment.

      * "inc_path" - The include path for the virtual environment.

      * "lib_path" - The purelib path for the virtual environment.

      * "bin_path" - The script path for the virtual environment.

      * "bin_name" - The name of the script path relative to the
        virtual environment location. Used for "__VENV_BIN_NAME__" in
        activation scripts (see "install_scripts()").

      * "env_exe" - The name of the Python interpreter in the virtual
        environment. Used for "__VENV_PYTHON__" in activation scripts
        (see "install_scripts()").

      * "env_exec_cmd" - The name of the Python interpreter, taking
        into account filesystem redirections. This can be used to run
        Python in the virtual environment.

      Distinto en la versión 3.12: The attribute "lib_path" was added
      to the context, and the context object was documented.

      Distinto en la versión 3.11: The *venv* sysconfig installation
      scheme is used to construct the paths of the created
      directories.

   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.

   upgrade_dependencies(context)

      Actualiza los paquetes de dependencia principales de venv
      (actualmente "pip" y "setuptools") en el entorno. Esto se hace
      desembolsando el ejecutable "pip" en el entorno.

      Nuevo en la versión 3.9.

   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, upgrade_deps=False)

   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"

   Distinto en la versión 3.9: Se agregó el parámetro "upgrade_deps"


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.
