Lambda-Funktionshandler in Python definieren

Der Lambda-Funktionshandler ist die Methode in Ihrem Funktionscode, die Ereignisse verarbeitet. Wenn Ihre Funktion aufgerufen wird, führt Lambda die Handler-Methode aus. Ihre Funktion wird so lange ausgeführt, bis der Handler eine Antwort zurückgibt, beendet wird oder ein Timeout auftritt.

Auf dieser Seite wird beschrieben, wie Sie mit Lambda-Funktionshandlern in Python arbeiten, einschließlich Benennungskonventionen, gültigen Handlersignaturen und bewährten Codemethoden. Diese Seite enthält auch ein Beispiel für eine Python-Lambda-Funktion, die Informationen über eine Bestellung aufnimmt, eine Textdateiquittung erstellt und diese Datei in einem Amazon Simple Storage Service (Amazon S3) -Bucket ablegt.

Beispiel für einen Python-Lambda-Funktionscode

Der folgende Python-Lambda-Beispielcode nimmt Informationen über eine Bestellung auf, erzeugt eine Textdateiquittung und platziert diese Datei in einem Amazon S3 S3-Bucket:

import json
import os
import logging
import boto3

# Initialize the S3 client outside of the handler
s3_client = boto3.client('s3')

# Initialize the logger
logger = logging.getLogger()
logger.setLevel("INFO")

def upload_receipt_to_s3(bucket_name, key, receipt_content):
    """Helper function to upload receipt to S3"""
    
    try:
        s3_client.put_object(
            Bucket=bucket_name,
            Key=key,
            Body=receipt_content
        )
    except Exception as e:
        logger.error(f"Failed to upload receipt to S3: {str(e)}")
        raise

def lambda_handler(event, context):
    """
    Main Lambda handler function
    Parameters:
        event: Dict containing the Lambda function event data
        context: Lambda runtime context
    Returns:
        Dict containing status message
    """
    try:
        # Parse the input event
        order_id = event['Order_id']
        amount = event['Amount']
        item = event['Item']
        
        # Access environment variables
        bucket_name = os.environ.get('RECEIPT_BUCKET')
        if not bucket_name:
            raise ValueError("Missing required environment variable RECEIPT_BUCKET")

        # Create the receipt content and key destination
        receipt_content = (
            f"OrderID: {order_id}\n"
            f"Amount: ${amount}\n"
            f"Item: {item}"
        )
        key = f"receipts/{order_id}.txt"

        # Upload the receipt to S3
        upload_receipt_to_s3(bucket_name, key, receipt_content)

        logger.info(f"Successfully processed order {order_id} and stored receipt in S3 bucket {bucket_name}")
        
        return {
            "statusCode": 200,
            "message": "Receipt processed successfully"
        }

    except Exception as e:
        logger.error(f"Error processing order: {str(e)}")
        raise

Diese -Datei enthält die folgenden Abschnitte des Codes:

Namenskonventionen für Handler

Der Name des Funktionshandlers, der zum Zeitpunkt der Erstellung einer Lambda-Funktion definiert wurde, ist abgeleitet von:

Wenn die Datei im obigen Beispiel benannt istlambda_function.py, würde der Handler als lambda_function.lambda_handler angegeben werden. Dies ist der Standard-Handlername für Funktionen, die Sie mit der Lambda-Konsole erstellen.

Wenn Sie eine Funktion in der Konsole mit einem anderen Dateinamen oder Funktionshandlernamen erstellen, müssen Sie den Standardhandlernamen bearbeiten.

Verwenden des Lambda-Ereignisobjekts

Wenn Lambda Ihre Funktion aufruft, übergibt es ein Ereignisobjektargument an den Funktionshandler. JSON-Objekte sind das gängigste Ereignisformat für Lambda-Funktionen. Im Codebeispiel im vorherigen Abschnitt erwartet die Funktion eine Eingabe im folgenden Format:

{
    "Order_id": "12345",
    "Amount": 199.99,
    "Item": "Wireless Headphones"
}

