Utilizar pastas do Python em caminhos de pesquisa do Visual Studio

  • Artigo

Em um programa típico do Python, a variável de ambiente PYTHONPATH (ou IRONPYTHONPATH etc.) fornece o caminho de pesquisa padrão para arquivos de módulo. As instruções from <name> import... or import <name> ordenam que o Python pesquise os locais específicos em busca de arquivos que correspondam à especificação de <name>. Os locais são pesquisados na seguinte ordem:

  1. Módulos internos do Python
  2. A pasta que contém o código do Python que está em execução.
  3. O “caminho de pesquisa do módulo”, conforme definido pela variável de ambiente aplicável. Para obter mais informações, consulte as seções The Module Search Path e Environment variables na documentação básica do Python.

O Visual Studio ignora a variável de ambiente do caminho de pesquisa, mesmo quando ela tiver sido configurada para todo o sistema. Isso acontece porque a utilização da variável levanta questões que não são simples de responder, como:

  • Os módulos referenciados esperam uma instalação do Python 2.7, do Python 3.6 ou de outra versão?
  • Os arquivos na variável de ambiente do caminho de pesquisa devem substituir os módulos de biblioteca padrão?
  • Algum comportamento de substituição é esperado e abordado ou é possível que a ação seja maliciosa?

Para auxiliar os desenvolvedores, o Visual Studio fornece uma forma de especificar caminhos de pesquisa diretamente nos projetos e ambientes do Python. O código que você executa ou depura no Visual Studio recebe os caminhos da variável de ambiente PYTHONPATH e da variável equivalente. Com a adição de caminhos de pesquisa, o Visual Studio inspeciona as bibliotecas nos locais especificados e cria bancos de dados do IntelliSense para as bibliotecas, conforme a necessidade. (No Visual Studio 2017 versão 15.5 e anteriores, a construção do banco de dados pode demorar um pouco, dependendo da quantidade de bibliotecas).

Pré-requisitos

  • Visual Studio. Para instalar o produto, siga as etapas em Instalar o Visual Studio.

  • As pastas do Python que deseja adicionar aos caminhos de pesquisa.

Adicionar pastas do Python aos caminhos de pesquisa

Siga essas etapas para adicionar pastas do Python aos caminhos de pesquisa do Visual Studio:

  1. No Gerenciador de Soluções, expanda o nó do projeto do Python, clique com o botão direito do mouse em Caminhos de Pesquisa e selecione Adicionar Pasta ao Caminho de Pesquisa:

    Captura de tela mostrando como acessar o comando Adicionar Pasta ao Caminho de Pesquisa em Caminhos de Pesquisa em um projeto Python no gerenciador de soluções.

  2. Na caixa de diálogo, acesse o local da pasta que deseja adicionar aos caminhos de pesquisa reconhecidos.

  3. Escolha a pasta e selecione Selecionar pasta.

Depois que as pastas forem adicionadas aos caminhos de pesquisa, o Visual Studio usará esses caminhos para qualquer ambiente associado ao projeto.

Observação

Se o seu ambiente for baseado no Python 3 e você tentar adicionar um caminho de pesquisa a módulos do Python 2.7, poderão ocorrer erros.

Adicionar arquivos zip e egg aos caminhos de pesquisa

É possível adicionar arquivos com extensão .zip ou .egg aos caminhos de pesquisa usando a opção Adicionar Arquivo Zip ao Caminho de Pesquisa. Assim como ocorre com pastas, o conteúdo desses arquivos é examinado e disponibilizado para o IntelliSense.

Conteúdo relacionado