Skip to main content

Type annotations for boto3.SQS 1.16.57 service, generated by mypy-boto3-buider 4.3.1

Project description

mypy-boto3-sqs

PyPI - mypy-boto3-sqs PyPI - Python Version Docs

boto3.typed

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

Generated by mypy-boto3-buider 4.3.1.

More information can be found on boto3-stubs page.

See how it helps to find and fix potential bugs:

boto3-stubs demo

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 support 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

Typed dictionations

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 (
    BatchResultErrorEntryTypeDef,
    ChangeMessageVisibilityBatchRequestEntryTypeDef,
    ChangeMessageVisibilityBatchResultEntryTypeDef,
    ChangeMessageVisibilityBatchResultTypeDef,
    CreateQueueResultTypeDef,
    DeleteMessageBatchRequestEntryTypeDef,
    DeleteMessageBatchResultEntryTypeDef,
    DeleteMessageBatchResultTypeDef,
    GetQueueAttributesResultTypeDef,
    GetQueueUrlResultTypeDef,
    ListDeadLetterSourceQueuesResultTypeDef,
    ListQueuesResultTypeDef,
    ListQueueTagsResultTypeDef,
    MessageAttributeValueTypeDef,
    MessageSystemAttributeValueTypeDef,
    MessageTypeDef,
    PaginatorConfigTypeDef,
    ReceiveMessageResultTypeDef,
    SendMessageBatchRequestEntryTypeDef,
    SendMessageBatchResultEntryTypeDef,
    SendMessageBatchResultTypeDef,
    SendMessageResultTypeDef,
)

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

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.

Source Distribution

mypy-boto3-sqs-1.16.57.0.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

mypy_boto3_sqs-1.16.57.0-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file mypy-boto3-sqs-1.16.57.0.tar.gz.

File metadata

  • Download URL: mypy-boto3-sqs-1.16.57.0.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for mypy-boto3-sqs-1.16.57.0.tar.gz
Algorithm Hash digest
SHA256 8c8b56074a7c917625e614e5eedef504846a3ed0f09c198eeaa0da3f42a90544
MD5 d9e0ace8d784d2646c29275837ac3d03
BLAKE2b-256 1bcc3797edc122388cc55e03a403e8473e31f9f6b2407a3a87f6dd72140edeb5

See more details on using hashes here.

File details

Details for the file mypy_boto3_sqs-1.16.57.0-py3-none-any.whl.

File metadata

  • Download URL: mypy_boto3_sqs-1.16.57.0-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for mypy_boto3_sqs-1.16.57.0-py3-none-any.whl
Algorithm Hash digest
SHA256 98dd9edcba6196dc86c50ad586bc9f0afe33cec838ea39de07014620a8b02e6d
MD5 b8414329bb01a11746eea8a6ee05dbac
BLAKE2b-256 95fd1b0f87be08c1674276fef0ed76a92679bba3d37150f2746206b0174f2f57

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page