Type annotations for boto3.SES 1.14.47 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-ses
Type annotations for boto3.SES 1.14.47 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.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 SES
service.
python -m pip install boto3-stubs[ses]
How to use
Client annotations
SESClient
provides annotations for boto3.client("ses")
.
import boto3
from mypy_boto3_ses import SESClient
from mypy_boto3_ses.paginator import (
ListConfigurationSetsPaginator,
ListCustomVerificationEmailTemplatesPaginator,
ListIdentitiesPaginator,
ListReceiptRuleSetsPaginator,
ListTemplatesPaginator,
)
from mypy_boto3_ses.type_defs import AddHeaderActionTypeDef, ...
from mypy_boto3_ses.waiter import IdentityExistsWaiter
client: SESClient = boto3.client("ses")
# 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: SESClient = session.client("ses")
Paginators annotations
mypy_boto3_ses.paginator
module contains type annotations for all paginators.
client: SESClient = boto3.client("ses")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_configuration_sets_paginator: ListConfigurationSetsPaginator = client.get_paginator("list_configuration_sets")
list_custom_verification_email_templates_paginator: ListCustomVerificationEmailTemplatesPaginator = client.get_paginator("list_custom_verification_email_templates")
list_identities_paginator: ListIdentitiesPaginator = client.get_paginator("list_identities")
list_receipt_rule_sets_paginator: ListReceiptRuleSetsPaginator = client.get_paginator("list_receipt_rule_sets")
list_templates_paginator: ListTemplatesPaginator = client.get_paginator("list_templates")
Waiters annotations
mypy_boto3_ses.waiter
module contains type annotations for all waiters.
client: SESClient = boto3.client("ses")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
identity_exists_waiter: IdentityExistsWaiter = client.get_waiter("identity_exists")
Typed dictionations
mypy_boto3_ses.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AddHeaderActionTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_ses
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
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("ses")
session_client = boto3.Session().client("ses")
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_ses-1.14.47.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17741f3e83b635d9e2fb2fc7e949725170eab1a6d31111ab1990441ee1cda686 |
|
MD5 | 8e460f0e577a11cb155146490393c7ee |
|
BLAKE2b-256 | 9d072c03f3ced5704d419bb0e6c3815310c5afdbd62b7c24fbf5dfba4b38a2ab |