mypy-boto3-sns
Type annotations for boto3.SNS 1.14.4 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 SNS service.
python -m pip install boto3-stubs[sns]
How to use
Client annotations
SNSClient provides annotations for boto3.client("sns").
import boto3
from mypy_boto3_sns import SNSClient, SNSServiceResource
from mypy_boto3_sns.paginator import (
ListEndpointsByPlatformApplicationPaginator,
ListPhoneNumbersOptedOutPaginator,
ListPlatformApplicationsPaginator,
ListSubscriptionsByTopicPaginator,
ListSubscriptionsPaginator,
ListTopicsPaginator,
)
from mypy_boto3_sns.service_resource import (
PlatformApplication,
PlatformEndpoint,
ServiceResourcePlatformApplicationsCollection,
ServiceResourceSubscriptionsCollection,
ServiceResourceTopicsCollection,
Subscription,
Topic,
)
from mypy_boto3_sns.type_defs import EndpointTypeDef, ...
client: SNSClient = boto3.client("sns")
# 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: SNSClient = session.client("sns")
Paginators annotations
mypy_boto3_sns.paginator module contains type annotations for all paginators.
client: SNSClient = boto3.client("sns")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_endpoints_by_platform_application_paginator: ListEndpointsByPlatformApplicationPaginator = client.get_paginator("list_endpoints_by_platform_application")
list_phone_numbers_opted_out_paginator: ListPhoneNumbersOptedOutPaginator = client.get_paginator("list_phone_numbers_opted_out")
list_platform_applications_paginator: ListPlatformApplicationsPaginator = client.get_paginator("list_platform_applications")
list_subscriptions_paginator: ListSubscriptionsPaginator = client.get_paginator("list_subscriptions")
list_subscriptions_by_topic_paginator: ListSubscriptionsByTopicPaginator = client.get_paginator("list_subscriptions_by_topic")
list_topics_paginator: ListTopicsPaginator = client.get_paginator("list_topics")
Service Resource annotations
SNSServiceResource provides annotations for boto3.resource("sns").
resource: SNSServiceResource = boto3.resource("sns")
# 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: SNSServiceResource = session.resource("sns")
Other resources annotations
mypy_boto3_sns.service_resource module contains type annotations for all resources.
resource: SNSServiceResource = boto3.resource("sns")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_platform_application: PlatformApplication = resource.PlatformApplication(...)
my_platform_endpoint: PlatformEndpoint = resource.PlatformEndpoint(...)
my_subscription: Subscription = resource.Subscription(...)
my_topic: Topic = resource.Topic(...)
Collections annotations
mypy_boto3_sns.service_resource module contains type annotations
for all SNSServiceResource collections.
resource: SNSServiceResource = boto3.resource("sns")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
platform_applications: sns_resources.ServiceResourcePlatformApplicationsCollection = resource.platform_applications
subscriptions: sns_resources.ServiceResourceSubscriptionsCollection = resource.subscriptions
topics: sns_resources.ServiceResourceTopicsCollection = resource.topics
Typed dictionations
mypy_boto3_sns.type_defs module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> EndpointTypeDef:
return {
...
}
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.
mypysupports function overloads as expectedPyCharmalso supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCodedoes 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("sns")
resource = boto3.resource("sns")
session_client = boto3.Session().client("sns")
session_resource = boto3.Session().resource("sns")
1 maintainer
Metadata
1 maintainer
Release files for mypy-boto3-sns 1.14.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mypy-boto3-sns-1.14.4.0.tar.gz | 10.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mypy_boto3_sns-1.14.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.2 kB
Release files / mypy-boto3-sns-1.14.4.0.tar.gz
| Download URL | mypy-boto3-sns-1.14.4.0.tar.gz |
|---|---|
| Size | 10.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
97405ca7f1d80f3a7d0fa1bb4290b7639f927621d6d039cf42e40646971fa0de
|
|
BLAKE2b-256 checksum How to use checksums |
40291746014ce74fa47c06dae5938ed848285927a7713464f177349c1f2b0df3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3
|
Release files / mypy_boto3_sns-1.14.4.0-py3-none-any.whl
| Download URL | mypy_boto3_sns-1.14.4.0-py3-none-any.whl |
|---|---|
| Size | 10.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
54a4584546114f7b8003efeb98326a1dafebfc0bbf2d73c70aa99591b34070ad
|
|
BLAKE2b-256 checksum How to use checksums |
434659d43d74b41ab9b494c32e69501afdfbdbc79582bfa11f77cae35e8510b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3
|
