Início Rápido: Criar um aplicativo Web Python com o Visual Studio

Neste início rápido, você criará um aplicativo Web Python com base na estrutura do Flask no Visual Studio. Você cria o projeto por meio de etapas discretas que ajudam a aprender sobre os recursos básicos do Visual Studio. Explore como criar itens de projeto, adicionar código e executar aplicativos.

Se você precisar instalar o Visual Studio, acesse os downloads do Visual Studio para instalá-lo gratuitamente. No Instalador do Visual Studio, selecione a carga de trabalho de desenvolvimento do Python . No painel de detalhes da instalação, selecione o suporte à Web do Python.

Criar o projeto

As etapas a seguir criam um projeto vazio que serve como um contêiner para o aplicativo.

1. Abra o Visual Studio. Na tela inicial, selecione Criar um novo projeto.

2. Na caixa de diálogo Criar um novo projeto , insira o Python Web na caixa de pesquisa. Na lista de resultados, selecione Projeto Web e, em seguida, selecione Avançar.

   

   Se você não vir os modelos de projeto Web do Python, selecione Ferramentas>Obter Ferramentas e Funcionalidades para executar o Instalador do Visual Studio. No instalador, selecione o pacote de desenvolvimento Python. Em Detalhes de instalação, selecione o suporte à Web do Python e selecione Modificar.

3. Na caixa de diálogo Configurar seu novo projeto , insira HelloPython para o nome do projeto, especifique um local do projeto e selecione Criar.

   

   O novo projeto é aberto no Gerenciador de Soluções. O nome da solução é definido automaticamente para corresponder ao nome do Projeto. O novo projeto está vazio porque não contém arquivos.

   

Projetos e soluções no Visual Studio

Há vantagens em criar um projeto no Visual Studio para um aplicativo Python. Os aplicativos Python normalmente são definidos usando apenas pastas e arquivos, mas essa estrutura simples pode se tornar onerosa à medida que os aplicativos aumentam. Os aplicativos podem envolver arquivos gerados automaticamente, JavaScript para aplicativos Web e outros componentes. Um projeto do Visual Studio ajuda a gerenciar essa complexidade.

O projeto é identificado com um arquivo .pyproj , que identifica todos os arquivos de origem e conteúdo associados ao seu projeto. O arquivo .pyproj contém informações de build para cada arquivo, mantém informações para integração com sistemas de controle do código-fonte e ajuda a organizar seu aplicativo em componentes lógicos.

Uma solução do Visual Studio é um contêiner que ajuda você a gerenciar um ou mais projetos relacionados como um grupo. O Visual Studio mostra suas soluções no Gerenciador de Soluções. A solução armazena configurações que não são específicas para um projeto. Projetos em uma solução também podem fazer referência uns aos outros. Por exemplo, a execução de um projeto de aplicativo Python pode criar automaticamente um segundo projeto, como uma extensão C++ que o aplicativo Python usa.

Instalar a biblioteca do Flask

Os aplicativos Web no Python quase sempre usam uma das muitas bibliotecas python disponíveis para lidar com detalhes de baixo nível, como roteamento de solicitações da Web e formatação de respostas. O Visual Studio fornece muitos modelos para aplicativos Web. Você criará um projeto com base em um desses modelos mais adiante neste Início Rápido.

Use as etapas a seguir para instalar a biblioteca flask no ambiente global padrão que o Visual Studio usa para este projeto.

1. Expanda o nó Ambientes do Python no projeto para ver o ambiente padrão do projeto.

   

2. Clique com o botão direito do mouse no ambiente e selecione Gerenciar Pacotes do Python. Esse comando abre a janela Ambientes do Python na aba Pacotes (PyPI).

3. Insira flask no campo de pesquisa.

   • Se o comando Flask aparecer abaixo da caixa de pesquisa, o Flask já estará presente no sistema. Siga para a próxima etapa.

   • Se o comando Flask não aparecer na caixa de pesquisa abaixo, selecione Executar comando: pip install flask.

     

     Um prompt de elevação será exibido se a pasta de pacotes de ambiente global estiver em uma área protegida, como C:\Arquivos de Programas. Aceite quaisquer solicitações para privilégios de administrador. Você pode observar a janela Saída do Visual Studio para monitorar o andamento.

4. Depois de instalar o Flask, a biblioteca será exibida no ambiente no Gerenciador de Soluções. Agora você pode usar comandos do Flask em seu código Python.

   

Observação

