Skip to main content

A package that provides type hints for AWS Lambda event, context and response objects

Project description

AWS Lambda Typing

build test License python_version pypi_v pypi_dm

A package that provides type hints for AWS Lambda event, context and response objects. It's a convenient way to get autocomplete and type hints built into IDEs. Type annotations are not checked at runtime but are only enforced by third party tools such as type checkers, IDEs, linters, etc.

Table of Contents

Usage

Example: AWS SQS event

from aws_lambda_typing import context as context_, events


def handler(event: events.SQSEvent, context: context_.Context) -> None:
    for record in event['Records']:
        print(record['body'])

    print(context.get_remaining_time_in_millis())

    message: events.sqs.SQSMessage

Demo

IDE autocomplete

ide_autocomplete

IDE code reference information

code_reference_information

Types

Context

  • Context

Events

  • ALBEvent
  • APIGatewayRequestAuthorizerEvent
  • APIGatewayTokenAuthorizerEvent
  • APIGatewayProxyEventV1
  • APIGatewayProxyEventV2
  • AppSyncResolverEvent
  • CloudFormationCustomResourceEvent
  • CloudWatchEventsMessageEvent
  • CloudWatchLogsEvent
  • CodeCommitMessageEvent
  • CodePipelineEvent
  • ConfigEvent
  • DynamoDBStreamEvent
  • IoTPreProvisioningHookEvent
  • KinesisFirehoseEvent
  • KinesisStreamEvent
  • MQEvent
  • MSKEvent
  • S3Event
  • S3BatchEvent
  • SecretsManagerRotationEvent
  • SESEvent
  • SNSEvent
  • SQSEvent

Responses

  • ALBResponse
  • APIGatewayAuthorizerResponse
  • APIGatewayProxyResponseV1
  • APIGatewayProxyResponseV2
  • IoTPreProvisioningHookResponse
  • S3BatchResponse

Other

  • PolicyDocument

Develop

Activate virtual environment

poetry shell

Install dependencies

poetry install --remove-untracked

Install git hooks

pre-commit install --hook-type pre-commit

Run tests

mypy tests

Run linter

flake8 .

Format code

black .

Sort imports

isort .

Contributing

Contributions are welcome via pull requests.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aws-lambda-typing-2.9.7.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aws_lambda_typing-2.9.7-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

Details for the file aws-lambda-typing-2.9.7.tar.gz.

File metadata

  • Download URL: aws-lambda-typing-2.9.7.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.8.12 Linux/5.11.0-1025-azure

File hashes

Hashes for aws-lambda-typing-2.9.7.tar.gz
Algorithm Hash digest
SHA256 9ef6faab3838326384465a2bc61ef1dd6e875ec512ce082156728de918a9fd54
MD5 83d147591c5cc87a3f165b3a55c27281
BLAKE2b-256 59ddef79903a898c067913e0414ad0510ae42a72ec30873ffed4e766e92b6a5e

See more details on using hashes here.

File details

Details for the file aws_lambda_typing-2.9.7-py3-none-any.whl.

File metadata

  • Download URL: aws_lambda_typing-2.9.7-py3-none-any.whl
  • Upload date:
  • Size: 27.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.8.12 Linux/5.11.0-1025-azure

File hashes

Hashes for aws_lambda_typing-2.9.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4c512b4f76fb76a42d4f9de9978aa25ad84d07aaccfc9687cc08c9b92f0769a1
MD5 b655ecfae847bcff80b6e1214aae748f
BLAKE2b-256 87c7a109b0f01ab1d75c7487d65b2a21aeea3a679d13df688f03c63993059952

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page