El entorno de ejecución de Python

Nota: Algunos entornos de ejecución de Python alcanzaron el fin de la asistencia. No puedes volver a implementar versiones que usan entornos de ejecución después de la fecha de finalización de la asistencia. Te recomendamos actualizar la app para usar la versión más reciente de Python.

El entorno de ejecución de Python es la pila de software encargada de instalar el código y las dependencias de tu aplicación y, luego, ejecutarla en el entorno flexible.

Versiones de Python

Python 3.12 usa paquetes de compilación. Para obtener la lista completa de las versiones de Python compatibles y sus versiones correspondientes de Ubuntu, consulta el programa de asistencia del entorno de ejecución.

Para usar una versión de Python compatible, debes hacer lo siguiente:

• Incluye la configuración runtime_config y operating_system en el archivo app.yaml para especificar un sistema operativo.

• Instala gcloudla versión 420.0.0 o posterior de la CLI de . Puedes actualizar las herramientas de la CLI si ejecutas el comando gcloud components update. Para ver la versión instalada, ejecuta el comando gcloud version.

• Opcional: Puedes especificar una versión del entorno de ejecución si incluyes la configuración runtime_version en tu archivo app.yaml. De forma predeterminada, se usa la última versión de Python si no se especifica la configuración runtime_version.

Ejemplos

• Para especificar Python 3.12 en Ubuntu 22, haz lo siguiente:

  runtime: python
  env: flex
  entrypoint: gunicorn -b :$PORT main:app
  
  runtime_config:
      operating_system: "ubuntu22"
      runtime_version: "3.12"
  

• Para especificar la última versión de Python compatible en Ubuntu 22, sigue estos pasos:

    runtime: python
    env: flex
    entrypoint: gunicorn -b :$PORT main:app
  
    runtime_config:
        operating_system: "ubuntu22"
  

See the app.yaml reference page for more information.

Versiones anteriores del entorno de ejecución

Advertencia: La versión 3.7 y las anteriores de Python alcanzaron el final de la asistencia. App Engine te impide implementar tus aplicaciones con entornos de ejecución que ya no son compatibles. Te recomendamos que migres la app para usar una versión compatible de Python o que uses un entorno de ejecución personalizado.

Para las versiones 3.7 y anteriores de Python, debes especificar una versión con la configuración de runtime_config y python_version en el archivo app.yaml de tu aplicación.

Ejemplo

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

runtime_config:
    python_version: 3.7

En las versiones de Python 3.7 y anteriores, el intérprete predeterminado es Python 2.7.12 si se omite runtime_config o python_version. Por ejemplo, puedes usar el entorno de ejecución predeterminado si especificas runtime: python en tu archivo app.yaml:

runtime: python
env: flex

Consulta la página de referencia de app.yaml para obtener más información.

Los intérpretes que se implementan para cada configuración se muestran en la siguiente tabla:

Configuración python_version	Intérprete implementado	ID de entorno de ejecución	Ejemplo app.yaml
2 (predeterminada)	2.7.12	python2	runtime_config:  python_version: 2
3.4	3.4.8	python34	runtime_config:  python_version: 3.4
3.5	3.5.9	python35	runtime_config:  python_version: 3.5
3 o 3.6	3.6.10	python36	runtime_config:  python_version: 3
3.7	3.7.9	python37	runtime_config:  python_version: 3.7

Nota: A medida que se lanzan nuevas versiones secundarias de Python 3, puede haber un período en el que usar el parámetro de configuración genérico de 3 apunte a la versión secundaria anterior. Las notas de la versión de la gcloud CLI indicarán cuándo 3 apuntará al número de versión secundaria más reciente.

Compatibilidad con otros entornos de ejecución de Python

Si necesitas usar una versión de Python que no es compatible, puedes crear un entorno de ejecución personalizado y seleccionar una imagen base válida con la versión de Python que necesites.

