Type annotations for boto3.IoTAnalytics 1.14.39 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-iotanalytics
Type annotations for boto3.IoTAnalytics 1.14.39 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 IoTAnalytics
service.
python -m pip install boto3-stubs[iotanalytics]
How to use
Client annotations
IoTAnalyticsClient
provides annotations for boto3.client("iotanalytics")
.
import boto3
from mypy_boto3_iotanalytics import IoTAnalyticsClient
from mypy_boto3_iotanalytics.paginator import (
ListChannelsPaginator,
ListDatasetContentsPaginator,
ListDatasetsPaginator,
ListDatastoresPaginator,
ListPipelinesPaginator,
)
from mypy_boto3_iotanalytics.type_defs import AddAttributesActivityTypeDef, ...
client: IoTAnalyticsClient = boto3.client("iotanalytics")
# 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: IoTAnalyticsClient = session.client("iotanalytics")
Paginators annotations
mypy_boto3_iotanalytics.paginator
module contains type annotations for all paginators.
client: IoTAnalyticsClient = boto3.client("iotanalytics")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels")
list_dataset_contents_paginator: ListDatasetContentsPaginator = client.get_paginator("list_dataset_contents")
list_datasets_paginator: ListDatasetsPaginator = client.get_paginator("list_datasets")
list_datastores_paginator: ListDatastoresPaginator = client.get_paginator("list_datastores")
list_pipelines_paginator: ListPipelinesPaginator = client.get_paginator("list_pipelines")
Typed dictionations
mypy_boto3_iotanalytics.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AddAttributesActivityTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_iotanalytics
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("iotanalytics")
session_client = boto3.Session().client("iotanalytics")
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-iotanalytics-1.14.39.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e563998305891617672f30b5ec84303f238e5d78018cb351efb41628b2b75c3c |
|
MD5 | 26e181244c09f1d12131fd0e494ec742 |
|
BLAKE2b-256 | a73bdbc8dc420b517f0f1f0d9ba79f77dbf693f36f93ae552e72ff5d6ea607d0 |
Hashes for mypy_boto3_iotanalytics-1.14.39.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 875d3862c903c3d5536fdc98a3bb8fb99ea8a738495108926c52074ce895672b |
|
MD5 | e7d05ea79095258d1bf8aff6b71c7ab6 |
|
BLAKE2b-256 | 45b5235933e53e623764dab0508a1f3d1b20119b8725a2f45f2e31e056bff05d |