mypy-boto3-dynamodb 1.13.2.0

Type annotations for boto3.DynamoDB 1.13.2 service, generated by mypy-boto3-buider 1.0.9

mypy-boto3-dynamodb

Type annotations for boto3.DynamoDB 1.13.2 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 1.0.9.

More information can be found on boto3-stubs page.

• mypy-boto3-dynamodb
  • How to use
    • Type checking
  • How it works

How to use

Type checking

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

Install boto3-stubs for DynamoDB service.

python -m pip install boto3-stubs[dynamodb]

# update installed packages index
mypy_boto3

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

import boto3

from mypy_boto3 import dynamodb
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_dynamodb as dynamodb

# 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("dynamodb")
client: dynamodb.DynamoDBClient = boto3.client("dynamodb")

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

# Do you prefer resource approach? We've got you covered!
resource: dynamodb.DynamoDBServiceResource = boto3.resource("dynamodb")

# Waiters need type annotation on creation
table_exists_waiter: dynamodb.TableExistsWaiter = client.get_waiter("table_exists")
table_not_exists_waiter: dynamodb.TableNotExistsWaiter = client.get_waiter("table_not_exists")

# Paginators need type annotation on creation
list_backups_paginator: dynamodb.ListBackupsPaginator = client.get_paginator("list_backups")
list_tables_paginator: dynamodb.ListTablesPaginator = client.get_paginator("list_tables")
list_tags_of_resource_paginator: dynamodb.ListTagsOfResourcePaginator = client.get_paginator("list_tags_of_resource")
query_paginator: dynamodb.QueryPaginator = client.get_paginator("query")
scan_paginator: dynamodb.ScanPaginator = client.get_paginator("scan")

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.