mypy-boto3-sqs 1.19.9

Type annotations for boto3.SQS 1.19.9 service, generated by mypy-boto3-builder 6.0.2

mypy-boto3-sqs

Type annotations for boto3.SQS 1.19.9 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 6.0.2.

More information can be found on boto3-stubs page and in mypy-boto3-sqs docs

See how it helps to find and fix potential bugs:

• mypy-boto3-sqs
  • How to install
  • Usage
    • VSCode
    • PyCharm
    • Other IDEs
    • mypy
    • pyright
  • Explicit type annotations
    • Client annotations
    • Paginators annotations
    • Service Resource annotations
    • Other resources annotations
    • Collections annotations
    • Literals
    • Typed dictionaries
  • Versioning
  • Documentation
  • Support and contributing

How to install

Install boto3-stubs for SQS service.

python -m pip install boto3-stubs[sqs]

Usage

VSCode

• Install Python extension
• Install Pylance extension
• Set Pylance as your Python Language Server
• Install boto-stubs[sqs] in your environment: python -m pip install 'boto3-stubs[sqs]'

Both type checking and auto-complete should work for SQS service. No explicit type annotations required, write your boto3 code as usual.

PyCharm

• Install boto-stubs[sqs] in your environment: python -m pip install 'boto3-stubs[sqs]'

Both type checking and auto-complete should work for SQS service. No explicit type annotations required, write your boto3 code as usual. Auto-complete can be slow on big projects or if you have a lot of installed boto3-stubs submodules.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

mypy

• Install mypy: python -m pip install mypy
• Install boto-stubs[sqs] in your environment: python -m pip install 'boto3-stubs[sqs]'
• Run mypy as usual

Type checking should work for SQS service. No explicit type annotations required, write your boto3 code as usual.

pyright

• Install pyright: yarn global add pyright
• Install boto-stubs[sqs] in your environment: python -m pip install 'boto3-stubs[sqs]'
• Optionally, you can install boto3-stubs to typings folder.

Type checking should work for SQS service. No explicit type annotations required, write your boto3 code as usual.

Explicit type annotations

Client annotations

SQSClient provides annotations for boto3.client("sqs").

import boto3

from mypy_boto3_sqs import SQSClient

client: SQSClient = boto3.client("sqs")

# now client usage is checked by mypy and IDE should provide code auto-complete

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

Paginators annotations

mypy_boto3_sqs.paginator module contains type annotations for all paginators.

from mypy_boto3_sqs import SQSClient
from mypy_boto3_sqs.paginator import (
    ListDeadLetterSourceQueuesPaginator,
    ListQueuesPaginator,
)

client: SQSClient = boto3.client("sqs")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_dead_letter_source_queues_paginator: ListDeadLetterSourceQueuesPaginator = client.get_paginator("list_dead_letter_source_queues")
list_queues_paginator: ListQueuesPaginator = client.get_paginator("list_queues")

Service Resource annotations

SQSServiceResource provides annotations for boto3.resource("sqs").

from mypy_boto3_sqs import SQSServiceResource

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

# now resource usage is checked by mypy and IDE should provide code auto-complete

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_resource: SQSServiceResource = session.resource("sqs")

Other resources annotations

mypy_boto3_sqs.service_resource module contains type annotations for all resources.

from mypy_boto3_sqs import SQSServiceResource
from mypy_boto3_sqs.service_resource import (
    Message,
    Queue,
)

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

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_message: Message = resource.Message(...)
my_queue: Queue = resource.Queue(...)

Collections annotations

mypy_boto3_sqs.service_resource module contains type annotations for all SQSServiceResource collections.

from mypy_boto3_sqs import SQSServiceResource
from mypy_boto3_sqs.service_resource import (
    ServiceResourceQueuesCollection,
)

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

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
queues: sqs_resources.ServiceResourceQueuesCollection = resource.queues

Literals

mypy_boto3_sqs.literals module contains literals extracted from shapes that can be used in user code for type checking.

