Crie uma app Python no ambiente flexível do App Engine

Crie uma app Python no ambiente flexível do App Engine

ID da região

O REGION_ID é um código abreviado que a Google atribui com base na região que seleciona quando cria a sua app. O código não corresponde a um país ou uma província, embora alguns IDs de regiões possam parecer semelhantes aos códigos de países e províncias usados frequentemente. Para apps criadas após fevereiro de 2020, REGION_ID.r está incluído nos URLs do App Engine. Para apps existentes criadas antes desta data, o ID da região é opcional no URL.

Saiba mais acerca dos IDs de regiões.

OK

Nota: se estiver a implementar um novo serviço Web Python no Google Cloud, recomendamos que comece a usar o Cloud Run.

Este início rápido demonstra como criar e implementar uma app que apresenta uma mensagem curta. Pode usar a aplicação de exemplo neste início rápido para qualquer versão suportada do Python, especificando a versão de tempo de execução e o sistema operativo no seu ficheiro app.yaml.

Antes de começar

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Install the Google Cloud CLI.

Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Install the Google Cloud CLI.

Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

1. Devido a alterações no comportamento predefinido da forma como o Cloud Build usa as contas de serviço em novos projetos e alterações à política organizacional segura por predefinição, pode ter de conceder funções adicionais à sua conta de serviço de implementação. Para mais informações sobre a concessão de funções específicas, consulte o guia de resolução de problemas.

Pré-requisitos adicionais

1. Inicialize a app do App Engine com o seu projeto e escolha a respetiva região:

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   Quando lhe for pedido, selecione a região onde quer localizar a sua aplicação do App Engine.

   Atenção: não pode alterar a região de uma app depois de a definir.

2. Instale o seguinte na sua máquina local:

   • Transfira e instale o Git.

• Execute o seguinte comando para instalar o componente gcloud que inclui a extensão do App Engine para Python:

  gcloud components install app-engine-python
  

3. Prepare o seu ambiente para o desenvolvimento em Python. Recomendamos que tenha a versão mais recente do Python, do pip e de outras ferramentas relacionadas instaladas no seu sistema. Para ver as instruções, consulte o guia de configuração do ambiente de desenvolvimento Python.

Localizações do App Engine

O App Engine é regional, o que significa que a infraestrutura que executa as suas apps está localizada numa região específica e é gerida pela Google para estar disponível de forma redundante em todas as zonas dessa região.

O cumprimento dos requisitos de latência, disponibilidade ou durabilidade são fatores principais para selecionar a região onde as suas apps são executadas. Geralmente, pode selecionar a região mais próxima dos utilizadores da sua app, mas deve considerar as localizações onde o App Engine está disponível, bem como as localizações dos outrosGoogle Cloud produtos e serviços que a sua app usa. A utilização de serviços em várias localizações pode afetar a latência da sua app, bem como os respetivos preços.

Não pode alterar a região de uma app depois de a definir.

Nota: duas localizações, denominadas europe-west e us-central nos comandos do App Engine e na Google Cloud consola, são denominadas europe-west1 e us-central1, respetivamente, noutras partes da documentação da Google.

Se já tiver criado uma aplicação do App Engine, pode ver a respetiva região através de uma das seguintes ações:

• Execute o comando gcloud app describe.

• Abra o painel de controlo do App Engine na Google Cloud consola. A região aparece junto à parte superior da página.

OK
Este início rápido demonstra a app Python 3 mais recente escrita com a framework Web Flask que pode ser implementada no App Engine. Embora este exemplo use o Flask, pode usar qualquer framework Web que satisfaça os requisitos acima. As frameworks alternativas incluem Django, Pyramid, Bottle e web.py.

Transfira a app Hello World

Criámos uma app Hello World para o App Engine para que possa rapidamente experimentar a implementação de uma app no Google Cloud.

1. Clone o repositório da app de exemplo Hello World para a sua máquina local.

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples
   

   Em alternativa, pode transferir o exemplo como um ficheiro ZIP e extraí-lo.

2. Altere para o diretório que contém o exemplo de código.

      cd python-docs-samples/appengine/flexible/hello_world
   

Execute o Hello World na sua máquina local

Para executar a app Hello World no seu computador local:

Mac OS / Linux

Nota: estas instruções descrevem como configurar um ambiente virtual no Python 3. Para apps Python 2, use o virtualenv para configurar um ambiente virtual.

1. Crie um ambiente Python isolado:

   python3 -m venv env
   source env/bin/activate

2. Se não estiver no diretório que contém o código de exemplo, navegue para o diretório que contém o código de exemplo hello_world. Em seguida, instale as dependências:

   cd YOUR_SAMPLE_CODE_DIR
   pip install -r requirements.txt

3. Execute a aplicação:

   python main.py

4. No navegador de Internet, introduza o seguinte endereço:

   http://localhost:8080

   Se estiver a usar o Cloud Shell, na barra de ferramentas, clique em Pré-visualização na Web e selecione Pré-visualizar na porta 8080.

Windows

Nota: estas instruções descrevem como configurar um ambiente virtual no Python 3. Para apps Python 2, use o virtualenv para configurar um ambiente virtual.

Use o PowerShell para executar os seus pacotes Python.

1. Localize a sua instalação do PowerShell.
2. Clique com o botão direito do rato no atalho para o PowerShell e inicie-o como administrador.
3. Crie um ambiente Python isolado.

   python -m venv env
   .\env\Scripts\activate

4. Navegue para o diretório do projeto e instale as dependências. Se não estiver no diretório que contém o código de exemplo, navegue para o diretório que contém o hello_world código de exemplo. Em seguida, instale as dependências:

   cd YOUR_SAMPLE_CODE_DIR
   pip install -r requirements.txt

5. Execute a aplicação:

   python main.py

6. No navegador de Internet, introduza o seguinte endereço:

   http://localhost:8080

A mensagem Hello World da app de exemplo é apresentada na página. Na janela de terminal, prima Ctrl+C para sair do servidor Web.

Implemente e execute o Hello World no App Engine

Para implementar a sua app no ambiente flexível do App Engine:

1. Implemente a app Hello World executando o seguinte comando a partir do diretório hello_world:

   gcloud app deploy

   Saiba mais acerca das sinalizações opcionais.

   Sinalizações de comandos gcloud comuns

   • Inclua a flag --version para especificar um ID que identifique exclusivamente essa versão da sua app. Caso contrário, é gerado um ID para si. Exemplo: --version [YOUR_VERSION_ID]
   • Inclua a flag --project para especificar um ID do projeto Google Cloud alternativo ao que inicializou como predefinição na ferramenta gcloud. Exemplo: --project [YOUR_PROJECT_ID]

   Exemplo:

   gcloud app deploy --version pre-prod-5 --project my-sample-app

   Para saber como implementar a sua app a partir da linha de comandos, consulte o artigo Testar e implementar a sua app . Para ver uma lista de todas as flags de comando, consulte a gcloud app deploy referência.

   OK

2. Inicie o navegador para ver a app em https://PROJECT_ID.REGION_ID.r.appspot.com

   gcloud app browse

   onde PROJECT_ID representa o seu Google Cloud ID do projeto.

Desta vez, a página que apresenta a mensagem Hello World é fornecida por um servidor Web em execução numa instância do App Engine.

Parabéns! Implementou a sua primeira app do App Engine no ambiente flexível do App Engine!

Se encontrou erros ao implementar a sua aplicação, consulte as sugestões de resolução de problemas.

Consulte as secções seguintes para obter informações sobre a limpeza, bem como links para possíveis passos seguintes que pode seguir.

Limpar

Para evitar incorrer em custos, pode eliminar o seu Google Cloud projeto para parar a faturação de todos os recursos usados nesse projeto.

Atenção: a eliminação de um projeto tem os seguintes efeitos:
• Tudo no projeto é eliminado. Se usou um projeto existente para as tarefas neste documento, quando o elimina, também elimina qualquer outro trabalho que tenha feito no projeto.
• Os IDs dos projetos personalizados são perdidos. Quando criou este projeto, pode ter criado um ID do projeto personalizado que quer usar no futuro. Para preservar os URLs que usam o ID do projeto, como um URL appspot.com, elimine os recursos selecionados no projeto em vez de eliminar o projeto inteiro.
1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

