Подключиться
Yandex Cloud Functions

Обработчик запросов функции на Python

Статья создана

Обработчик запросов — это метод, который используется для обработки каждого вызова функции на Python. При создании версии функции необходимо указать точку входа, которая состоит из имени файла и имени обработчика запросов (например, main.handler).

Примечание

В каждый момент времени один экземпляр функции обрабатывает только один запрос. Это позволяет использовать глобальные переменные без необходимости обеспечивать контроль целостности данных.

При вызове обработчика среда выполнения передает следующие аргументы:

  1. Тело запроса (параметр event):

    • Если тело запроса — JSON-документ, то оно будет преобразовано в dict c помощью метода json.loads.
    • Если функция была вызвана с параметром строки запроса integration=raw, тело HTTP-запроса передается в функцию как есть, без обработки.

  2. Контекст вызова (параметр context).

    Контекст содержит необходимую информацию о версии функции. Структура этого объекта описана в разделе Контекст вызова функции на Python.

Виды обработчика

Функция может использовать как синхронный, так и асинхронный обработчик.

Синхронный обработчик

Чтобы вернуть результат выполнения, используйте оператор return или сигнализируйте об исключении с помощью оператора raise. Синхронная функция обязана возвращать результат или завершаться исключением.

Асинхронный обработчик

Обработчик может быть асинхронной функцией async def. В этом случае вы можете использовать следующие операторы:

  • return — возвращает ответ функции.
  • raise — сообщает среде выполнения об ошибке.
  • await — отслеживает выполнение вызова асинхронных функций.

Примечание

В качестве среды исполнения асинхронных функций поддерживается только библиотека asyncio.

Подробнее о разработке с помощью async/await читайте в соответстующем разделе документации.

Примеры

Вывод структуры HTTP-запроса

Следующая функция выводит структуру запроса и контекста вызова одновременно и в журнал выполнения, и в ответ функции:

import json


def handler(event, context):
    return {
        'statusCode': 200,
        'body': json.dumps(
            {
                'event': event,
                'context': context,
            }, 
            default=vars,
        ),
    }

Пример вызова функции:

curl --data '{"hello": "world"}' -H 'Content-Type: application/json' https://functions.yandexcloud.net/d4eo2faf62**********?param=one

Результат:

{
    "context": {
        "aws_request_id": "6e8356f9-489b-4c7b-8ba6-c8cd74f25455",
        "deadline_ms": 1657713543198,
        "function_name": "d4eo2faf62**********",
        "function_version": "d4e3vrugh3**********",
        "invoked_function_arn": "d4eo2faf62**********",
        "log_group_name": "ckgjmanjlh**********",
        "log_stream_name": "d4e3vrugh3**********",
        "memory_limit_in_mb": 128,
        "request_id": "6e8356f9-489b-4c7b-8ba6-c8cd74f25455",
        "token": {
            "access_token": "<IAM-токен>",
            "expires_in": 42299,
            "token_type": "Bearer"
        }
    },
    "event": {
        "body": "{\"hello\": \"world\"}",
        "headers": {
            "Accept": "*/*",
            "Content-Length": "18",
            "Content-Type": "application/json",
            "Host": "functions.yandexcloud.net",
            "User-Agent": "curl/7.64.1",
            "X-Forwarded-For": "109.252.148.209",
            "X-Real-Remote-Address": "[109.252.148.209]:2816",
            "X-Request-Id": "6e8356f9-489b-4c7b-8ba6-c8cd74f25455",
            "X-Trace-Id": "e9fe9b05-c1aa-4fb8-94d8-a514fd6f3ff7"
        },
        "httpMethod": "POST",
        "isBase64Encoded": false,
        "multiValueHeaders": {
            "Accept": [
                "*/*"
            ],
            "Content-Length": [
                "18"
            ],
            "Content-Type": [
                "application/json"
            ],
            "Host": [
                "functions.yandexcloud.net"
            ],
            "User-Agent": [
                "curl/7.64.1"
            ],
            "X-Forwarded-For": [
                "109.252.148.209"
            ],
            "X-Real-Remote-Address": [
                "[109.252.148.209]:2816"
            ],
            "X-Request-Id": [
                "6e8356f9-489b-4c7b-8ba6-c8cd74f25455"
            ],
            "X-Trace-Id": [
                "e9fe9b05-c1aa-4fb8-94d8-a514fd6f3ff7"
            ]
        },
        "multiValueParams": {},
        "multiValueQueryStringParameters": {
            "param": [
                "one"
            ]
        },
        "params": {},
        "pathParams": {},
        "queryStringParameters": {
            "param": "one"
        },
        "requestContext": {
            "httpMethod": "POST",
            "identity": {
                "sourceIp": "109.252.148.209",
                "userAgent": "curl/7.64.1"
            },
            "requestId": "6e8356f9-489b-4c7b-8ba6-c8cd74f25455",
            "requestTime": "13/Jul/2022:11:58:59 +0000",
            "requestTimeEpoch": 1657713539
        },
        "url": ""
    }
}
В этой статье: