Tentukan penangan fungsi Lambda dengan Python

Handler fungsi Lambda Anda adalah metode dalam kode fungsi Anda yang memproses peristiwa. Saat fungsi Anda diaktifkan, Lambda menjalankan metode handler. Fungsi Anda berjalan sampai handler mengembalikan respons, keluar, atau waktu habis.

Halaman ini menjelaskan cara bekerja dengan penangan fungsi Lambda dengan Python, termasuk konvensi penamaan, tanda tangan handler yang valid, dan praktik terbaik kode. Halaman ini juga menyertakan contoh fungsi Python Lambda yang mengambil informasi tentang pesanan, menghasilkan tanda terima file teks, dan menempatkan file ini di bucket Amazon Simple Storage Service (Amazon S3).

Contoh kode fungsi Python Lambda

Contoh kode fungsi Python Lambda berikut mengambil informasi tentang pesanan, menghasilkan tanda terima file teks, dan menempatkan file ini di bucket Amazon S3:

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

File ini berisi bagian kode berikut:

Konvensi penamaan handler

Nama fungsi handler yang ditentukan pada saat Anda membuat fungsi Lambda berasal dari:

Dalam contoh di atas, jika file bernamalambda_function.py, handler akan ditentukan sebagailambda_function.lambda_handler. Ini adalah nama handler default yang diberikan untuk fungsi yang Anda buat menggunakan konsol Lambda.

Jika Anda membuat fungsi di konsol menggunakan nama file atau nama pengendali fungsi yang berbeda, Anda harus mengedit nama handler default.

Menggunakan objek acara Lambda

Ketika Lambda memanggil fungsi Anda, ia meneruskan argumen objek peristiwa ke penangan fungsi. Objek JSON adalah format acara yang paling umum untuk fungsi Lambda. Dalam contoh kode di bagian sebelumnya, fungsi mengharapkan input dalam format berikut:

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

Jika fungsi Anda dipanggil oleh yang lain Layanan AWS, peristiwa input juga merupakan objek JSON. Format yang tepat dari objek peristiwa tergantung pada layanan yang menjalankan fungsi Anda. Untuk melihat format acara untuk layanan tertentu, lihat halaman yang sesuai di bagian Memanggil Lambda dengan acara dari layanan lain AWS ini.

Jika peristiwa input dalam bentuk objek JSON, runtime Lambda mengubah objek ke kamus Python. Untuk menetapkan nilai dalam input JSON ke variabel dalam kode Anda, gunakan metode kamus Python standar seperti yang diilustrasikan dalam kode contoh.

Anda juga dapat meneruskan data ke dalam fungsi Anda sebagai array JSON, atau sebagai salah satu tipe data JSON valid lainnya. Tabel berikut mendefinisikan bagaimana runtime Python mengkonversi jenis JSON ini.

Mengakses dan menggunakan objek konteks Lambda

Objek konteks Lambda berisi informasi tentang fungsi pemanggilan dan lingkungan eksekusi. Lambda meneruskan objek konteks ke fungsi Anda secara otomatis saat dipanggil. Anda dapat menggunakan objek konteks untuk menampilkan informasi tentang pemanggilan fungsi Anda untuk tujuan pemantauan.

Objek konteks adalah kelas Python yang didefinisikan dalam klien antarmuka runtime Lambda. Untuk mengembalikan nilai dari salah satu properti objek konteks, gunakan metode yang sesuai pada objek konteks. Misalnya, cuplikan kode berikut menetapkan nilai aws_request_id properti (pengenal untuk permintaan pemanggilan) ke variabel bernama. request

request = context.aws_request_id

Untuk mempelajari lebih lanjut tentang menggunakan objek konteks Lambda, dan untuk melihat daftar lengkap metode dan properti yang tersedia, lihat. Menggunakan objek konteks Lambda untuk mengambil informasi fungsi Python

Tanda tangan handler yang valid untuk penangan Python

Saat mendefinisikan fungsi handler Anda dengan Python, fungsi tersebut harus mengambil dua argumen. Argumen pertama adalah objek peristiwa Lambda dan yang kedua adalah objek konteks Lambda. Menurut konvensi, argumen masukan ini biasanya diberi nama event dancontext, tetapi Anda dapat memberi mereka nama apa pun yang Anda inginkan. Jika Anda mendeklarasikan fungsi handler Anda dengan satu argumen input, Lambda akan memunculkan kesalahan saat mencoba menjalankan fungsi Anda. Cara paling umum untuk mendeklarasikan fungsi handler dengan Python adalah sebagai berikut:

