mypy-boto3-sns
Type annotations for boto3.SNS 1.10.50 service compatible with mypy, VSCode, PyCharm and other tools.
More information can be found here.
How to use
Type checking
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs for SNS service.
python -m pip install boto3-stubs[mypy-boto3-sns]
Use boto3 with mypy_boto3 in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3 import sns
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_sns as sns
# Use this client as usual, now mypy can check if your code is valid.
# Check if your IDE supports function overloads,
# you probably do not need explicit type annotations
# client = boto3.client("sns")
client: sns.SNSClient = boto3.client("sns")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: sns.SNSClient = session.client("sns")
# Do you prefer resource approach? We've got you covered!
resource: sns.SNSServiceResource = boto3.resource("sns")
# Paginators need type annotation on creation
list_endpoints_by_platform_application_paginator: sns.ListEndpointsByPlatformApplicationPaginator = client.get_paginator("list_endpoints_by_platform_application")
list_phone_numbers_opted_out_paginator: sns.ListPhoneNumbersOptedOutPaginator = client.get_paginator("list_phone_numbers_opted_out")
list_platform_applications_paginator: sns.ListPlatformApplicationsPaginator = client.get_paginator("list_platform_applications")
list_subscriptions_paginator: sns.ListSubscriptionsPaginator = client.get_paginator("list_subscriptions")
list_subscriptions_by_topic_paginator: sns.ListSubscriptionsByTopicPaginator = client.get_paginator("list_subscriptions_by_topic")
list_topics_paginator: sns.ListTopicsPaginator = client.get_paginator("list_topics")
How it works
Fully automated builder carefully generates
type annotations for each service, patiently waiting for boto3 updates. It delivers
a drop-in type annotations for you and makes sure that:
- All available
boto3services are covered. - Each public class and method of every
boto3service gets valid type annotations extracted from the documentation (blamebotocoredocs if types are incorrect). - Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by black for readability.
1 maintainer
Release files for mypy-boto3-sns 1.10.50.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.10.50.0.tar.gz | 10.2 kB | Details |
Release files / mypy-boto3-sns-1.10.50.0.tar.gz
| Download URL | mypy-boto3-sns-1.10.50.0.tar.gz |
|---|---|
| Size | 10.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
be38afee2d7c4b7863fe01015987b2be5e7914bb323d4fa11d7829db2cb5f6d5
|
|
BLAKE2b-256 checksum How to use checksums |
a6e2818505e6a6954864d2df151fd386dceae25212da35fdc1f5fbb74bab7218
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.0
|
