Selección de un entorno de Python para un proyecto en Visual Studio

Todo el código de un proyecto de Python se ejecuta dentro del contexto de un entorno específico. Estos entornos pueden ser un entorno de Python global, un entorno de Anaconda, un entorno virtual o un entorno de Conda. Visual Studio usa el entorno de Python para la depuración, la importación y la finalización de miembros, y la comprobación de sintaxis. El entorno se usa para cualquier tarea que requiera servicios de lenguaje específicos de la versión de Python y un conjunto de paquetes instalados.

En Visual Studio, puede crear varios entornos para un proyecto y cambiar entre ellos según sus necesidades de desarrollo específicas. Todos los nuevos proyectos de Python se configuran inicialmente para usar el entorno global predeterminado. Puede ver los entornos del proyecto en el nodo Python Environments en Explorador de soluciones:

Screenshot que muestra el entorno de Python predeterminado global para un proyecto en Explorador de soluciones en Visual Studio.

Screenshot que muestra el entorno de Python predeterminado global para un proyecto en Explorador de soluciones en Visual Studio.

Prerrequisitos

Cambiar el entorno del proyecto actual

En Visual Studio, puede cambiar el entorno activo (actual) de un proyecto de Python en Explorador de soluciones o desde la barra de herramientas mediante la característica Add Environment.

  1. Inicie el proceso Agregar entorno :

    • En Explorador de soluciones, haga clic con el botón derecho en el nodo Python Environments del proyecto y seleccione Add Environment.
    • O bien, en la barra de herramientas de Python, seleccione Add Environment en el menú desplegable Environment.
  2. En el cuadro de diálogo Agregar entorno , seleccione la pestaña Entorno existente . Expanda la lista desplegable Entorno y elija el entorno deseado y, después, seleccione Agregar.

    Screenshot que muestra cómo seleccionar un entorno de proyecto en el cuadro de diálogo Agregar entornos en Visual Studio.

Nota:

Si el entorno que desea usar no aparece en la lista, es posible que tenga que identificar manualmente un entorno existente.

Uso de entornos virtuales

Un entorno virtual es una combinación única de un intérprete de Python específico y un conjunto específico de bibliotecas que son diferentes de otros entornos globales y de Conda. Un entorno virtual es específico de un proyecto y se mantiene en una subcarpeta de proyecto. La carpeta contiene las bibliotecas instaladas del entorno junto con un archivo pyvenv.cfg que especifica la ruta de acceso al intérprete base del entorno en el sistema de archivos. (Un entorno virtual no contiene una copia del intérprete, solo un vínculo a él).

Una ventaja para usar un entorno virtual es que a medida que desarrolla el proyecto a lo largo del tiempo, el entorno virtual siempre refleja las dependencias exactas del proyecto. Este comportamiento es diferente de un entorno global compartido, que contiene cualquier número de bibliotecas, tanto si se usan en el proyecto como si no. Desde un entorno virtual, puede crear fácilmente un archivo requirements.txt , que se usa para reinstalar las dependencias de paquetes en otros equipos de desarrollo o producción. Para obtener más información, consulte Administración de paquetes necesarios con requirements.txt.

Al abrir un proyecto en Visual Studio que contiene un archivo requirements.txt, Visual Studio proporciona automáticamente la opción de volver a crear el entorno virtual. En equipos en los que no está instalado Visual Studio, puede usar el comando pip install -r requirements.txt para restaurar los paquetes necesarios.

Dado que un entorno virtual contiene una ruta de acceso codificada de forma rígida al intérprete base de Python y que puede volver a crear el entorno mediante el archivo requirements.txt, normalmente se omite la subcarpeta del entorno del control de código fuente. Después de agregar un entorno virtual al proyecto, aparece en la ventana Python Environments. Después, puede activarlo como cualquier otro entorno y administrar sus paquetes.

Creación de un entorno virtual

Puede crear un nuevo entorno virtual directamente en Visual Studio como se indica a continuación:

  1. Inicie el proceso Agregar entorno :

    • En Explorador de soluciones, haga clic con el botón derecho en el nodo Python Environments del proyecto y seleccione Add Environment.
    • O bien, en la barra de herramientas de Python, seleccione Add Environment en el menú desplegable Environment.
  2. En el cuadro de diálogo Agregar entorno , seleccione la pestaña Entorno virtual :

    Captura de pantalla de la pestaña Entorno virtual del cuadro de diálogo Agregar entorno en Visual Studio.

  3. Configure los campos obligatorios:

    Campo obligatorio Descripción
    Proyecto Identifique el proyecto en el que se va a crear el entorno.
    Nombre Proporcione el nombre del nuevo entorno virtual.
    Intérprete base Especifique el intérprete de idioma base para el entorno virtual.
    Location El sistema asigna la ubicación predeterminada para el entorno virtual. Para cambiar la ubicación, seleccione el vínculo Cambiar ubicación del entorno virtual , vaya a la ubicación y elija Seleccionar carpeta.
  4. Configure los campos opcionales deseados:

    Campo opcional Descripción
    Instalación de paquetes desde el archivo Especifique la ruta de acceso a un archivo requirements.txt para agregar paquetes al entorno virtual. Escriba la ubicación y el nombre del archivo o busque (...) en la ubicación y seleccione el archivo.
    Establecer como entorno actual Active el nuevo entorno en el proyecto seleccionado después de crear el entorno.
    Establecer como entorno predeterminado para los nuevos proyectos Establezca y active automáticamente el entorno en los nuevos proyectos creados en Visual Studio. Esta configuración también está disponible a través de la opción Convertir este entorno por defecto para los nuevos proyectos en la ventana Entornos de Python. Cuando use esta opción, coloque el entorno virtual en una ubicación fuera de un proyecto específico.
    Ver en la ventana Entornos de Python Especifique si se va a mostrar la ventana Python Environments después de crear el nuevo entorno.
    Hacer que este entorno esté disponible globalmente Especifique si el entorno virtual también debe actuar como un entorno global. Cuando use esta opción, coloque el entorno virtual en una ubicación fuera de un proyecto específico.
  5. Seleccione Crear para finalizar el entorno virtual.

