Notice: Over the next few months, we're reorganizing the App Engine documentation site to make it easier to find content and better align with the rest of Google Cloud products. The same content will be available, but the navigation will now match the rest of the Cloud products. If you have feedback or questions as you navigate the site, click Send Feedback.

The Python runtime

Stay organized with collections Save and categorize content based on your preferences.

Overview

The Python runtime is the software stack responsible for installing your application code and dependencies, and then running that application in the flexible environment.

The supported Python versions are: 2, 3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, and 3.11.

  • Version 3.8 and later are built using buildpacks which enables you to choose an operating system. To use these new runtimes, you must specify additional settings in your app.yaml file.

  • Version 3.7 and earlier are built using Docker and are based on Ubuntu 16.04.

Interpreter

New runtime versions

For Python runtime version 3.8 and later, you must include the runtime_config and operating_system settings in your app.yaml to specify an operating system.

To use the new runtimes, you must install gcloud CLI version 420.0.0 or later. You can update your CLI tooling by running the gcloud components update command. To view your installed version, you can run the gcloud version command.

The following Ubuntu versions are supported for the specified Python runtimes:

  • Ubuntu 18:

    • Python 3.8
    • Python 3.9
    • Python 3.10
    • Python 3.11

  • Ubuntu 22 (recommended):

    • Python 3.10
    • Python 3.11

Optional: You can specify a runtime version by including the runtime_version setting in your app.yaml. By default, the latest Python version is used if the runtime_version setting is not specified.

Examples

  • Specifying Python version 3.8:

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

runtime_config:
    operating_system: "ubuntu18"
    runtime_version: "3.8"

  • Specifying the latest supported Python 3 version on Ubuntu 22:

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

  runtime_config:
      operating_system: "ubuntu22"

See the app.yaml reference page for more information.

The interpreters that are deployed for each version setting are shown in the following table:

runtime_version setting Deployed interpreter Runtime ID app.yaml example
3.8 3.8 python38 runtime_config:
 operating_system: "ubuntu18"
 runtime_version: "3.8"
3.9 3.9 python39 runtime_config:
 operating_system: "ubuntu18"
 runtime_version: "3.9"
3.10 3.10 python310 runtime_config:
 operating_system: "ubuntu22"
 runtime_version: "3.10"
3.11 (default) 3.11 python311 runtime_config:
 operating_system: "ubuntu22"
 runtime_version: "3.11"

Previous runtime versions

For Python version 3.7 and earlier, you specify a version using the python_version and runtime_config settings in your application's app.yaml.

Example

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

runtime_config:
    python_version: 3.7

For Python runtime versions 3.7 and earlier, the default interpreter is Python 2.7.12 if runtime_config or python_version are omitted. For example, you can use the default runtime by specifying runtime: python in your app.yaml:

runtime: python
env: flex

See the app.yaml reference page for more information.

The interpreters that are deployed for each version setting are shown in the following table:

python_version setting Deployed interpreter Runtime ID app.yaml example
2 (default) 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 or 3.6 3.6.10 python36 runtime_config:
 python_version: 3
3.7 3.7.9 python37 runtime_config:
 python_version: 3.7

Other Python runtime support

If the desired Python version is not listed, there are several options:

  1. App Engine flexible environment: Create a custom runtime and select a valid base image with the Python version you need.
  2. App Engine standard environment: Python 3.7, 3.8, 3.9, 3.10, and 3.11 are supported.
  3. Cloud Functions: Python 3.7, 3.8, 3.9, and 3.10 are supported.
  4. Cloud Run: Containerize your app based on a container image for the Python version you need (see its Python Quickstart). As Python 3.10 images are already available, you can deploy that version today.

For the App Engine flexible environment or Cloud Run, see Building custom runtimes for Google-supplied base images or Docker Python base images for currently-available Python images, including Python 2 image information.

To further investigate containerizing App Engine apps for Cloud Run, see the codelab and video content covering containerization with Docker or without Docker. Note this content currently only covers App Engine standard environment to Cloud Run migrations.

Dependencies

The runtime looks for a requirements.txt file in your application's source directory and uses pip to install any dependencies before starting your application. For more information on declaring and managing packages, see Using Python Libraries.

If your app requires private dependencies, you need to use a custom runtime based on the Python runtime to install the appropriate packages.

