mypy-boto3-sqs 1.13.26.0

Type annotations for boto3.SQS 1.13.26 service, generated by mypy-boto3-buider 2.0.2

mypy-boto3-sqs

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

Type annotations for boto3.SQS 1.13.26 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-sqs
  • 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 SQS service.

python -m pip install boto3-stubs[sqs]

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

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

import boto3

from mypy_boto3_sqs import SQSClient

# Now mypy can check if your code is valid.
client: SQSClient = boto3.client("sqs")

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

# Do you prefer resource approach? We've got you covered!
from mypy_boto3_sqs import SQSServiceResource

resource: sqs.SQSServiceResource = boto3.resource("sqs")

Automated type discovery

mypy_boto3 package can generate index for mypy_boto3_sqs 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_sqs as sqs
from mypy_boto3_sqs import SQSClient

# with these
from mypy_boto3 import sqs
from mypy_boto3.sqs import SQSClient