mypy-boto3-sqs 1.11.0.0

Type annotations for boto3.SQS 1.11.0 service.

mypy-boto3-sqs

Type annotations for boto3.SQS 1.11.0 service compatible with mypy, VSCode, PyCharm and other tools.

More information can be found here.

• mypy-boto3-sqs
  • How to use
    • Type checking
    • Code auto-complete
  • How it works

How to use

Type checking

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for SQS service.

python -m pip install boto3-stubs[mypy-boto3-sqs]

Use boto3 with mypy_boto3 in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3 import sqs
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_sqs as sqs

# 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("sqs")
client: sqs.SQSClient = boto3.client("sqs")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: sqs.SQSClient = session.client("sqs")

# Do you prefer resource approach? We've got you covered!
resource: sqs.SQSServiceResource = boto3.resource("sqs")

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 boto3 services are covered.
• Each public class and method of every boto3 service gets valid type annotations extracted from the documentation (blame botocore docs 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.