Using C libraries with Python

To enable the use of Python packages that require C extensions, the headers for the current Python version and the following Ubuntu packages are pre-installed on the system:

These packages allow the installation of most popular Python libraries. If your application requires additional operating-system level dependencies, you will need to use a custom runtime based on this runtime to install the appropriate packages.

Application startup

The runtime starts your application using the entrypoint defined in app.yaml. The entrypoint should start a process that responds to HTTP requests on the port defined by the environment variable PORT.

Most web applications use a WSGI server such as Gunicorn, uWSGI or Waitress.

Before you can use one of these servers, you must add them as a dependency in your application's requirements.txt. If you use gunicorn for your Flask application, ensure that your application's Python version is compatible with gunicorn.

The runtime ensures that all dependencies are installed before your entrypoint is called.

Flask==2.0.2
gunicorn==20.1.0

An example entrypoint using gunicorn for a Flask application:

entrypoint: gunicorn -b :$PORT main:app

An example entrypoint using gunicorn for a Django application:

entrypoint: gunicorn -b :$PORT mydjangoapp:wsgi

Gunicorn is the recommended WSGI server, but it's completely possible to use any other WSGI server. For example, here is an entrypoint that uses uWSGI with Flask:

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

For applications that can handle requests without a WSGI server, you can just execute a Python script:

entrypoint: python main.py

The basic entrypoint examples shown above are intended to be starting points and may work for your web applications. Most applications, however, will need to further configure the WSGI server. Instead of specifying all of the settings on the entrypoint, create a gunicorn.conf.py file in your project root directory, where your app.yaml is located, and specify it in your entrypoint:

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

You can read about all of Gunicorn's configuration values in its documentation.

Workers

Gunicorn uses workers to handle requests. By default, Gunicorn uses sync workers. This worker class is compatible with all web applications, but each worker can only handle one request at a time. By default, gunicorn only uses one of these workers. This can often cause your instances to be underutilized and increase latency in applications under high load.

We recommend setting the number of workers to 2-4 times the number of CPU cores for your instance plus one. You can specify this in gunicorn.conf.py as:

import multiprocessing

workers = multiprocessing.cpu_count() * 2 + 1

Additionally, some web applications that are mostly I/O bound can see a performance improvement by using a different worker class. If your worker class requires additional dependencies such as gevent or tornado, those dependencies will need to be declared in your application's requirements.txt.

HTTPS and forwarding proxies

App Engine terminates the HTTPS connection at the load balancer and forwards the request to your application. Most applications do not need to know if the request was sent over HTTPS or not, but applications that do need this information should configure Gunicorn to trust the App Engine proxy in their gunicorn.conf.py:

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

Gunicorn will now ensure that the wsgi.url_scheme to 'https', which most web frameworks will use as indication of the request is secure. If your WSGI server or framework doesn't support this, just check the value of the X-Forwarded-Proto header manually.

Some applications also need to ascertain the user's IP address. This is available in the X-Forwarded-For header.

Note that the secure_scheme_headers setting in gunicorn.conf.py should be upper case, like X-FORWARDED-PROTO, but the headers that your code can read will be in mixed case, like X-Forwarded-Proto.

Extending the runtime

The flexible environment Python runtime can be used to create a custom runtime. See Customizing the Python for more information.

Environment variables

The following environment variables are set by the runtime environment:

Environment Variable Description
GAE_INSTANCE The name of the current instance.
GAE_MEMORY_MB The amount of memory available to the application process.
GAE_SERVICE The service name specified in your application's app.yaml file, or if no service name is specified, it is set to default.
GAE_VERSION The version label of the current application.
GOOGLE_CLOUD_PROJECT The Project ID associated with your application, which is visible in the Google Cloud console
PORT The port that will receive HTTP requests.

You can set additional environment variables with app.yaml.

Metadata server

Each instance of your application can use the Compute Engine metadata server to query information about the instance, including its host name, external IP address, instance ID, custom metadata, and service account information. App Engine does not allow you to set custom metadata for each instance, but you can set project-wide custom metadata and read it from your App Engine and Compute Engine instances.

This example function uses the metadata server to get the external IP address of the instance:

appengine/flexible_python37_and_earlier/metadata/main.py 
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'