Type annotations for boto3.IoT1ClickDevicesService 1.14.4 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-iot1click-devices
Type annotations for boto3.IoT1ClickDevicesService 1.14.4 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for IoT1ClickDevicesService
service.
python -m pip install boto3-stubs[iot1click-devices]
How to use
Client annotations
IoT1ClickDevicesServiceClient
provides annotations for boto3.client("iot1click-devices")
.
import boto3
from mypy_boto3_iot1click_devices import IoT1ClickDevicesServiceClient
from mypy_boto3_iot1click_devices.paginator import ListDeviceEventsPaginator, ListDevicesPaginator
from mypy_boto3_iot1click_devices.type_defs import DeviceDescriptionTypeDef, ...
client: IoT1ClickDevicesServiceClient = boto3.client("iot1click-devices")
# 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: IoT1ClickDevicesServiceClient = session.client("iot1click-devices")
Paginators annotations
mypy_boto3_iot1click_devices.paginator
module contains type annotations for all paginators.
client: IoT1ClickDevicesServiceClient = boto3.client("iot1click-devices")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_device_events_paginator: ListDeviceEventsPaginator = client.get_paginator("list_device_events")
list_devices_paginator: ListDevicesPaginator = client.get_paginator("list_devices")
Typed dictionations
mypy_boto3_iot1click_devices.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> DeviceDescriptionTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_iot1click_devices
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("iot1click-devices")
session_client = boto3.Session().client("iot1click-devices")
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 mypy-boto3-iot1click-devices-1.14.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e85264c93cc88eed04099ab8acec439de2cd1ef27b58005f42435530dc13cbe |
|
MD5 | 09d29ed1bc31ed457fcb9cfd4c37d458 |
|
BLAKE2b-256 | e8f6b46cfa9afa70947db274e73afa6fe742765210de0ba403d5e5e0254ae911 |
Hashes for mypy_boto3_iot1click_devices-1.14.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d9c3a8be6e245e5c2aad67c9f45945a2881c86eb188558410cdc45b46dbbfea |
|
MD5 | 95c5108a7d24e8e9d2e80bd25d470cbb |
|
BLAKE2b-256 | 610d72e25985166d38b783ae63529f3be8779bec167f703dd96c128a7495c8dd |