Início rápido: crie seu primeiro aplicativo Web Python usando o Visual Studio

Aplica-se a:yes Visual Studio noVisual Studio para Mac noVisual Studio Code

Nesta introdução de 5 a 10 minutos do Visual Studio como um IDE do Python, você criará um aplicativo Web Python simples na estrutura Flask. Crie o projeto por meio de etapas simples para ajudarão a saber mais sobre os recursos básicos do Visual Studio.

Se você ainda não instalou o Visual Studio, acesse a página de downloads do Visual Studio para instalá-lo gratuitamente. No instalador, selecione a carga de trabalho de Desenvolvimento de Python.

Se você ainda não instalou o Visual Studio, acesse a página de downloads do Visual Studio para instalá-lo gratuitamente. No Instalador do Visual Studio, selecione a carga de trabalho de desenvolvimento do Python e, nos detalhes da instalação, selecione o suporte web do Python.

Screenshot of the Visual Studio Installer with the Python development workload and Python web support selected.

Criar o projeto

As seguintes etapas criam um projeto vazio que serve como um contêiner para o aplicativo:

  1. Abra o Visual Studio 2019.

  2. Na tela inicial, selecione Criar um novo projeto.

  3. Na caixa de diálogo Criar um novo projeto, digite "Python Web"no campo de pesquisa na parte superior, escolha Projeto Web na lista do meio, depois selecione Avançar:

    Create a new project screen with Python Web Project selected Se você não vir os modelos de projeto do Python, execute o Instalador do Visual Studio, selecione Mais>Modificar, selecione a carga de trabalho de desenvolvimento do Python e escolha Modificar.

    Python development workload in the Visual Studio installer

  4. Na caixa de diálogo Configurar seu novo projeto, insira "HelloPython" para Nome do projeto, especifique um local e selecione Criar. (O Nome da solução é definido automaticamente para corresponder ao Nome do projeto.)

    Configure your new project dialog

  5. O novo projeto será aberto no Gerenciador de Soluções no painel direito. O projeto está vazio neste momento porque ele não contém outros arquivos.

    Sreenshot showing the newly created empty project in the Solution Explorer.

  1. Abra o Visual Studio 2022.

  2. Na tela inicial, selecione Criar um novo projeto.

  3. Na caixa de diálogo Criar um novo projeto , insira "Python Web" no campo de pesquisa na parte superior. Escolha o Projeto Web na lista e selecione Avançar:

    Screenshot showing the Create a new project screen with Python Web Project selected.

    Se você não vir os modelos de projeto Web do Python, selecione Ferramentas>para Obter Ferramentas e Recursos para executar o Instalador do Visual Studio. No Instalador, selecione a carga de trabalho de desenvolvimento do Python e, em detalhes de instalação, selecione o suporte da Web do Python. Em seguida, selecione Modificar.

  4. Na caixa de diálogo Configurar seu novo projeto , insira "HelloPython" para o nome do projeto, especifique um local e selecione Criar. O nome da solução é atualizado automaticamente para corresponder ao nome do projeto.

    Screenshot showing the Configure your new project dialog.

O novo projeto será aberto no Gerenciador de Soluções no painel direito. O projeto está vazio neste momento porque ele não contém outros arquivos.

Screenshot showing the Solution Explorer with the newly created empty project.

Pergunta: Qual é a vantagem de criar um projeto no Visual Studio para um aplicativo de Python?

Resposta: os aplicativos Python normalmente são definidos usando apenas pastas e arquivos, mas essa estrutura simples pode se tornar pesada à 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, um arquivo .pyproj , 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.

Pergunta: O que é a "solução" mostrada no Gerenciador de Soluções?

Resposta: uma solução do Visual Studio é um contêiner que ajuda você a gerenciar um ou mais projetos relacionados como um grupo. A solução armazena configurações que não são específicas de 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 Flask

Aplicativos Web em Python quase sempre usam uma das muitas bibliotecas Python disponíveis para lidar com detalhes de baixo nível como o roteamento de solicitações da Web e formatação de respostas. O Visual Studio fornece muitos modelos para aplicativos Web. Você usará um desses modelos posteriormente 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ó Ambiente do Python no projeto para ver o ambiente padrão para o projeto.

    Solution explorer showing the default environment

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

  3. Insira "flask" no campo de pesquisa. Se Flask aparece abaixo da caixa de pesquisa, você pode ignorar esta etapa. Caso contrário, selecione Executar o comando: pip install flask. Aceite os prompts de privilégios de administrador e observe o andamento na janela Saída janela no Visual Studio. (Um prompt para elevação é exibido quando a pasta de pacotes do ambiente global está localizada em uma área protegida como C:\Arquivos de Programas.)

    Installing the Flask library using pip install

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

    Screenshot showing the default environment in Solution Explorer.

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

  3. Insira "flask" no campo de pesquisa. Se Flask aparece abaixo da caixa de pesquisa, você pode ignorar esta etapa. Caso contrário, selecione Executar comando: pip install flask.

    Screenshot that shows installing the Flask library using pip install.

    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 as solicitações de privilégios de administrador. Observe a janela Saída do Visual Studio para progresso.

