Partilhar via

Gerencie os pacotes Python necessários com o requirements.txt

Se partilhar o seu projeto Python com outros, ou usar um sistema de compilação para produzir a sua aplicação Python, precisa de especificar quaisquer pacotes externos necessários. Quando planeia copiar o seu projeto para outros locais onde precisa de restaurar um ambiente, também precisa de definir os pacotes dependentes necessários.

A abordagem recomendada para especificar pacotes Python dependentes externos é usar um ficheiro de requisitos (readthedocs.org). Este ficheiro contém uma lista de comandos pip que instalam quaisquer versões necessárias dos pacotes dependentes para o seu projeto. O comando mais comum é pip freeze > requirements.txt. Este comando regista a lista atual de pacotes do seu ambiente no requirements.txt ficheiro.

Um ficheiro de requisitos contém versões precisas de todos os pacotes instalados. Podes usar ficheiros de requisitos para congelar os requisitos de um ambiente. Ao usar versões precisas dos pacotes, pode facilmente reproduzir o seu ambiente noutro computador. Os ficheiros de requisitos incluem pacotes mesmo que estejam instalados com um intervalo de versões, como dependência de outro pacote, ou com um instalador diferente do pip.

Pré-requisitos

Tecnicamente, qualquer nome de ficheiro pode ser usado para acompanhamento de requisitos. No entanto, o Visual Studio fornece suporte específico para o ficheiro de requisitos chamado "requirements.txt." Podes usar o -r <full path to file> argumento quando instalas um pacote para especificar o nome preferido para o ficheiro.

Dependências de instalação listadas no requirements.txt

Se carregares um projeto que tenha um requirements.txt ficheiro, podes instalar todas as dependências de pacotes listadas no ficheiro.

  1. No Explorador de Soluções, expande o projeto e, em seguida, expande o nó Ambientes Python.

  2. Localize o nó de ambiente para o qual quer instalar os pacotes. Clique com o botão direito no nó e selecione Instalar a partir de requirements.txt.

  3. Pode monitorizar o processo de instalação do pacote na janela de Saída :

    Captura de ecrã que mostra a saída da instalação dos pacotes Python a partir de um ficheiro de texto de requisitos.

    A saída lista quaisquer pacotes necessários instalados, juntamente com quaisquer atualizações necessárias para comandos de pip afetados e a disponibilidade de versões de pip mais recentes.

Instalar dependências num ambiente virtual

Também pode instalar as dependências de pacotes Python num ambiente virtual existente.

  1. No Explorador de Soluções, expanda o seu projeto e depois expanda o nó Ambientes Python.

  2. Localiza o nó do ambiente virtual para o qual queres instalar os pacotes. Clique com o botão direito no nó e selecione Instalar a partir de requirements.txt.

Se precisar de criar um ambiente virtual, veja Usar ambientes virtuais.

Gerar o ficheiro requirements.txt

Se todos os pacotes Python necessários para o seu projeto já estiverem instalados num ambiente, pode gerar o ficheiro requirements.txt no Visual Studio.

  1. No Explorador de Soluções, expanda o seu projeto e, em seguida, expanda o nó Ambientes Python.

  2. Localiza o nó de ambiente para o qual queres gerar o ficheiro de requisitos. Clique com o botão direito do rato no nó e selecione Gerar requirements.txt.

Atualizar ou adicionar entradas a um ficheiro de requirements.txt existente

Se o requirements.txt ficheiro já existir, o Visual Studio apresenta um prompt com várias opções:

Captura de ecrã do prompt exibido quando o ficheiro de texto de requisitos já existe, com opções para atualizar ou adicionar entradas, ou substituir o ficheiro.

  • Substituir o ficheiro inteiro: Sobrescrever todos os itens, comentários e opções definidos no requirements.text ficheiro.
  • Atualizar as entradas existentes: Atualize os especificadores de versão no requirements.text ficheiro para corresponderem à versão atualmente instalada.
  • Atualizar e adicionar entradas: Atualize os requisitos existentes no requirements.text ficheiro e anexe todos os novos requisitos de pacote ao final do ficheiro.

O Visual Studio executa pip para detetar os requisitos atuais do pacote para o ambiente e depois atualiza o seu requirements.txt ficheiro com base na sua escolha.

Instalar manualmente dependências de pacotes

Se o pip não instalar uma dependência de pacote definida no teu requirements.txt ficheiro, toda a instalação falha.

Tem duas opções para resolver esta questão:

  • Edita manualmente o requirements.txt ficheiro para excluir o pacote falhado e depois reexecuta o processo de instalação.

  • Utilize opções de comando pip para se referir a uma versão instalável do pacote.

Atualize o ficheiro de requisitos com pip wheel

Se usar o pip wheel comando para compilar uma dependência, pode adicionar a --find-links <path> opção ao seu requirements.txt ficheiro.

  1. Chame o pip wheel comando para compilar a lista de dependências necessárias:

    pip wheel azure

    A saída mostra as rodas construídas para os pacotes recolhidos:

    Downloading/unpacking azure
    Running setup.py (path:C:\Project\env\build\azure\setup.py) egg_info for package azure

Building wheels for collected packages: azure
    Running setup.py bdist_wheel for azure
    Destination directory: c:\project\wheelhouse
Successfully built azure
Cleaning up...

  2. Anexe as opções find-links e no-index, bem como o requisito de versão do pacote ao seu ficheiro requirements.txt.

    type requirements.txt
--find-links wheelhouse
--no-index
azure==0.8.0

  3. Execute o processo de instalação do pip com o seu ficheiro de requisitos atualizado:

    pip install -r requirements.txt -v

    A saída acompanha o progresso do processo de instalação:

    Downloading/unpacking azure==0.8.0 (from -r requirements.txt (line 3))
    Local files found: C:/Project/wheelhouse/azure-0.8.0-py3-none-any.whl
Installing collected packages: azure
Successfully installed azure
Cleaning up...
    Removing temporary dir C:\Project\env\build...

Conteúdo relacionado

  • Last updated on