Type annotations for boto3.SimpleDB 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-sdb
Type annotations for boto3.SimpleDB 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 SimpleDB
service.
python -m pip install boto3-stubs[sdb]
How to use
Client annotations
SimpleDBClient
provides annotations for boto3.client("sdb")
.
import boto3
from mypy_boto3_sdb import SimpleDBClient
client: SimpleDBClient = boto3.client("sdb")
# 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: SimpleDBClient = session.client("sdb")
Paginators annotations
mypy_boto3_sdb.paginator
module contains type annotations for all paginators.
from mypy_boto3_sdb import SimpleDBClient
from mypy_boto3_sdb.paginator import (
ListDomainsPaginator,
SelectPaginator,
)
client: SimpleDBClient = boto3.client("sdb")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_domains_paginator: ListDomainsPaginator = client.get_paginator("list_domains")
select_paginator: SelectPaginator = client.get_paginator("select")
Typed dictionations
mypy_boto3_sdb.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_sdb.type_defs import AttributeTypeDef, ...
def get_structure() -> AttributeTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_sdb
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("sdb")
session_client = boto3.Session().client("sdb")
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_sdb-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5907e5b4064373942e244d2d7ae335d15841c5ca03edadcb5d91bce0f2f5de9b |
|
MD5 | 8e4514d574d2ec07c095b6186fef95f6 |
|
BLAKE2b-256 | 7436ce46bd4c2f2fbde256cd3a8f9ce0c47049038acc1a5dc59d12b70e2d8b5b |