Type annotations for boto3.SNS 1.14.0 service, generated by mypy-boto3-buider 2.0.4
Project description
mypy-boto3-sns
Type annotations for boto3.SNS 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.4.
More information can be found on boto3-stubs page.
How to use
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for SNS
service.
python -m pip install boto3-stubs[sns]
Use boto3
with mypy_boto3_sns
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_sns import SNSClient
# Now mypy can check if your code is valid.
client: SNSClient = boto3.client("sns")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: SNSClient = session.client("sns")
# Do you prefer resource approach? We've got you covered!
from mypy_boto3_sns import SNSServiceResource
resource: sns.SNSServiceResource = boto3.resource("sns")
# Annotated paginators are included as well
import mypy_boto3_sns.paginator as sns_paginators
list_endpoints_by_platform_application_paginator: sns_paginators.ListEndpointsByPlatformApplicationPaginator = client.get_paginator("list_endpoints_by_platform_application")
list_phone_numbers_opted_out_paginator: sns_paginators.ListPhoneNumbersOptedOutPaginator = client.get_paginator("list_phone_numbers_opted_out")
list_platform_applications_paginator: sns_paginators.ListPlatformApplicationsPaginator = client.get_paginator("list_platform_applications")
list_subscriptions_paginator: sns_paginators.ListSubscriptionsPaginator = client.get_paginator("list_subscriptions")
list_subscriptions_by_topic_paginator: sns_paginators.ListSubscriptionsByTopicPaginator = client.get_paginator("list_subscriptions_by_topic")
list_topics_paginator: sns_paginators.ListTopicsPaginator = client.get_paginator("list_topics")
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_sns
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("sns")
resource = boto3.resource("sns")
session_client = boto3.Session().client("sns")
session_resource = boto3.Session().resource("sns")
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_sns-1.14.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 314242396a2259663b58a05d30ab64df3fd09ec57af3f39c84942a2970bd630c |
|
MD5 | 332cd0f3cbf9b7bb2bcd70a0b1d22116 |
|
BLAKE2b-256 | a0a06b834d5afa99a07c63e5ebe7e607bd5b7cf6e27638691155dde04408ed5a |