类型-aiobotocore-sqs

与VSCode、 PyCharm、 Emacs、 Sublime Text、 mypy、 pyright和其他工具 兼容的aiobotocore.SQS 2.4.0服务的类型注释 。

由 mypy-boto3-builder 7.11.10 生成。

更多信息可以在 types-aiobotocore页面和 types-aiobotocore-sqs 文档中找到。

了解它如何帮助查找和修复潜在错误：

• 类型-aiobotocore-sqs
  • 如何安装
    • 来自带有 pip 的 PyPI
  • 如何卸载
  • 用法
    • VSCode
    • PyCharm
    • Emacs
    • 崇高的文本
    • 其他 IDE
    • 我的
    • 版权
  • 显式类型注释
    • 客户端注释
    • 分页器注释
    • 服务资源注释
    • 其他资源注释
    • 集合注释
    • 字面量
    • 打字字典
  • 这个怎么运作
  • 什么是新的
    • 实现的功能
    • 最新变化
  • 版本控制
  • 谢谢
  • 文档
  • 支持和贡献

如何安装

来自带有 pip 的 PyPI

安装types-aiobotocore服务SQS。

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[sqs]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[sqs]'


# standalone installation
python -m pip install types-aiobotocore-sqs

如何卸载

python -m pip uninstall -y types-aiobotocore-sqs

用法

VSCode

• 安装 Python 扩展
• 安装 Pylance 扩展
• 设置Pylance为您的 Python 语言服务器
• types-aiobotocore[sqs]在您的环境中安装：

python -m pip install 'types-aiobotocore[sqs]'

类型检查和代码完成现在都应该可以工作了。不需要显式类型注释，aiobotocore像往常一样编写代码。

PyCharm

types-aiobotocore-lite[sqs]在您的环境中安装：

python -m pip install 'types-aiobotocore-lite[sqs]'`

类型检查和代码完成现在都应该可以工作了。需要显式类型注释。

使用types-aiobotocore包代替隐式类型发现。

Emacs

• 安装types-aiobotocore您在环境中使用的服务：

python -m pip install 'types-aiobotocore[sqs]'

• 安装use-package、 lsp、 company和 flycheck包
• 安装lsp-pyright包

(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"))
  )

• 确保 emacs 使用您安装的环境 types-aiobotocore

类型检查现在应该可以工作了。不需要显式类型注释，aiobotocore像往常一样编写代码。

崇高的文本

• 安装types-aiobotocore[sqs]您在环境中使用的服务：

python -m pip install 'types-aiobotocore[sqs]'

• 安装LSP-pyright包

类型检查现在应该可以工作了。不需要显式类型注释，aiobotocore像往常一样编写代码。

其他 IDE

未经测试，但只要您的 IDE 支持mypyor pyright，一切都应该工作。

我的

• 安装mypy：python -m pip install mypy
• types-aiobotocore[sqs]在您的环境中安装：

python -m pip install 'types-aiobotocore[sqs]'`

类型检查现在应该可以工作了。不需要显式类型注释，aiobotocore像往常一样编写代码。

版权

• 安装pyright：npm i -g pyright
• types-aiobotocore[sqs]在您的环境中安装：

python -m pip install 'types-aiobotocore[sqs]'

或者，您可以安装types-aiobotocore到typings文件夹。

类型检查现在应该可以工作了。不需要显式类型注释，aiobotocore像往常一样编写代码。

显式类型注释

客户端注释

SQSClient为session.create_client("sqs").

from aiobotocore.session import get_session

from types_aiobotocore_sqs import SQSClient

session = get_session()
async with session.create_client("sqs") as client:
    client: SQSClient
    # now client usage is checked by mypy and IDE should provide code completion

分页器注释

types_aiobotocore_sqs.paginator模块包含所有分页器的类型注释。

from aiobotocore.session import get_session

from types_aiobotocore_sqs import SQSClient
from types_aiobotocore_sqs.paginator import ListDeadLetterSourceQueuesPaginator, ListQueuesPaginator

session = get_session()
async with session.create_client("sqs") as client:
    client: SQSClient

    # 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为aiobotocore.resource("sqs").

from aiobotocore.session import get_session

from types_aiobotocore_sqs import SQSServiceResource

session = get_session()
async with session.resource("sqs") as resource:
    resource: SQSServiceResource
    # now resource usage is checked by mypy and IDE should provide code completion

其他资源注释

types_aiobotocore_sqs.service_resource模块包含所有资源的类型注释。

from aiobotocore.session import get_session

from types_aiobotocore_sqs import SQSServiceResource
from types_aiobotocore_sqs.service_resource import Message, Queue

session = get_session()
async with session.resource("sqs") as resource:
    resource: SQSServiceResource

    # 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(...)

集合注释

types_aiobotocore_sqs.service_resource模块包含所有SQSServiceResource集合的类型注释。

from aiobotocore.session import get_session

from types_aiobotocore_sqs import SQSServiceResource
from types_aiobotocore_sqs.service_resource import ServiceResourceQueuesCollection

session = get_session()
async with session.resource("sqs") as resource:
    resource: SQSServiceResource

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

字面量

types_aiobotocore_sqs.literals模块包含从形状中提取的文字，可在用户代码中用于类型检查。