Em vez de instalar bibliotecas no ambiente global, os desenvolvedores normalmente criam um ambiente virtual no qual instalar bibliotecas para um projeto específico. Os modelos do Visual Studio normalmente oferecem essa opção, conforme descrito no Início Rápido – Criar um projeto do Python usando um modelo.

Para obter mais informações sobre outros pacotes do Python disponíveis, consulte o Índice de Pacotes do Python.

Adicionar um arquivo de código

Agora você está pronto para adicionar um código Python para implementar um aplicativo Web mínimo.

1. Clique com o botão direito do mouse no projeto no Gerenciador de Soluções e selecione Adicionar>Novo Item.

2. Na caixa de diálogo Adicionar Novo Item, selecione a opção de Arquivo Python Vazio.

3. Insira o nome do arquivo app.py e selecione Adicionar. O Visual Studio abre automaticamente o arquivo em uma janela do editor.

4. Copie o seguinte código e cole-o no arquivo app.py :

   from flask import Flask
   
   # Create an instance of the Flask class that is the WSGI application.
   # The first argument is the name of the application module or package,
   # typically __name__ when using a single module.
   app = Flask(__name__)
   
   # Flask route decorators map / and /hello to the hello function.
   # To add other resources, create functions that generate the page contents
   # and add decorators to define the appropriate resource locators for them.
   
   @app.route('/')
   @app.route('/hello')
   def hello():
      # Render the page
      return "Hello Python!"
   
   if __name__ == '__main__':
      # Run the app server on localhost:4449
      app.run('localhost', 4449)
   
   

A caixa de diálogo Adicionar Novo Item exibe muitos outros tipos de arquivos que você pode adicionar a um projeto python, como uma classe Python, um pacote Python, um teste de unidade do Python ou arquivos web.config . Em geral, esses modelos de item são uma ótima maneira de criar arquivos rapidamente com código clichê útil.

Para obter mais informações sobre o Flask, consulte o Início Rápido do Flask.

Executar o aplicativo

Siga estas etapas para executar seu aplicativo Web:

1. No Gerenciador de Soluções, clique com o botão direito do mouse no arquivo app.py e selecione Definir como Arquivo de Inicialização. Esse comando identifica o arquivo de código a ser iniciado no Python ao executar o aplicativo.

   

2. Clique com o botão direito do mouse no projeto no Gerenciador de Soluções e selecione Propriedades.

3. Na caixa de diálogo Propriedades , na guia Depurar , defina a propriedade Número da Porta como 4449. Essa configuração garante que o Visual Studio inicie um navegador localhost:4449 compatível com os app.run argumentos no código.

4. No Visual Studio, selecione Iniciar Sem Depuração>sem depuração ou selecione Ctrl+F5, que salva alterações em seus arquivos e executa o aplicativo.

   Uma janela de comando é aberta e exibe a mensagem "Em execução em https://localhost:4449". Uma janela do navegador é aberta localhost:4449 e exibe a mensagem "Olá, Python!". A GET solicitação também aparece na janela de comando com um status de "200".

   Se um navegador não abrir automaticamente, abra o navegador de sua escolha e vá para localhost:4449.

   Se você vir apenas o shell interativo do Python na janela de comando ou se essa janela piscar brevemente na tela, verifique se o arquivo app.py está definido como o arquivo de inicialização.

5. Na janela do navegador, vá para localhost:4449/hello para testar se o decorador do recurso /hello também funciona.

   Novamente, a solicitação GET aparece na janela de comando com um status de "200".

   Experimente outras URLs também para ver que elas mostram códigos de status "404" na janela de comando.

6. Feche a janela de comando para interromper o aplicativo e feche a janela do navegador.

Iniciar com ou sem debug

Você pode executar sua aplicação com ou sem a depuração habilitada. Aqui estão as diferenças entre estas opções:

• O comando Iniciar Depuração executa o aplicativo no contexto do depurador do Visual Studio. Com o depurador, você pode definir pontos de interrupção, examinar variáveis e percorrer sua linha de código por linha. Os aplicativos podem funcionar mais lentamente no depurador devido aos mecanismos que possibilitam a depuração.

• Use o comando Iniciar sem Depuração para executar o aplicativo diretamente sem nenhum contexto de depuração, semelhante à execução do aplicativo na linha de comando. Esse comando também inicia automaticamente um navegador e abre a URL especificada na abaPropriedades>Depuração do projeto.

Conteúdo relacionado

• Início Rápido: Criar um projeto do Python com base em um modelo
• Tutorial: Trabalhar com Python no Visual Studio
• Modelos de projeto de aplicativo Web do Python