Visual Studio muestra una barra de progreso mientras configura el entorno y descarga los paquetes necesarios.

Una vez completado el proceso, Visual Studio activa el nuevo entorno virtual y lo agrega al nodo Python Environments en Explorador de soluciones. El entorno también está disponible en la ventana Python Environments para el proyecto contenedor.

Activación de un entorno

Siga estos pasos para activar un entorno existente para un proyecto:

  1. En Explorador de soluciones, expanda el nodo Python Environments del proyecto y busque el entorno que desea usar.

  2. Haga clic con el botón derecho en el entorno y seleccione Activar entorno.

    Si Visual Studio detecta un archivo requirements.txt en ese entorno, le pregunta si desea instalar esos paquetes.

    Después de Visual Studio activa el entorno, el nombre del entorno activo se muestra en una fuente en negrita en Explorador de soluciones:

    Screenshot que muestra cómo Visual Studio muestra el nombre del entorno activo en una fuente en negrita en Explorador de soluciones.

    Screenshot que muestra cómo Visual Studio muestra el nombre del entorno activo en una fuente en negrita en Explorador de soluciones.

Eliminación de un entorno virtual

Siga estos pasos para quitar un entorno existente para un proyecto:

  1. En Explorador de soluciones, haga clic con el botón derecho en el entorno virtual y seleccione Remove.

  2. Visual Studio pregunta si desea quitar o eliminar el entorno virtual.

    • Seleccione Quitar para que el entorno no esté disponible para el proyecto, pero déjelo en el sistema de archivos.
    • Seleccione Eliminar para quitar el entorno del proyecto y eliminarlo del sistema de archivos. El intérprete base no se ve afectado.

Visualización y administración de paquetes instalados

En Explorador de soluciones, puede ver y administrar los paquetes instalados en un entorno. Estos paquetes se pueden importar y usar en el código cuando el entorno está activo.

  • Para ver rápidamente los paquetes instalados en un entorno, expanda el nodo de entorno en el nodo Python Environments del proyecto en Explorador de soluciones:

  • Para instalar nuevos paquetes o administrar paquetes existentes, haga clic con el botón derecho en el nodo de entorno y seleccione Administrar Python Paquetes. También puede usar el botón paquete en la barra de herramientas de Python:

    Se abre la ventana Python Environments y muestra los paquetes instalados para el entorno seleccionado en la pestaña Packages (PyPI):

    En Visual Studio, los paquetes y dependencias de la mayoría de los entornos se descargan del Índice de Paquetes de Python (PyPI), donde también se pueden buscar los paquetes disponibles. Visual Studio la barra de estado y la ventana de salida muestran información sobre la instalación.

  • Para desinstalar (quitar) un paquete, busque el paquete en la lista y seleccione el icono x situado a la derecha.

  • Para buscar versiones actualizadas de un paquete u otros paquetes, escriba un término de búsqueda (normalmente un nombre de paquete):

    Visual Studio muestra paquetes coincidentes. En este ejemplo, la búsqueda es para paquetes que coinciden con el término blinker.

    Visual Studio muestra una lista de resultados coincidentes como vínculos de comandos activos.

    • El primer comando actualiza el paquete a la versión más actual y las dependencias actuales. El comando es similar a Run command: pip install <package-name>. Si selecciona Enter después del término de búsqueda, Visual Studio ejecuta automáticamente este primer comando.

    • Los otros vínculos son para los comandos que instalan un paquete, una versión o una dependencia específicos, como Install blinker-async (0.0.3). Para ejecutar uno de estos comandos, seleccione el vínculo .

Consideraciones sobre la instalación de paquetes

Al trabajar con paquetes en Visual Studio, tenga en cuenta las siguientes consideraciones:

  • Tenga en cuenta que las entradas mostradas para los paquetes podrían no ser precisas en términos de la versión o disponibilidad más actual. Es posible que la información de instalación y desinstalación que se muestra para un paquete no sea confiable o esté disponible.

  • Visual Studio usa el administrador de paquetes pip si está disponible y descarga e instala cuando sea necesario. Visual Studio también puede usar el administrador de paquetes de easy_install. También se muestran los paquetes instalados mediante los pip comandos o easy_install de la línea de comandos.

  • Una situación común en la que pip no puede instalar un paquete es cuando el paquete incluye código fuente para componentes nativos en archivos *.pyd . Sin la versión necesaria de Visual Studio instalada, pip no puede compilar estos componentes. El mensaje de error que se muestra en esta situación es error: No se puede encontrar vcvarsall.bat. El comando easy_install a menudo puede descargar archivos binarios precompilados y puede descargar un compilador adecuado para versiones anteriores de Python desde https://python.en.uptodown.com/windows/versions. Para obtener más información, consulte Cómo tratar el problema de "no encontrar vcvarsallbat" en el blog del equipo de herramientas de Python.

  • El administrador de paquetes de Conda generalmente usa https://repo.continuum.io/pkgs/ como canal predeterminado, pero otros canales están disponibles. Para obtener más información, consulte Administrar canales (docs.conda.io).

  • Visual Studio no admite actualmente el uso del comando conda para instalar paquetes en un entorno de Conda. Use el conda comando desde la línea de comandos en su lugar.