from mypy_boto3_sqs.literals import (
    ListDeadLetterSourceQueuesPaginatorName,
    ListQueuesPaginatorName,
    MessageSystemAttributeNameForSendsType,
    MessageSystemAttributeNameType,
    QueueAttributeNameType,
    ServiceName,
    PaginatorName,
)

def check_value(value: ListDeadLetterSourceQueuesPaginatorName) -> bool:
    ...

Typed dictionaries

mypy_boto3_sqs.type_defs module contains structures and shapes assembled to typed dictionaries for additional type checking.

from mypy_boto3_sqs.type_defs import (
    AddPermissionRequestQueueTypeDef,
    AddPermissionRequestRequestTypeDef,
    BatchResultErrorEntryTypeDef,
    ChangeMessageVisibilityBatchRequestEntryTypeDef,
    ChangeMessageVisibilityBatchRequestQueueTypeDef,
    ChangeMessageVisibilityBatchRequestRequestTypeDef,
    ChangeMessageVisibilityBatchResultEntryTypeDef,
    ChangeMessageVisibilityBatchResultTypeDef,
    ChangeMessageVisibilityRequestMessageTypeDef,
    ChangeMessageVisibilityRequestRequestTypeDef,
    CreateQueueRequestRequestTypeDef,
    CreateQueueRequestServiceResourceTypeDef,
    CreateQueueResultTypeDef,
    DeleteMessageBatchRequestEntryTypeDef,
    DeleteMessageBatchRequestQueueTypeDef,
    DeleteMessageBatchRequestRequestTypeDef,
    DeleteMessageBatchResultEntryTypeDef,
    DeleteMessageBatchResultTypeDef,
    DeleteMessageRequestRequestTypeDef,
    DeleteQueueRequestRequestTypeDef,
    GetQueueAttributesRequestRequestTypeDef,
    GetQueueAttributesResultTypeDef,
    GetQueueUrlRequestRequestTypeDef,
    GetQueueUrlRequestServiceResourceTypeDef,
    GetQueueUrlResultTypeDef,
    ListDeadLetterSourceQueuesRequestRequestTypeDef,
    ListDeadLetterSourceQueuesResultTypeDef,
    ListQueueTagsRequestRequestTypeDef,
    ListQueueTagsResultTypeDef,
    ListQueuesRequestRequestTypeDef,
    ListQueuesResultTypeDef,
    MessageAttributeValueTypeDef,
    MessageSystemAttributeValueTypeDef,
    MessageTypeDef,
    PaginatorConfigTypeDef,
    PurgeQueueRequestRequestTypeDef,
    QueueMessageRequestTypeDef,
    ReceiveMessageRequestQueueTypeDef,
    ReceiveMessageRequestRequestTypeDef,
    ReceiveMessageResultTypeDef,
    RemovePermissionRequestQueueTypeDef,
    RemovePermissionRequestRequestTypeDef,
    ResponseMetadataTypeDef,
    SendMessageBatchRequestEntryTypeDef,
    SendMessageBatchRequestQueueTypeDef,
    SendMessageBatchRequestRequestTypeDef,
    SendMessageBatchResultEntryTypeDef,
    SendMessageBatchResultTypeDef,
    SendMessageRequestQueueTypeDef,
    SendMessageRequestRequestTypeDef,
    SendMessageResultTypeDef,
    ServiceResourceMessageRequestTypeDef,
    ServiceResourceQueueRequestTypeDef,
    SetQueueAttributesRequestQueueTypeDef,
    SetQueueAttributesRequestRequestTypeDef,
    TagQueueRequestRequestTypeDef,
    UntagQueueRequestRequestTypeDef,
)

def get_structure() -> AddPermissionRequestQueueTypeDef:
    return {
      ...
    }

Versioning

mypy-boto3-sqs version is the same as related boto3 version and follows PEP 440 format.

Documentation

All type annotations can be found in mypy-boto3-sqs docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.