def lambda_handler(event, context):

Anda juga dapat menggunakan petunjuk tipe Python dalam deklarasi fungsi Anda, seperti yang ditunjukkan pada contoh berikut:

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

Untuk menggunakan AWS pengetikan khusus untuk peristiwa yang dihasilkan oleh other Layanan AWS dan untuk objek konteks, tambahkan aws-lambda-typing paket ke paket penerapan fungsi Anda. Anda dapat menginstal pustaka ini di lingkungan pengembangan Anda dengan menjalankanpip install aws-lambda-typing. Cuplikan kode berikut menunjukkan cara menggunakan petunjuk tipe AWS-specific. Dalam contoh ini, acara yang diharapkan adalah acara Amazon S3.

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]:

Anda tidak dapat menggunakan tipe async fungsi Python untuk fungsi handler Anda.

Mengembalikan nilai

Secara opsional, handler dapat mengembalikan nilai, yang harus JSON serializable. Jenis pengembalian umum termasukdict,list,str,int,float, danbool.

Apa yang terjadi pada nilai yang dikembalikan tergantung pada jenis pemanggilan dan layanan yang memanggil fungsi. Sebagai contoh:

Dalam kode contoh, handler mengembalikan kamus Python berikut:

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

Runtime Lambda membuat serial kamus ini dan mengembalikannya ke klien yang memanggil fungsi sebagai string JSON.

Menggunakan AWS SDK untuk Python (Boto3) di handler Anda

Seringkali, Anda akan menggunakan fungsi Lambda untuk berinteraksi dengan orang lain Layanan AWS dan sumber daya. Cara termudah untuk berinteraksi dengan sumber daya ini adalah dengan menggunakan file AWS SDK untuk Python (Boto3). Semua runtime Lambda Python yang didukung menyertakan versi SDK untuk Python. Namun, kami sangat menyarankan agar Anda menyertakan SDK dalam paket penerapan fungsi Anda jika kode Anda perlu menggunakannya. Menyertakan SDK dalam paket penerapan memberi Anda kontrol penuh atas dependensi dan mengurangi risiko masalah ketidaksejajaran versi dengan pustaka lain. Lihat Dependensi runtime dengan Python dan Kompatibilitas mundur untuk mempelajari lebih lanjut.

Untuk menggunakan SDK untuk Python dalam fungsi Lambda Anda, tambahkan pernyataan berikut ke blok impor di awal kode fungsi Anda:

import boto3

Gunakan pip install perintah untuk menambahkan boto3 pustaka ke paket penyebaran fungsi Anda. Untuk petunjuk terperinci tentang cara menambahkan dependensi ke paket penerapan.zip, lihat. Membuat paket penerapan.zip dengan dependensi Untuk mempelajari selengkapnya tentang menambahkan dependensi ke fungsi Lambda yang digunakan sebagai gambar kontainer, lihat atau. Membuat gambar dari gambar dasar Membuat gambar dari gambar dasar alternatif

Saat menggunakan boto3 kode Anda, Anda tidak perlu memberikan kredensil apa pun untuk menginisialisasi klien. Misalnya, dalam kode contoh, kami menggunakan baris kode berikut untuk menginisialisasi klien Amazon S3:

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

Dengan Python, Lambda secara otomatis membuat variabel lingkungan dengan kredensi. boto3SDK memeriksa variabel lingkungan fungsi Anda untuk kredensil ini selama inisialisasi.

Mengakses variabel lingkungan

Dalam kode handler Anda, Anda dapat mereferensikan variabel lingkungan dengan menggunakan os.environ.get metode ini. Dalam kode contoh, kami mereferensikan variabel RECEIPT_BUCKET lingkungan yang ditentukan menggunakan baris kode berikut:

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

Jangan lupa untuk menyertakan import os pernyataan di blok impor di awal kode Anda.

Praktik terbaik kode untuk fungsi Lambda Python

Patuhi pedoman dalam daftar berikut untuk menggunakan praktik pengkodean terbaik saat membangun fungsi Lambda Anda: