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:
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
Pylanceas 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
mypyas 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-stubstotypingsfolder.
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.
1 maintainer
Release files for mypy-boto3-sqs 1.19.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mypy-boto3-sqs-1.19.9.tar.gz | 17.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mypy_boto3_sqs-1.19.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 45.6 kB
Release files / mypy-boto3-sqs-1.19.9.tar.gz
| Download URL | mypy-boto3-sqs-1.19.9.tar.gz |
|---|---|
| Size | 17.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3aac6d4d4f64b46ca5a283296fa508b968a00eb90cfd07d18c58bc63912e1e41
|
|
BLAKE2b-256 checksum How to use checksums |
c156c5bb61b6d5d5407c7f08040566e71e14abb363830803ad174a0051900173
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0
|
Release files / mypy_boto3_sqs-1.19.9-py3-none-any.whl
| Download URL | mypy_boto3_sqs-1.19.9-py3-none-any.whl |
|---|---|
| Size | 28.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d5d647f30f51309414032cd3afd8266266768c8ad262065f9bb85289542d7590
|
|
BLAKE2b-256 checksum How to use checksums |
1056226634684cc15e7827ace71b5e1a2409d0d6cf129c7c345186f9a09275f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0
|