Depois de instalada, a biblioteca é exibida no ambiente no Gerenciador de Soluções, o que significa que você pode usá-la no código Python.

Flask library installed and showing in Solution Explorer

Screenshot that shows the Flask library installed and showing in Solution Explorer.

Observação

Em vez de instalar as bibliotecas no ambiente global, os desenvolvedores geralmente criam um “ambiente virtual” no qual instalar bibliotecas para um projeto específico. Modelos do Visual Studio geralmente oferecem essa opção, conforme discutido em Início Rápido: criar um projeto de Python usando um modelo.

Pergunta: Onde posso saber mais sobre outros pacotes do Python disponíveis?

Resposta: Acesse o Índice de pacotes do Python.

Adicionar um arquivo de código

Agora você está pronto para adicionar um pouco de 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 exibida, selecione Arquivo Python vazio, nomeie-o como app.py e selecione Adicionar. O Visual Studio abre o arquivo automaticamente em uma janela do editor.

  3. Copie o código a seguir e cole-o em 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)
    
  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 exibida, selecione vazio. Para Nome, insira app.py e selecione Adicionar. O Visual Studio abre o arquivo automaticamente em uma janela do editor.

  3. Copie o código a seguir e cole-o em 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)
    

Você deve ter notado que a caixa de diálogo Adicionar>Novo Item exibe muitos outros tipos de arquivos que você pode adicionar a um projeto python, incluindo uma classe Python, um pacote Python, um teste de unidade do Python, arquivosweb.config e muito mais. Em geral, esses modelos de item são uma ótima maneira de criar arquivos rapidamente com código clichê útil.

Pergunta: Onde posso saber mais sobre o Flask?

Resposta: Consulte a documentação do Flask, começando pelo Início Rápido do Flask.

Executar o aplicativo

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

    Setting the startup file for a project in Solution Explorer

    Screenshot that shows setting the startup file for a project in Solution Explorer.

  2. Clique com o botão direito do mouse no projeto no Gerenciador de Soluções e selecione Propriedades. Selecione a guia Depurar no menu Propriedades e defina a propriedade Número da Porta como 4449. Essa configuração garante que o Visual Studio inicie um navegador localhost:4449 para corresponder aos app.run argumentos no código.

  3. Selecione Depurar>Iniciar sem Depuração ou pressione Ctrl+F5, que salva as alterações nos arquivos e executa o aplicativo.

  4. Uma janela de comando é exibida com a mensagem Em execução.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, inicie o navegador de sua escolha e navegue até 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 app.py está definido como o arquivo de inicialização.

  5. Navegue até 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 algumas outras URLs também para ver que elas mostram 404 códigos de status na janela de comando.

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

Pergunta: Qual é a diferença entre os comandos Iniciar Sem Depuração e Iniciar Depuração?

Resposta: você usa Iniciar Depuração para executar o aplicativo no contexto do depurador do Visual Studio. Com o depurador, você pode definir pontos de interrupção, examinar variáveis e percorrer o código linha por linha. Os aplicativos podem ser executados mais lentamente no depurador devido aos ganchos que possibilitam a depuração.

Iniciar sem depuração executa o aplicativo diretamente, como se você o executasse na linha de comando, sem contexto de depuração. Iniciar Sem Depuração também inicia automaticamente um navegador e navega até a URL especificada na guia Depuração das propriedades do projeto.

Próximas etapas

Parabéns por executar seu primeiro aplicativo Python no Visual Studio. Você aprendeu um pouco sobre como usar o Visual Studio como um IDE do Python!

Como as etapas seguidas neste Início Rápido são razoavelmente genéricas, você provavelmente percebeu que elas podem e devem ser automatizadas. Essa automação é a função dos modelos de projeto do Visual Studio. Confira o Início Rápido – Criar um projeto do Python usando um modelo para criar um aplicativo Web semelhante ao deste artigo, mas com menos etapas.

Para continuar com um tutorial mais completo sobre Python no Visual Studio, incluindo o uso da janela interativa, depuração, visualização de dados e trabalho com o Git, siga o Tutorial: Introdução ao Python no Visual Studio.

Para explorar mais do que o Visual Studio tem a oferecer, selecione os links abaixo.