mypy-boto3-lambda 1.11.1.0

Type annotations for boto3.Lambda 1.11.1 service.

mypy-boto3-lambda

Type annotations for boto3.Lambda 1.11.1 service compatible with mypy, VSCode, PyCharm and other tools.

More information can be found here.

• mypy-boto3-lambda
  • How to use
    • Type checking
    • Code auto-complete
  • How it works

How to use

Type checking

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for Lambda service.

python -m pip install boto3-stubs[mypy-boto3-lambda]

Use boto3 with mypy_boto3 in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3 import lambda_
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_lambda as lambda_

# Use this client as usual, now mypy can check if your code is valid.
# Check if your IDE supports function overloads,
# you probably do not need explicit type annotations
# client = boto3.client("lambda")
client: lambda_.LambdaClient = boto3.client("lambda")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: lambda_.LambdaClient = session.client("lambda")


# Waiters need type annotation on creation
function_active_waiter: lambda_.FunctionActiveWaiter = client.get_waiter("function_active")
function_exists_waiter: lambda_.FunctionExistsWaiter = client.get_waiter("function_exists")
function_updated_waiter: lambda_.FunctionUpdatedWaiter = client.get_waiter("function_updated")

# Paginators need type annotation on creation
list_aliases_paginator: lambda_.ListAliasesPaginator = client.get_paginator("list_aliases")
list_event_source_mappings_paginator: lambda_.ListEventSourceMappingsPaginator = client.get_paginator("list_event_source_mappings")
list_function_event_invoke_configs_paginator: lambda_.ListFunctionEventInvokeConfigsPaginator = client.get_paginator("list_function_event_invoke_configs")
list_functions_paginator: lambda_.ListFunctionsPaginator = client.get_paginator("list_functions")
list_layer_versions_paginator: lambda_.ListLayerVersionsPaginator = client.get_paginator("list_layer_versions")
list_layers_paginator: lambda_.ListLayersPaginator = client.get_paginator("list_layers")
list_provisioned_concurrency_configs_paginator: lambda_.ListProvisionedConcurrencyConfigsPaginator = client.get_paginator("list_provisioned_concurrency_configs")
list_versions_by_function_paginator: lambda_.ListVersionsByFunctionPaginator = client.get_paginator("list_versions_by_function")

How it works

Fully automated builder carefully generates type annotations for each service, patiently waiting for boto3 updates. It delivers a drop-in type annotations for you and makes sure that:

• All available boto3 services are covered.
• Each public class and method of every boto3 service gets valid type annotations extracted from the documentation (blame botocore docs if types are incorrect).
• Type annotations include up-to-date documentation.
• Link to documentation is provided for every method.
• Code is processed by black for readability.