O que se segue?

Conheça toda a plataforma

Agora que já sabe como é desenvolver e implementar apps do App Engine, pode explorar o resto do Google Cloud. Já tem a CLI do Google Cloud instalada, o que lhe dá as ferramentas para interagir com produtos como o Cloud SQL, o Cloud Storage, o Firestore e muito mais.

Saiba mais sobre o ambiente flexível do App Engine

Seguem-se alguns tópicos para continuar a aprender sobre o App Engine:

• Uma vista geral do App Engine
• Encaminhamento de pedidos
• Processamento de pedidos
• Gerir instâncias

Revisão do código Olá, mundo

O Hello World é a app do App Engine mais simples possível, uma vez que contém apenas um serviço, tem apenas uma versão e todo o código está localizado no diretório raiz da app. Esta secção descreve detalhadamente cada um dos ficheiros da app.

main.py

A app Hello World é uma app Flask básica com um ficheiro.

from flask import Flask


app = Flask(__name__)


@app.route("/")
def hello() -> str:
    """Return a friendly HTTP greeting.

    Returns:
        A string with the words 'Hello World!'.
    """
    return "Hello World!"


if __name__ == "__main__":
    # This is used when running locally only. When deploying to Google App
    # Engine, a webserver process such as Gunicorn will serve the app.
    app.run(host="127.0.0.1", port=8080, debug=True)

app.yaml

O ficheiro app.yaml descreve a seguinte configuração para a sua app:

• Define env: flex, indicando que a sua app usa o ambiente flexível do App Engine.

• Especifica o tempo de execução usado pela app. Se excluir a definição runtime_version, o App Engine usa a versão mais recente do Python como a versão predefinida para a sua app.

• O ficheiro entrypoint indica ao App Engine como iniciar a app. Esta app usa o gunicorn para publicar a app Python como alternativa ao servidor de desenvolvimento (usado quando executado localmente). A variável $PORT é definida pelo App Engine quando inicia a app. Para mais informações sobre entrypoint, consulte Arranque da app.

Nota: esta é a forma mais simples de executar o gunicorn. No entanto, esta abordagem executa a aplicação com um único trabalhador de bloqueio, o que significa que todos os pedidos HTTP são processados em série, incluindo as verificações de estado. Na prática, isto faz com que a aplicação deixe de responder em caso de pedidos lentos. Para mais detalhes sobre como configurar o gunicorn para produção, consulte a Configuração recomendada do gunicorn

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

runtime: python
env: flex
entrypoint: gunicorn -b :$PORT main:app

runtime_config:
  operating_system: ubuntu22

# This sample incurs costs to run on the App Engine flexible environment.
# The settings below are to reduce costs during testing and are not appropriate
# for production use. For more information, see:
# https://cloud.google.com/appengine/docs/flexible/python/configuring-your-app-with-app-yaml
manual_scaling:
  instances: 1
resources:
  cpu: 1
  memory_gb: 0.5
  disk_size_gb: 10

• Para mais informações sobre como funciona o tempo de execução do Python, consulte o artigo O tempo de execução do Python.

• Para mais detalhes sobre como criar a sua app para tirar partido das versões e dos serviços, consulte Uma vista geral do App Engine.

• Para mais detalhes acerca das definições de configuração do App Engine, consulte o artigo Configurar a sua app com o ficheiro app.yaml.

requirements.txt

requirements.txt e o gestor de pacotes Python pip declaram e instalam as dependências das aplicações. O Hello World requer o Flask, uma framework Web, e o Gunicorn, um servidor WSGI.

Flask==3.0.3; python_version > '3.6'
Flask==2.3.3; python_version < '3.7'
Werkzeug==3.0.3; python_version > '3.6'
Werkzeug==2.3.8; python_version < '3.7'
gunicorn==23.0.0

requirements.txt define as bibliotecas que vão ser instaladas localmente e quando forem implementadas no App Engine.