Type annotations for aiobotocore.SQS 2.1.0 service generated by mypy-boto3-builder 6.4.2
Project description
mypy-boto3-sqs
Type annotations for boto3.SQS 1.20.47 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated by mypy-boto3-builder 6.4.2.
More information can be found on boto3-stubs page and in types-aiobotocore-sqs docs
See how it helps to find and fix potential bugs:
- mypy-boto3-sqs
- Explicit type annotations are optional here
- Type should be correctly discovered by mypy and IDEs
- Explicit type annotations are optional here
- Type should be correctly discovered by mypy and IDEs
How to install
VSCode extension
Add
AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and SQS
.
From PyPI with pip
Install types-aiobotocore
for SQS
service.
python -m pip install types-aiobotocore[sqs]
From conda-forge
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
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylance
as your Python Language Server - Install
types-aiobotocore[sqs]
in your environment:python -m pip install 'types-aiobotocore[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
types-aiobotocore[sqs]
in your environment:python -m pip install 'types-aiobotocore[sqs]'
Both type checking and auto-complete should work for SQS
service. No explicit
type annotations required, write your aiobotocore
code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
types-aiobotocore
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
types-aiobotocore[sqs]
in your environment:python -m pip install 'types-aiobotocore[sqs]'
- Run
mypy
as usual
Type checking should work for SQS
service. No explicit type annotations
required, write your aiobotocore
code as usual.
pyright
- Install
pyright
:yarn global add pyright
- Install
types-aiobotocore[sqs]
in your environment:python -m pip install 'types-aiobotocore[sqs]'
- Optionally, you can install
boto3-stubs
totypings
folder.
Type checking should work for SQS
service. No explicit type annotations
required, write your aiobotocore
code as usual.
Explicit type annotations
Client annotations
SQSClient
provides annotations for session.create_client("sqs")
.
from aiobotocore.session import get_session
from types_aiobotocore_sqs import SQSClient
session = get_session()
with async session.create_client("sqs") as client:
client: SQSClient
# now client usage is checked by mypy and IDE should provide code auto-complete
Paginators annotations
types_aiobotocore_sqs.paginator
module contains type annotations for all
paginators.
from aiobotocore.session import get_session
from types_aiobotocore_sqs import SQSClient
from types_aiobotocore_sqs.paginator import (
ListDeadLetterSourceQueuesPaginator,
ListQueuesPaginator,
)
session = get_session()
with async session.create_client("sqs") as client:
client: SQSClient
# 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 `aiobotocore.resource("sqs")`.
```python
from aiobotocore.session import get_session
from types_aiobotocore_sqs import SQSServiceResource
session = get_session()
with async session.resource("sqs") as resource:
resource: SQSServiceResource
# now resource usage is checked by mypy and IDE should provide code auto-complete
Other resources annotations
types_aiobotocore_sqs.service_resource
module contains type annotations for
all resources.
from aiobotocore.session import get_session
from types_aiobotocore_sqs import SQSServiceResource
from types_aiobotocore_sqs.service_resource import (
Message,
Queue,
)
session = get_session()
with async session.resource("sqs") as resource:
resource: SQSServiceResource
<a id="explicit-type-annotations-are-optional-here"></a>
# Explicit type annotations are optional here
<a id="type-should-be-correctly-discovered-by-mypy-and-ides"></a>
# Type should be correctly discovered by mypy and IDEs
my_message: Message = resource.Message(...)
my_queue: Queue = resource.Queue(...)
Collections annotations
types_aiobotocore_sqs.service_resource
module contains type annotations for
all SQSServiceResource
collections.
from aiobotocore.session import get_session
from types_aiobotocore_sqs import SQSServiceResource
from types_aiobotocore_sqs.service_resource import (
ServiceResourceQueuesCollection,
)
session = get_session()
with async session.resource("sqs") as resource:
resource: SQSServiceResource
<a id="explicit-type-annotations-are-optional-here"></a>
# Explicit type annotations are optional here
<a id="type-should-be-correctly-discovered-by-mypy-and-ides"></a>
# Type should be correctly discovered by mypy and IDEs
queues: sqs_resources.ServiceResourceQueuesCollection = resource.queues
Literals
types_aiobotocore_sqs.literals
module contains literals extracted from shapes
that can be used in user code for type checking.
from types_aiobotocore_sqs.literals import (
ListDeadLetterSourceQueuesPaginatorName,
ListQueuesPaginatorName,
MessageSystemAttributeNameForSendsType,
MessageSystemAttributeNameType,
QueueAttributeNameType,
ServiceName,
PaginatorName,
)
def check_value(value: ListDeadLetterSourceQueuesPaginatorName) -> bool:
...
Typed dictionaries
types_aiobotocore_sqs.type_defs
module contains structures and shapes
assembled to typed dictionaries for additional type checking.
from types_aiobotocore_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
types-aiobotocore-sqs
version is the same as related boto3
version and
follows PEP 440 format.
Documentation
All type annotations can be found in types-aiobotocore-sqs docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.
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
Built Distribution
Hashes for types-aiobotocore-sqs-2.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b19afa7bd6d6ed29ce4b8f1bba95831fceb0ddcc54d60928397de59b75678ed |
|
MD5 | b5ab720a8c2ffce63f91085a09390cf7 |
|
BLAKE2b-256 | 735703d9e286d811fc4f69964e234556bd1bea283161dccb5c95ba87922a6d4a |
Hashes for types_aiobotocore_sqs-2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb585ab8cf44278fbc0fb4b01deb2ece8c741d3c40ad9e9b6fef96a8fa4be296 |
|
MD5 | 5223cd4ad4d2aed40566324b636c085b |
|
BLAKE2b-256 | a28e38d4ff8fcda18eda53fee70d98e44934431326d5c46d4756f2a02fd9b52a |