Type annotations for boto3.IoT1ClickDevicesService 1.14.6 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-iot1click-devices
Type annotations for boto3.IoT1ClickDevicesService 1.14.6 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.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d59ea92c4992f3c95fd6c13b06f930aed3bff660e8c7af80a79c71fbf9b64ed |
|
MD5 | de0339ab24e8db8b809c9220898e4a24 |
|
BLAKE2b-256 | 5a8196f1d55dc3c47bb975c98408d6119bc9c4cda48ab89aa9578ce41a5ebd03 |
Hashes for mypy_boto3_iot1click_devices-1.14.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8753b4a9e90dd3e7fd4bc33a0666064f809391fb4a24caa86dfc22a2032339a8 |
|
MD5 | 265f6f0ee6f29d30c2287c1e3495966c |
|
BLAKE2b-256 | 0724c1ad87ddf88121ad4de7a97c36df3f8636d3b0635866515bd40b78c27f52 |