Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Type annotations for boto3.SNS 1.13.26 service, generated by mypy-boto3-buider 2.0.3

Project description

mypy-boto3-sns

PyPI - mypy-boto3-sns PyPI - Python Version Docs

Type annotations for boto3.SNS 1.13.26 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 2.0.3.

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]

# update installed packages index for automated type discovery
python -m mypy_boto3

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")

Automated type discovery

mypy_boto3 package can generate index for mypy_boto3_sns and other installed services.

# Run this command when you add or remove service packages
python -m mypy_boto3

Generated index provides overloads for boto3.client and boto3.service, boto3.Session.client and boto3.Session.resource functions, so explicit type annotations are not needed.

  • mypy supports function overloads as expected
  • PyCharm also supports function overloads, but consumes a lot of RAM, use carefully
  • VSCode does not currently support function overloads

Also, generated index allows you to import types from mypy_boto3:

# you can replace imports
import mypy_boto3_sns as sns
from mypy_boto3_sns import SNSClient

# with these
from mypy_boto3 import sns
from mypy_boto3.sns import SNSClient

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.

Files for mypy-boto3-sns, version 1.13.26.1
Filename, size File type Python version Upload date Hashes
Filename, size mypy_boto3_sns-1.13.26.1-py3-none-any.whl (10.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mypy-boto3-sns-1.13.26.1.tar.gz (9.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page