Wenn Ihre Funktion von einer anderen aufgerufen wird AWS-Service, ist das Eingabeereignis ebenfalls ein JSON-Objekt. Das genaue Format des Ereignisobjekts hängt von dem Dienst ab, der Ihre Funktion aufruft. Das Ereignisformat für einen bestimmten Dienst finden Sie auf der entsprechenden Seite im Lambda mit Ereignissen aus anderen Diensten aufrufen AWS Kapitel.

Wenn das Eingabeereignis die Form eines JSON-Objekts hat, konvertiert die Lambda-Laufzeit das Objekt in ein Python-Wörterbuch. Um Variablen in Ihrem Code Werte im Eingabe-JSON zuzuweisen, verwenden Sie die standardmäßigen Python-Wörterbuchmethoden, wie im Beispielcode dargestellt.

Sie können Daten auch als JSON-Array oder als einen der anderen gültigen JSON-Datentypen an Ihre Funktion übergeben. Die folgende Tabelle definiert, wie die Python-Laufzeit diese JSON-Typen konvertiert.

Zugreifen auf und Verwenden des Lambda-Kontextobjekts

Das Lambda-Kontextobjekt enthält Informationen über den Funktionsaufruf und die Ausführungsumgebung. Lambda übergibt das Kontextobjekt automatisch an Ihre Funktion, wenn es aufgerufen wird. Mit dem Kontextobjekt können Sie zu Überwachungszwecken Informationen über den Aufruf Ihrer Funktion ausgeben.

Das Kontextobjekt ist eine Python-Klasse, die im Lambda-Runtime-Interface-Client definiert ist. Um den Wert einer der Eigenschaften des Kontextobjekts zurückzugeben, verwenden Sie die entsprechende Methode für das Kontextobjekt. Der folgende Codeausschnitt weist beispielsweise den Wert der aws_request_id Eigenschaft (den Bezeichner für die Aufrufanforderung) einer Variablen mit dem Namen zu. request

request = context.aws_request_id

Weitere Informationen zur Verwendung des Lambda-Kontextobjekts und eine vollständige Liste der verfügbaren Methoden und Eigenschaften finden Sie unterVerwenden des Lambda-Kontextobjekts zum Abrufen von Python-Funktionsinformationen.

Gültige Handlersignaturen für Python-Handler

Wenn Sie Ihre Handler-Funktion in Python definieren, muss die Funktion zwei Argumente annehmen. Das erste dieser Argumente ist das Lambda-Ereignisobjekt und das zweite ist das Lambda-Kontextobjekt. Konventionell haben diese Eingabeargumente normalerweise den Namen event undcontext, aber Sie können ihnen beliebige Namen geben. Wenn Sie Ihre Handler-Funktion mit einem einzigen Eingabeargument deklarieren, gibt Lambda einen Fehler aus, wenn es versucht, Ihre Funktion auszuführen. Die gebräuchlichste Methode, eine Handler-Funktion in Python zu deklarieren, ist wie folgt:

def lambda_handler(event, context):

Sie können auch Python-Typhinweise in Ihrer Funktionsdeklaration verwenden, wie im folgenden Beispiel gezeigt:

from typing import Dict, Any
      
def lambda_handler(event: Dict[str, Any], context: Any) -> Dict[str, Any]:

Um bestimmte AWS Typisierungen für Ereignisse zu verwenden, die von anderen generiert wurden, AWS-Services und für das Kontextobjekt, fügen Sie das aws-lambda-typing Paket dem Bereitstellungspaket Ihrer Funktion hinzu. Sie können diese Bibliothek in Ihrer Entwicklungsumgebung installieren, indem Sie den Befehl ausführenpip install aws-lambda-typing. Der folgende Codeausschnitt zeigt, wie Sie AWS-spezifische Typhinweise verwenden. In diesem Beispiel ist das erwartete Ereignis ein Amazon S3 S3-Ereignis.

from aws_lambda_typing.events import S3Event
from aws_lambda_typing.context import Context
from typing import Dict, Any

