Type annotations for boto3.SQS 1.35.0 service generated with mypy-boto3-builder 7.26.0
Type annotations for boto3.SQS 1.35.0 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated by mypy-boto3-builder 7.26.0.
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:
Add
AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start command.
Click Modify and select boto3 common and SQS.
Install boto3-stubs for SQS service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[sqs]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[sqs]'
# standalone installation
python -m pip install mypy-boto3-sqs
Installing mypy-boto3-sqs from the conda-forge channel can be achieved by
adding conda-forge to your channels with:
conda config --add channels conda-forge
conda config --set channel_priority strict
Once the conda-forge channel has been enabled, mypy-boto3-sqs can be
installed with:
conda install mypy-boto3-sqs
It is possible to list all of the versions of mypy-boto3-sqs available on
your platform with:
conda search mypy-boto3-sqs --channel conda-forge
python -m pip uninstall -y mypy-boto3-sqs
Pylance as your Python Language Serverboto3-stubs[sqs] in your environment:python -m pip install 'boto3-stubs[sqs]'
Both type checking and code completion should now work. No explicit type
annotations required, write your boto3 code as usual.
Install boto3-stubs-lite[sqs] in your environment:
python -m pip install 'boto3-stubs-lite[sqs]'`
Both type checking and code completion should now work. Explicit type annotations are required.
Use boto3-stubs package instead for implicit type discovery.
boto3-stubs with services you use in your environment:python -m pip install 'boto3-stubs[sqs]'
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
boto3-stubsType checking should now work. No explicit type annotations required, write
your boto3 code as usual.
boto3-stubs[sqs] with services you use in your environment:python -m pip install 'boto3-stubs[sqs]'
Type checking should now work. No explicit type annotations required, write
your boto3 code as usual.
Not tested, but as long as your IDE supports mypy or pyright, everything
should work.
mypy: python -m pip install mypyboto3-stubs[sqs] in your environment:python -m pip install 'boto3-stubs[sqs]'`
Type checking should now work. No explicit type annotations required, write
your boto3 code as usual.
pyright: npm i -g pyrightboto3-stubs[sqs] in your environment:python -m pip install 'boto3-stubs[sqs]'
Optionally, you can install boto3-stubs to typings folder.
Type checking should now work. No explicit type annotations required, write
your boto3 code as usual.
SQSClient provides annotations for boto3.client("sqs").
from boto3.session import Session
from mypy_boto3_sqs import SQSClient
client: SQSClient = Session().client("sqs")
# now client usage is checked by mypy and IDE should provide code completion
mypy_boto3_sqs.paginator module contains type annotations for all paginators.
from boto3.session import Session
from mypy_boto3_sqs import SQSClient
from mypy_boto3_sqs.paginator import ListDeadLetterSourceQueuesPaginator, ListQueuesPaginator
client: SQSClient = Session().client("sqs")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_dead_letter_source_queues_paginator: ListDeadLetterSourceQueuesPaginator = (
client.get_paginator("list_dead_letter_source_queues")
)
list_queues_paginator: ListQueuesPaginator = client.get_paginator("list_queues")
SQSServiceResource provides annotations for boto3.resource("sqs").
from boto3.session import Session
from mypy_boto3_sqs import SQSServiceResource
resource: SQSServiceResource = Session().resource("sqs")
# now resource usage is checked by mypy and IDE should provide code completion
mypy_boto3_sqs.service_resource module contains type annotations for all
resources.
from boto3.session import Session
from mypy_boto3_sqs import SQSServiceResource
from mypy_boto3_sqs.service_resource import Message, Queue
resource: SQSServiceResource = Session().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(...)
mypy_boto3_sqs.service_resource module contains type annotations for all
SQSServiceResource collections.
from boto3.session import Session
from mypy_boto3_sqs import SQSServiceResource
from mypy_boto3_sqs.service_resource import ServiceResourceQueuesCollection
resource: SQSServiceResource = Session().resource("sqs")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
queues: sqs_resources.ServiceResourceQueuesCollection = resource.queues
mypy_boto3_sqs.literals module contains literals extracted from shapes that
can be used in user code for type checking.
Full list of SQS Literals can be found in
docs.
from mypy_boto3_sqs.literals import ListDeadLetterSourceQueuesPaginatorName
def check_value(value: ListDeadLetterSourceQueuesPaginatorName) -> bool: ...
mypy_boto3_sqs.type_defs module contains structures and shapes assembled to
typed dictionaries and unions for additional type checking.
Full list of SQS TypeDefs can be found in
docs.
from mypy_boto3_sqs.type_defs import AddPermissionRequestQueueAddPermissionTypeDef
def get_value() -> AddPermissionRequestQueueAddPermissionTypeDef:
return {...}
Fully automated
mypy-boto3-builder carefully
generates type annotations for each service, patiently waiting for boto3
updates. It delivers drop-in type annotations for you and makes sure that:
boto3 services are covered.boto3 service gets valid type
annotations extracted from botocore schemas.boto3, botocore, aiobotocore and aioboto3
librariesmypy, pyright, VSCode, PyCharm, Sublime Text and Emacs
compatibilityClient, ServiceResource, Resource, Waiter Paginator type
annotations for each serviceTypeDefs for each serviceLiterals for each serviceboto3.client and boto3.resource callssession.client and session.resource callsclient.get_waiter and client.get_paginator
callsServiceResource and Resource collectionsaiobotocore.Session.create_client callsBuilder changelog can be found in Releases.
mypy-boto3-sqs version is the same as related boto3 version and follows
PEP 440 format.
All services type annotations can be found in boto3 docs
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.
FAQs
Type annotations for boto3.SQS 1.35.0 service generated with mypy-boto3-builder 7.26.0
We found that mypy-boto3-sqs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.