from types_aiobotocore_sqs.literals import (
    ListDeadLetterSourceQueuesPaginatorName,
    ListQueuesPaginatorName,
    MessageSystemAttributeNameForSendsType,
    MessageSystemAttributeNameType,
    QueueAttributeFilterType,
    QueueAttributeNameType,
    SQSServiceName,
    ServiceName,
    ResourceServiceName,
    PaginatorName,
    RegionName,
)


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

打字字典

types_aiobotocore_sqs.type_defs模块包含组装到类型化字典的结构和形状，以进行额外的类型检查。

from types_aiobotocore_sqs.type_defs import (
    AddPermissionRequestQueueAddPermissionTypeDef,
    AddPermissionRequestRequestTypeDef,
    BatchResultErrorEntryTypeDef,
    ChangeMessageVisibilityBatchRequestEntryTypeDef,
    ChangeMessageVisibilityBatchResultEntryTypeDef,
    ResponseMetadataTypeDef,
    ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef,
    ChangeMessageVisibilityRequestRequestTypeDef,
    CreateQueueRequestRequestTypeDef,
    CreateQueueRequestServiceResourceCreateQueueTypeDef,
    DeleteMessageBatchRequestEntryTypeDef,
    DeleteMessageBatchResultEntryTypeDef,
    DeleteMessageRequestRequestTypeDef,
    DeleteQueueRequestRequestTypeDef,
    GetQueueAttributesRequestRequestTypeDef,
    GetQueueUrlRequestRequestTypeDef,
    GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef,
    PaginatorConfigTypeDef,
    ListDeadLetterSourceQueuesRequestRequestTypeDef,
    ListQueueTagsRequestRequestTypeDef,
    ListQueuesRequestRequestTypeDef,
    MessageAttributeValueTypeDef,
    MessageSystemAttributeValueTypeDef,
    PurgeQueueRequestRequestTypeDef,
    QueueMessageRequestTypeDef,
    ReceiveMessageRequestQueueReceiveMessagesTypeDef,
    ReceiveMessageRequestRequestTypeDef,
    RemovePermissionRequestQueueRemovePermissionTypeDef,
    RemovePermissionRequestRequestTypeDef,
    SendMessageBatchResultEntryTypeDef,
    ServiceResourceMessageRequestTypeDef,
    ServiceResourceQueueRequestTypeDef,
    SetQueueAttributesRequestQueueSetAttributesTypeDef,
    SetQueueAttributesRequestRequestTypeDef,
    TagQueueRequestRequestTypeDef,
    UntagQueueRequestRequestTypeDef,
    ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef,
    ChangeMessageVisibilityBatchRequestRequestTypeDef,
    ChangeMessageVisibilityBatchResultTypeDef,
    CreateQueueResultTypeDef,
    EmptyResponseMetadataTypeDef,
    GetQueueAttributesResultTypeDef,
    GetQueueUrlResultTypeDef,
    ListDeadLetterSourceQueuesResultTypeDef,
    ListQueueTagsResultTypeDef,
    ListQueuesResultTypeDef,
    SendMessageResultTypeDef,
    DeleteMessageBatchRequestQueueDeleteMessagesTypeDef,
    DeleteMessageBatchRequestRequestTypeDef,
    DeleteMessageBatchResultTypeDef,
    ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef,
    ListQueuesRequestListQueuesPaginateTypeDef,
    MessageTypeDef,
    SendMessageBatchRequestEntryTypeDef,
    SendMessageRequestQueueSendMessageTypeDef,
    SendMessageRequestRequestTypeDef,
    SendMessageBatchResultTypeDef,
    ReceiveMessageResultTypeDef,
    SendMessageBatchRequestQueueSendMessagesTypeDef,
    SendMessageBatchRequestRequestTypeDef,
)


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

这个怎么运作

全自动 的mypy-boto3-builder为每个服务仔细生成类型注解，耐心等待 aiobotocore更新。它为您提供插入式注释，并确保：

• 涵盖所有可用aiobotocore服务。
• 每个aiobotocore服务的每个公共类和方法都会从文档中提取有效的类型注释（botocore如果类型不正确，请归咎于文档）。
• 类型注释包括最新的文档。
• 每种方法都提供了文档链接。
• 为了可读性，代码由black和 isort处理。

什么是新的

实现的功能

• 全类型注释boto3和botocore库aiobotocore
• mypy, pyright, VSCode, PyCharm,Sublime Text和Emacs 兼容性
• Client, ServiceResource, Resource,Waiter Paginator为每个服务键入注释
• TypeDefs为每个服务生成
• Literals为每个服务生成
• 自动发现类型boto3.client和boto3.session调用
• 自动发现类型session.client和session.session调用
• 自动发现类型client.get_waiter和client.get_paginator 调用
• 自动发现类型ServiceResource和Resource集合
• 自动发现aiobotocore.Session.create_client呼叫类型

最新变化

生成器更改日志可以在 Releases中找到。

版本控制

types-aiobotocore-sqs版本与相关aiobotocore版本相同，遵循PEP 440格式。

谢谢

• Allie Fitter for boto3-type-annotations，这个包是基于他的工作
• 一个很棒的格式化工具的黑人开发者
• 蒂莫西·埃德蒙·克罗斯利 (Timothy Edmund Crosley ) 的 isort及其灵活度
• mypy开发人员为我们做了所有肮脏的工作
• pyright团队为类型化 Python 的新时代

文档

所有服务类型注释都可以在 aiobotocore 文档中找到

支持和贡献

这个包是自动生成的。请在mypy-boto3-builder存储库中报告任何错误或请求新功能 。