Type annotations for boto3.IoT1ClickDevicesService 1.14.20 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-iot1click-devices
Type annotations for boto3.IoT1ClickDevicesService 1.14.20 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.20.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a20aac4dae2eead800965e109a823c6fac6cf3d9978e1c9531c0a2c6fe3f625 |
|
MD5 | 1b00daa896973e7ef458af39367140e8 |
|
BLAKE2b-256 | cbb5d7026c0962aacbdcf2e4f8c0d1e66394afcd726869be6344a855b7b7e50c |
Hashes for mypy_boto3_iot1click_devices-1.14.20.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5058397b0987babf26b2af701c8d3b61aa8bbfc0cd04864bc2e4817fcbb3b6bc |
|
MD5 | f5b5e0e83fb61eaf801df191b3e9a68a |
|
BLAKE2b-256 | 4e3d6cd7129018a5cff0647b1074390b0402fc96e2b4202be2ba83104e45dfa1 |