Type annotations for boto3.PinpointEmail 1.14.11 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-pinpoint-email
Type annotations for boto3.PinpointEmail 1.14.11 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 PinpointEmail
service.
python -m pip install boto3-stubs[pinpoint-email]
How to use
Client annotations
PinpointEmailClient
provides annotations for boto3.client("pinpoint-email")
.
import boto3
from mypy_boto3_pinpoint_email import PinpointEmailClient
from mypy_boto3_pinpoint_email.paginator import (
GetDedicatedIpsPaginator,
ListConfigurationSetsPaginator,
ListDedicatedIpPoolsPaginator,
ListDeliverabilityTestReportsPaginator,
ListEmailIdentitiesPaginator,
)
from mypy_boto3_pinpoint_email.type_defs import BlacklistEntryTypeDef, ...
client: PinpointEmailClient = boto3.client("pinpoint-email")
# 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: PinpointEmailClient = session.client("pinpoint-email")
Paginators annotations
mypy_boto3_pinpoint_email.paginator
module contains type annotations for all paginators.
client: PinpointEmailClient = boto3.client("pinpoint-email")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
get_dedicated_ips_paginator: GetDedicatedIpsPaginator = client.get_paginator("get_dedicated_ips")
list_configuration_sets_paginator: ListConfigurationSetsPaginator = client.get_paginator("list_configuration_sets")
list_dedicated_ip_pools_paginator: ListDedicatedIpPoolsPaginator = client.get_paginator("list_dedicated_ip_pools")
list_deliverability_test_reports_paginator: ListDeliverabilityTestReportsPaginator = client.get_paginator("list_deliverability_test_reports")
list_email_identities_paginator: ListEmailIdentitiesPaginator = client.get_paginator("list_email_identities")
Typed dictionations
mypy_boto3_pinpoint_email.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> BlacklistEntryTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_pinpoint_email
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("pinpoint-email")
session_client = boto3.Session().client("pinpoint-email")
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-pinpoint-email-1.14.11.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e07e4733fc251351337fad2bbaa0504c863bde2819579059ac96db768a937c5d |
|
MD5 | aa220522dd94ef80c37efc245c521e4c |
|
BLAKE2b-256 | 5eac49a40faa3e05c736504815095c4431cf2ace6fb4bb90925935f4bdd51544 |
Hashes for mypy_boto3_pinpoint_email-1.14.11.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | acbb9e504efa55be1ba21038dbf0b1e26ce2555220c7b12d363d5f1bf1632e3c |
|
MD5 | 19c78c2c5a9fd693c7794f3e26eca675 |
|
BLAKE2b-256 | aa6ea155f1314d7989cfc1770e21cfba4c24846a567f2327f800dbc936ca616c |