El entorno de ejecución de Python

Descripción general

El entorno de ejecución de Python es la pila de software encargada de instalar el código de tu aplicación y sus dependencias, así como de ejecutar la aplicación. El entorno de ejecución se declara en app.yaml como runtime: python:

runtime: python
env: flex

Los entornos de ejecución en el entorno flexible se compilan con Docker. El entorno de ejecución de Python se basa en Ubuntu 18.04 según la secuencia de comandos de compilación. Esta secuencia de comandos, junto con el código fuente para todas las compilaciones de entorno de ejecución de Python, están disponibles de forma pública en GitHub.

Intérprete

Puedes especificar si deseas usar Python 2 o Python 3 en el archivo app.yaml de tu aplicación mediante la directiva runtime_config junto con el parámetro de configuración python_version:

runtime: python
env: flex

runtime_config:
    python_version: 3

El intérprete predeterminado es Python 2.7.12 si se omiten runtime_config o python_version. Los intérpretes que se implementan para cada configuración python_version se muestran en la siguiente tabla:

Configuración python_version Intérprete implementado
2 (predeterminada) 2.7.12
3.4 3.4.8
3.5 3.5.9
3 o 3.6 3.6.10
3.7 3.7.9

Los únicos valores admitidos para python_version son 2, 3, 3.4, 3.5, 3.6 y 3.7, y se especifican de forma pública en esta secuencia de comandos de compilación. Si la versión de Python deseada no se enumera anteriormente, aquí hay varias opciones:

  1. Entorno flexible de App Engine: Crea un entorno de ejecución personalizado y selecciona una imagen base válida con la versión de Python que necesites.
  2. Entorno estándar de App Engine: Admite Python 3.7, 3.8 y 3.9.
  3. Cloud Functions: Son compatibles Python 3.7, 3.8 y 3.9.
  4. Cloud Run: Aloja tu aplicación en un contenedor según la imagen de contenedor de la versión de Python que necesitas (consulta la Guía de inicio rápido de Python). Como las imágenes de Python 3.10 ya están disponibles, puedes implementar esa versión hoy mismo.

Para el entorno flexible de App Engine o Cloud Run, consulta Compila entornos de ejecución personalizados a fin de obtener imágenes base proporcionadas por Google o imágenes base de Docker para Python para imágenes de Python disponibles actualmente, incluida la información de imágenes de Python 2.

Si deseas investigar más a fondo el alojamiento de apps de App Engine en contenedores para Cloud Run, consulta el codelab y el contenido de video que abarcan el alojamiento en contenedores con Docker o sin Docker. Ten en cuenta que, por el momento, este contenido solo abarca el entorno estándar de App Engine para las migraciones de Cloud Run.

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.

Usar bibliotecas C con Python

Para habilitar el uso de paquetes de Python que requieren extensiones C, los encabezados de la versión de Python actual y los siguientes paquetes de Ubuntu vienen preinstalados en el sistema:

Estos paquetes permiten la instalación de las bibliotecas más populares de Python. Si la aplicación requiere otras dependencias del nivel del sistema operativo, deberás usar un entorno de ejecución personalizado basado en este entorno de ejecución para instalar los paquetes adecuados.

Inicio de la aplicación

El entorno de ejecución inicia tu aplicación mediante el entrypoint definido en 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. 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

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

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 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 del 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 Google Cloud Console.
PORT El puerto que recibirá las solicitudes HTTP.

Puedes definir variables de entorno adicionales con 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.
    """
    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'