def lambda_handler(event: S3Event, context: Context) -> Dict[str, Any]:

Sie können den async Python-Funktionstyp nicht für Ihre Handler-Funktion verwenden.

Rückgabe eines Wertes

Optional kann ein Handler einen Wert zurückgeben, der über JSON serialisierbar sein muss. Zu den gängigen Rückgabetypen gehören dictlist,,str, intfloat, und. bool

Was mit dem zurückgegebenen Wert passiert, hängt von der Aufrufart und dem Service ab, der die Funktion aufgerufen hat. Zum Beispiel:

Im Beispielcode gibt der Handler das folgende Python-Wörterbuch zurück:

{
  "statusCode": 200,
  "message": "Receipt processed successfully"
}

Die Lambda-Laufzeit serialisiert dieses Wörterbuch und gibt es als JSON-Zeichenfolge an den Client zurück, der die Funktion aufgerufen hat.

Verwenden Sie das in Ihrem Handler AWS SDK for Python (Boto3)

Oft verwenden Sie Lambda-Funktionen, um mit anderen Ressourcen AWS-Services zu interagieren. Die einfachste Art, eine Schnittstelle zu diesen Ressourcen herzustellen, ist die AWS SDK for Python (Boto3) Verwendung von. Alle unterstützten Lambda-Python-Laufzeiten enthalten eine Version des SDK für Python. Wir empfehlen jedoch dringend, das SDK in das Bereitstellungspaket Ihrer Funktion aufzunehmen, falls Ihr Code es verwenden muss. Wenn Sie das SDK in Ihr Bereitstellungspaket aufnehmen, haben Sie die volle Kontrolle über Ihre Abhängigkeiten und verringern das Risiko von Versionsfehlern bei anderen Bibliotheken. Weitere Informationen dazu finden Sie unter Laufzeitabhängigkeiten in Python und Abwärtskompatibilität.

Um das SDK für Python in Ihrer Lambda-Funktion zu verwenden, fügen Sie dem Importblock am Anfang Ihres Funktionscodes die folgende Anweisung hinzu:

import boto3

Verwenden Sie den pip install Befehl, um die boto3 Bibliothek zum Bereitstellungspaket Ihrer Funktion hinzuzufügen. Ausführliche Anweisungen zum Hinzufügen von Abhängigkeiten zu einem ZIP-Bereitstellungspaket finden Sie unterZIP-Bereitstellungspakets mit Abhängigkeiten erstellen. Weitere Informationen zum Hinzufügen von Abhängigkeiten zu Lambda-Funktionen, die als Container-Images bereitgestellt werden, finden Sie unter Erstellen eines Images aus einem Base Image oderErstellen eines Images aus einem alternativen Basis-Image.

Bei boto3 der Verwendung in Ihrem Code müssen Sie keine Anmeldeinformationen angeben, um einen Client zu initialisieren. Im Beispielcode verwenden wir beispielsweise die folgende Codezeile, um einen Amazon S3 S3-Client zu initialisieren:

# Initialize the S3 client outside of the handler
s3_client = boto3.client('s3')

Mit Python erstellt Lambda automatisch Umgebungsvariablen mit Anmeldeinformationen. Das boto3 SDK überprüft die Umgebungsvariablen Ihrer Funktion bei der Initialisierung auf diese Anmeldeinformationen.

Zugriff auf Umgebungsvariablen

In Ihrem Handler-Code können Sie mithilfe der os.environ.get Methode auf Umgebungsvariablen verweisen. Im Beispielcode verweisen wir mit der folgenden Codezeile auf die definierte RECEIPT_BUCKET Umgebungsvariable:

# Access environment variables
bucket_name = os.environ.get('RECEIPT_BUCKET')

Vergessen Sie nicht, am Anfang Ihres Codes eine import os Anweisung in den Importblock aufzunehmen.

Bewährte Codemethoden für Python-Lambda-Funktionen

Halten Sie sich an die Richtlinien in der folgenden Liste, um beim Erstellen Ihrer Lambda-Funktionen die besten Codierungspraktiken anzuwenden: