mypy-boto3-sns
Type annotations for boto3.SNS 1.16.2 service compatible with VSCode, PyCharm, mypy, pyright and other tools.
Generated by mypy-boto3-buider 3.2.1.
More information can be found on boto3-stubs page.
How to install
Install boto3-stubs for SNS service.
python -m pip install boto3-stubs[sns]
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylanceas your Python Language Server - Install
boto-stubs[sns]in your environment:python -m pip install 'boto3-stubs[sns]'
Both type checking and auto-complete should work for SNS service.
No explicit type annotations required, write your boto3 code as usual.
PyCharm
- Install
boto-stubs[sns]in your environment:python -m pip install 'boto3-stubs[sns]'
Both type checking and auto-complete should work for SNS service.
No explicit type annotations required, write your boto3 code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed boto3-stubs submodules.
Other IDEs
Not tested, but as long as your IDE support mypy or pyright, everything should work.
mypy
- Install
mypy:python -m pip install mypy - Install
boto-stubs[sns]in your environment:python -m pip install 'boto3-stubs[sns]' - Run
mypyas usual
Type checking should work for SNS service.
No explicit type annotations required, write your boto3 code as usual.
pyright
- Install
pyright:yarn global add pyright - Install
boto-stubs[sns]in your environment:python -m pip install 'boto3-stubs[sns]' - Optionally, you can install
boto3-stubstotypingsfolder.
Type checking should work for SNS service.
No explicit type annotations required, write your boto3 code as usual.
Explicit type annotations
Client annotations
SNSClient provides annotations for boto3.client("sns").
import boto3
from mypy_boto3_sns import SNSClient
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.
from mypy_boto3_sns import SNSClient
from mypy_boto3_sns.paginator import (
ListEndpointsByPlatformApplicationPaginator,
ListPhoneNumbersOptedOutPaginator,
ListPlatformApplicationsPaginator,
ListSubscriptionsByTopicPaginator,
ListSubscriptionsPaginator,
ListTopicsPaginator,
)
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").
from mypy_boto3_sns import SNSServiceResource
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.
from mypy_boto3_sns import SNSServiceResource
from mypy_boto3_sns.service_resource import (
PlatformApplication,
PlatformEndpoint,
Subscription,
Topic,
)
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.
from mypy_boto3_sns import SNSServiceResource
from mypy_boto3_sns.service_resource import (
ServiceResourcePlatformApplicationsCollection,
ServiceResourceSubscriptionsCollection,
ServiceResourceTopicsCollection,
)
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.
from mypy_boto3_sns.type_defs import (
CheckIfPhoneNumberIsOptedOutResponseTypeDef,
ConfirmSubscriptionResponseTypeDef,
CreateEndpointResponseTypeDef,
CreatePlatformApplicationResponseTypeDef,
CreateTopicResponseTypeDef,
EndpointTypeDef,
GetEndpointAttributesResponseTypeDef,
GetPlatformApplicationAttributesResponseTypeDef,
GetSMSAttributesResponseTypeDef,
GetSubscriptionAttributesResponseTypeDef,
GetTopicAttributesResponseTypeDef,
ListEndpointsByPlatformApplicationResponseTypeDef,
ListPhoneNumbersOptedOutResponseTypeDef,
ListPlatformApplicationsResponseTypeDef,
ListSubscriptionsByTopicResponseTypeDef,
ListSubscriptionsResponseTypeDef,
ListTagsForResourceResponseTypeDef,
ListTopicsResponseTypeDef,
MessageAttributeValueTypeDef,
PaginatorConfigTypeDef,
PlatformApplicationTypeDef,
PublishResponseTypeDef,
SubscribeResponseTypeDef,
SubscriptionTypeDef,
TagTypeDef,
TopicTypeDef,
)
def get_structure() -> EndpointTypeDef:
return {
...
}
1 maintainer
Release files for mypy-boto3-sns 1.16.2.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.16.2.0.tar.gz | 12.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mypy_boto3_sns-1.16.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 31.4 kB
Release files / mypy-boto3-sns-1.16.2.0.tar.gz
| Download URL | mypy-boto3-sns-1.16.2.0.tar.gz |
|---|---|
| Size | 12.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a199c164c4726fc188c0c38458a2271bdfe54aec9f5c624da622d3e94aee564b
|
|
BLAKE2b-256 checksum How to use checksums |
0da494c0a3290c074ab335cd36690395c73ad9cfae6c7785d9f9db52b1a86c1b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6
|
Release files / mypy_boto3_sns-1.16.2.0-py3-none-any.whl
| Download URL | mypy_boto3_sns-1.16.2.0-py3-none-any.whl |
|---|---|
| Size | 18.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ea01fcadf4a0fd66560268f831ba470e7f33e947be49a9d45abd0a9252dc406c
|
|
BLAKE2b-256 checksum How to use checksums |
cf4db78a06503603ddc89906911ca9e78396ce0d53bd1b6960dcf185b6f78bd4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6
|
