Uso de carpetas de Python en rutas de búsqueda de Visual Studio

En un programa típico de Python, la variable de entorno PYTHONPATH (o IRONPYTHONPATH, etc.) proporciona la ruta de acceso de búsqueda predeterminada para los archivos de módulo. Las instrucciones from <name> import... o import <name> indican a Python que busque las ubicaciones específicas de los archivos que coinciden con el <name> especificado. Las ubicaciones se buscan en el siguiente orden:

  1. Módulos integrados de Python
  2. La carpeta que contiene el código de Python que se está ejecutando actualmente
  3. La "ruta de búsqueda del módulo" tal como se define en la variable de entorno aplicable (para obtener más información, consulte Ruta de búsqueda del módulo y Variables de entorno en la documentación principal de Python).

Visual Studio omite la variable de entorno de ruta de acceso de búsqueda, incluso si se ha establecido para todo el sistema. El motivo es que el uso de la variable plantea preguntas que no se pueden responder fácilmente, como:

  • ¿Los módulos a los que se hace referencia esperan una instalación de Python 2.7, Python 3.6 u otra versión?
  • ¿Los archivos encontrados en la variable de entorno de ruta de búsqueda reemplazan los módulos de biblioteca estándar?
  • ¿Se espera y aborda algún comportamiento de anulación o podría ser malintencionado?

Para ayudar a los desarrolladores, Visual Studio proporciona una forma de especificar rutas de acceso de búsqueda directamente en entornos y proyectos de Python. El código que ejecuta o depura en Visual Studio recibe rutas de búsqueda desde la variable de entorno PYTHONPATH y la variable equivalente. Al agregar rutas de búsqueda, Visual Studio inspecciona las bibliotecas en las ubicaciones especificadas y crea bases de datos de IntelliSense para las bibliotecas según sea necesario. (En la versión 15.5 y anteriores de Visual Studio 2017, la creación de la base de datos puede tardar en función del número de bibliotecas).

Requisitos previos

  • Visual Studio. Para instalar el producto, siga los pasos descritos en Instalación de Visual Studio.

  • Carpetas de Python que desea agregar a las rutas de búsqueda.

Adición de carpetas de Python a rutas de búsqueda

Siga estos pasos para agregar una carpeta de Python a las rutas de búsqueda de Visual Studio:

  1. En el Explorador de soluciones, expanda el nodo del proyecto de Python, haga clic con el botón derecho en Rutas de búsqueda y seleccione Agregar carpeta a ruta de búsqueda:

    Captura de pantalla que muestra cómo acceder al comando Agregar carpeta a ruta de búsqueda en Rutas de acceso de búsqueda para un proyecto de Python en Explorador de soluciones.

  2. En el cuadro de diálogo, vaya a la ubicación de la carpeta que desea agregar a las rutas de búsqueda reconocidas.

  3. Seleccione la carpeta y, a continuación, elija Seleccionar carpeta.

Una vez que se han agregado las carpetas a las rutas de búsqueda, Visual Studio usa esas rutas para cualquier entorno asociado al proyecto.

Nota:

Si el entorno se basa en Python 3 e intenta agregar una ruta de acceso de búsqueda a los módulos de Python 2.7, podrían generarse errores.

Adición de archivos zip y egg a las rutas de búsqueda

Puede agregar archivos con una extensión .zip o .egg a las rutas de búsqueda con la opción Agregar archivo zip a ruta de búsqueda. Al igual que con las carpetas, el contenido de estos archivos se examina y se pone a disposición de IntelliSense.