Para las imágenes base proporcionadas por Google o las imágenes base de Docker para Python, consulta Compila entornos de ejecución personalizados.

Si deseas investigar más a fondo el alojamiento de apps de App Engine en contenedores para Cloud Run, consulta la guía de migración.

Dependencias

El entorno de ejecución busca un archivo requirements.txt en el directorio fuente de tu aplicación y usa pip para instalar cualquier dependencia antes de iniciar la aplicación. Para obtener más información acerca de cómo declarar y administrar los paquetes, consulta Cómo usar las bibliotecas de Python.

Si tu aplicación requiere dependencias privadas, debes usar un entorno de ejecución personalizado basado en el entorno de ejecución de Python para instalar los paquetes adecuados.

Inicio de la aplicación

El entorno de ejecución inicia tu aplicación mediante el entrypoint definido en tu archivo app.yaml. El punto de entrada debería iniciar un proceso que responda a solicitudes HTTP en el puerto definido por la variable de entorno PORT.

La mayoría de las aplicaciones web usan un servidor WSGI, como Gunicorn, uWSGI o Waitress.

Antes de que puedas usar uno de estos servidores, debes agregarlos como una dependencia en el archivo requirements.txt de tu aplicación. Si usas gunicorn para tu aplicación de Flask, asegúrate de que la versión de Python de tu aplicación sea compatible con gunicorn.

El entorno de ejecución garantiza que todas las dependencias estén instaladas antes de que se llame al entrypoint.

Flask==2.0.2
gunicorn==20.1.0

Este es un ejemplo de un entrypoint que usa gunicorn para una aplicación Flask:

entrypoint: gunicorn -b :$PORT main:app

Este es un ejemplo de un entrypoint que usa gunicorn para una aplicación Django:

entrypoint: gunicorn -b :$PORT mydjangoapp:wsgi

Nota: La función exec de bash ejecutará el comando de punto de entrada. Las variables de shell, como $PORT, se reemplazarán normalmente, pero la sintaxis de shell, como if, for y while, que está incorporada en el comando de entrypoint no funcionará.

Gunicorn es el servidor WSGI recomendado, pero es completamente posible utilizar cualquier otro servidor WSGI. Por ejemplo, el siguiente es un entrypoint que usa uWSGI con Flask:

entrypoint: uwsgi --http :$PORT --wsgi-file main.py --callable app

Para las aplicaciones que pueden controlar solicitudes sin un servidor WSGI, puedes simplemente ejecutar una secuencia de comandos de Python:

entrypoint: python main.py

Configuración recomendada para Gunicorn

Los ejemplos básicos de entrypoint antes mencionados pretenden ser puntos de partida y pueden funcionar para tus aplicaciones web. Sin embargo, la mayoría de las aplicaciones necesitarán configurar aún más el servidor WSGI. En lugar de especificar todas las configuraciones en el entrypoint, crea un archivo gunicorn.conf.py en el directorio raíz de tu proyecto, donde se encuentra tu archivo app.yaml, y especifícalo en el entrypoint:

entrypoint: gunicorn -c gunicorn.conf.py -b :$PORT main:app

Puedes leer sobre todos los valores de configuración de Gunicorn en la documentación.

Trabajadores

Gunicorn utiliza trabajadores para controlar las solicitudes. De manera predeterminada, Gunicorn utiliza trabajadores de sincronización. Esta clase de trabajadores es compatible con todas las aplicaciones web, pero cada trabajador puede controlar solamente una solicitud a la vez. De manera predeterminada, gunicorn solo usa uno de estos trabajadores. A menudo, esto puede hacer que no se utilicen correctamente tus instancias y aumentar la latencia en aplicaciones con cargas importantes.

Te recomendamos configurar una cantidad de trabajadores equivalente a de 2 a 4 veces la cantidad de núcleos de CPU para tu instancia, más uno. Puedes especificar esto en gunicorn.conf.py de la siguiente manera:

import multiprocessing

workers = multiprocessing.cpu_count() * 2 + 1

Además, algunas aplicaciones web que están mayormente vinculadas a la E/S pueden registrar una mejora en el rendimiento si utilizan una clase diferente de trabajadores. Si tu clase de trabajador requiere dependencias adicionales, como gevent o tornado, esas dependencias deberán declararse en el requirements.txt de tu aplicación.

Proxies HTTPS y de reenvío

App Engine finaliza la conexión HTTPS en el balanceador de cargas y reenvía la solicitud a la aplicación. La mayoría de las aplicaciones no necesitan saber si la solicitud se envió a través de HTTPS o no, pero en aquellas que se necesita esta información, se debe configurar Gunicorn para que confíe en el proxy de App Engine en su gunicorn.conf.py:

forwarded_allow_ips = '*'
secure_scheme_headers = {'X-FORWARDED-PROTO': 'https'}

Gunicorn ahora garantizará que wsgi.url_scheme sea 'https', que la mayoría de los frameworks usarán como un indicador de la solicitud. Si tu servidor o framework WSGI no es compatible, verifica el valor del encabezado X-Forwarded-Proto de forma manual.

Algunas aplicaciones también necesitan verificar la dirección IP del usuario. Esta está disponible en el encabezado estándar X-Forwarded-For.

Ten en cuenta que la configuración secure_scheme_headers en gunicorn.conf.py debe estar en mayúscula, como X-FORWARDED-PROTO, pero los encabezados que tu código puede leer en mayúsculas y minúsculas, como X-Forwarded-Proto.

Extiende el tiempo de ejecución

El entorno de ejecución de Python del entorno flexible se puede usar para crear un entorno de ejecución personalizado. Consulta Personaliza Python para obtener más información.

Variables de entorno

Las siguientes variables del entorno se configuran mediante el entorno de ejecución:

Variable de entorno	Descripción
GAE_INSTANCE	El nombre de la instancia actual.
GAE_MEMORY_MB	La cantidad de memoria disponible para el proceso de la aplicación.
GAE_SERVICE	El nombre del servicio especificado en el archivo app.yaml de la aplicación; si no se especifica ningún nombre, se configura como default.
GAE_VERSION	La etiqueta de versión de la aplicación actual.
GOOGLE_CLOUD_PROJECT	El ID del proyecto asociado con la aplicación, que se puede ver en la consola de Google Cloud.
PORT	El puerto que recibirá las solicitudes HTTP.

Puedes establecer variables de entorno adicionales en el archivo app.yaml.

Servidor de metadatos

Cada instancia de la aplicación puede usar el servidor de metadatos de Compute Engine para consultar información acerca de la instancia, incluidos el nombre del host, la dirección IP externa, el ID de la instancia, los metadatos personalizados y la información de la cuenta de servicio. App Engine no permite establecer metadatos personalizados para cada instancia; sin embargo, puedes establecer metadatos personalizados de todo el proyecto y leerlos desde las instancias de App Engine y Compute Engine.

Esta función de ejemplo usa el servidor de metadatos para obtener la dirección IP externa de la instancia:

METADATA_NETWORK_INTERFACE_URL = (
    "http://metadata/computeMetadata/v1/instance/network-interfaces/0/"
    "access-configs/0/external-ip"
)


def get_external_ip():
    """Gets the instance's external IP address from the Compute Engine metadata
    server.

    If the metadata server is unavailable, it assumes that the application is running locally.

    Returns:
        The instance's external IP address, or the string 'localhost' if the IP address
        is not available.
    """
    try:
        r = requests.get(
            METADATA_NETWORK_INTERFACE_URL,
            headers={"Metadata-Flavor": "Google"},
            timeout=2,
        )
        return r.text
    except requests.RequestException:
        logging.info("Metadata server could not be reached, assuming local.")
        return "localhost"