mypy-boto3-sns 1.13.24.3

Type annotations for boto3.SNS 1.13.24 service, generated by mypy-boto3-buider 2.0.2

mypy-boto3-sns

• mypy-boto3-sns
  • How to use
  • Automated type discovery

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

Generated by mypy-boto3-buider 2.0.2.

More information can be found on boto3-stubs page.

• mypy-boto3-sns
  • How to use
    • Type checking
  • How it works

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