Guía de inicio rápido: Crea e implementa una Cloud Function de HTTP con Python

Crea e implementa una Cloud Function de HTTP con Python

En esta guía, se explica el proceso para escribir una función de Cloud Functions mediante el entorno de ejecución de Python. Existen dos tipos de funciones de Cloud Functions:

  • Una es la función de HTTP que se invoca a partir de solicitudes HTTP estándar.
  • La otra es una función controlada por eventos que se usa para manejar los eventos de la infraestructura de tu nube, como mensajes en un tema de Cloud Pub/Sub o cambios en un bucket de Cloud Storage.

En el ejemplo, se muestra cómo crear una función de HTTP simple.

Antes de comenzar

  1. Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

  2. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  3. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

  4. Habilita las API de Cloud Functions and Cloud Build.

    Habilita las API

    5.

  5. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  6. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

  7. Habilita las API de Cloud Functions and Cloud Build.

    Habilita las API

    8.
  8. Instala e inicializa gcloud CLI
  9. Instala y actualiza componentes de gcloud: 
    gcloud components update
  10. Prepara tu entorno de desarrollo.

    Ir a la guía de configuración de Python

Crea una función

  1. Crea un directorio en tu sistema local para el código de función:

    Linux o Mac OS X

    mkdir ~/helloworld
cd ~/helloworld

    Windows

    mkdir %HOMEPATH%\helloworld
cd %HOMEPATH%\helloworld

  2. Crea un archivo main.py en el directorio helloworld con el siguiente contenido:

    
import functions_framework

from markupsafe import escape
@functions_framework.http
def hello_http(request):
    """HTTP Cloud Function.
    Args:
        request (flask.Request): The request object.
        <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
    Returns:
        The response text, or any set of values that can be turned into a
        Response object using `make_response`
        <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
    """
    request_json = request.get_json(silent=True)
    request_args = request.args

    if request_json and "name" in request_json:
        name = request_json["name"]
    elif request_args and "name" in request_args:
        name = request_args["name"]
    else:
        name = "World"
    return f"Hello {escape(name)}!"

    Esta función de ejemplo toma un nombre proporcionado en la solicitud HTTP y devuelve un saludo, o “Hello World!” cuando no se proporciona ningún nombre.

Especificar dependencias

Las dependencias en Python se administran con pip y se expresan en un archivo de metadatos llamado requirements.txt. Este archivo debe estar en el mismo directorio que el archivo main.py que contiene el código de tu función.

No necesitas crear un requirements.txt para ejecutar esta muestra en particular, pero supongamos que deseas agregar tus propias dependencias. A continuación, te mostramos cómo hacerlo:

  1. Crea un archivo requirements.txt en el directorio helloworld.

  2. Agrega la dependencia de la función a tu archivo requirements.txt, por ejemplo:

    # An example requirements file, add your dependencies below
sampleproject==2.0.0

Implementa la función

Ejecuta el siguiente comando en el directorio helloworld para implementar la función con un activador HTTP:

gcloud functions deploy hello_http --runtime python312 --trigger-http --allow-unauthenticated

La marca --allow-unauthenticated te permite acceder a la función sin autenticación. Para solicitar la autenticación, omite la marca.

Prueba la función

  1. Cuando la función termine de implementarse, toma nota de la propiedad httpsTrigger.url o búscala con el siguiente comando:

    gcloud functions describe hello_http

    Se verá de la siguiente manera:

    https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http

  2. Visita esta URL en tu navegador. Deberías ver el mensaje “Hello, World!”.

    Intenta pasar un nombre en la solicitud HTTP, por ejemplo, mediante la siguiente URL:

    https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http?name=NAME

    Deberías ver el mensaje “Hello, NAME!”

Visualiza los registros

Los registros de Cloud Functions pueden verse con Google Cloud CLI y en la IU de Cloud Logging.

Usa la herramienta de línea de comandos

Para visualizar los registros de tu función con gcloud CLI, usa el comando logs read seguido del nombre de la función:

gcloud functions logs read hello_http

El resultado debe parecerse al siguiente:

LEVEL  NAME        EXECUTION_ID  TIME_UTC                 LOG
D      hello_http  pdb5ys2t022n  2019-09-18 23:29:09.791  Function execution started
D      hello_http  pdb5ys2t022n  2019-09-18 23:29:09.798  Function execution took 7 ms, finished with status code: 200

Usa el panel de Loggingg

También puedes ver los registros de Cloud Functions desde la consola de Google Cloud.