Type annotations for boto3.DynamoDB 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-dynamodb
Type annotations for boto3.DynamoDB 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for DynamoDB
service.
python -m pip install boto3-stubs[dynamodb]
How to use
Client annotations
DynamoDBClient
provides annotations for boto3.client("dynamodb")
.
import boto3
from mypy_boto3_dynamodb import DynamoDBClient
client: DynamoDBClient = boto3.client("dynamodb")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: DynamoDBClient = session.client("dynamodb")
Paginators annotations
mypy_boto3_dynamodb.paginator
module contains type annotations for all paginators.
from mypy_boto3_dynamodb import DynamoDBClient
from mypy_boto3_dynamodb.paginator import (
ListBackupsPaginator,
ListTablesPaginator,
ListTagsOfResourcePaginator,
QueryPaginator,
ScanPaginator,
)
client: DynamoDBClient = boto3.client("dynamodb")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_backups_paginator: ListBackupsPaginator = client.get_paginator("list_backups")
list_tables_paginator: ListTablesPaginator = client.get_paginator("list_tables")
list_tags_of_resource_paginator: ListTagsOfResourcePaginator = client.get_paginator("list_tags_of_resource")
query_paginator: QueryPaginator = client.get_paginator("query")
scan_paginator: ScanPaginator = client.get_paginator("scan")
Waiters annotations
mypy_boto3_dynamodb.waiter
module contains type annotations for all waiters.
from mypy_boto3_dynamodb import DynamoDBClient
from mypy_boto3_dynamodb.waiter import (
TableExistsWaiter,
TableNotExistsWaiter,
)
client: DynamoDBClient = boto3.client("dynamodb")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
table_exists_waiter: TableExistsWaiter = client.get_waiter("table_exists")
table_not_exists_waiter: TableNotExistsWaiter = client.get_waiter("table_not_exists")
Service Resource annotations
DynamoDBServiceResource
provides annotations for boto3.resource("dynamodb")
.
from mypy_boto3_dynamodb import DynamoDBServiceResource
resource: DynamoDBServiceResource = boto3.resource("dynamodb")
# now resource usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_resource: DynamoDBServiceResource = session.resource("dynamodb")
Other resources annotations
mypy_boto3_dynamodb.service_resource
module contains type annotations for all resources.
from mypy_boto3_dynamodb import DynamoDBServiceResource
from mypy_boto3_dynamodb.service_resource import (
Table,
)
resource: DynamoDBServiceResource = boto3.resource("dynamodb")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_table: Table = resource.Table(...)
Collections annotations
mypy_boto3_dynamodb.service_resource
module contains type annotations
for all DynamoDBServiceResource
collections.
from mypy_boto3_dynamodb import DynamoDBServiceResource
from mypy_boto3_dynamodb.service_resource import (
ServiceResourceTablesCollection,
)
resource: DynamoDBServiceResource = boto3.resource("dynamodb")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
tables: dynamodb_resources.ServiceResourceTablesCollection = resource.tables
Typed dictionations
mypy_boto3_dynamodb.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_dynamodb.type_defs import ArchivalSummaryTypeDef, ...
def get_structure() -> ArchivalSummaryTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_dynamodb
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("dynamodb")
resource = boto3.resource("dynamodb")
session_client = boto3.Session().client("dynamodb")
session_resource = boto3.Session().resource("dynamodb")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-dynamodb-1.14.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfa5aa97bb73bc763a3f3ef02ad088a349ccb9999e560fcf2586ea99e03b31dd |
|
MD5 | a4d9a3fd0ef378f111e80bcffa45218e |
|
BLAKE2b-256 | 35b2f26bc117bbcf1ccd1023df8d83f5beccf92adb8a4fda036d0f65ecbfc2d1 |
Hashes for mypy_boto3_dynamodb-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aed9cf23967ddc7239ad980cafc786894ecba64a0e0d1c82f6424c9f53eb8a34 |
|
MD5 | cc632b9c8a743f3818ab2fb22cce01a1 |
|
BLAKE2b-256 | e9df69b092d8a6d74fd60c564b2b0da0b2ae6f99678b9d0f0569d901ca9e43c6 |