Type annotations for boto3.IoTAnalytics 1.14.12 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-iotanalytics
Type annotations for boto3.IoTAnalytics 1.14.12 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.12.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 242f8b842357d2d849379b47235393981c79d513c349a1a693acfce407b4f89e |
|
MD5 | 0d953a34b33ff9c60a8cdca1594569e7 |
|
BLAKE2b-256 | 18dd35eb2790a4888aea9ace372abcc9b1d83187630f589c36825d8e8d65f521 |
Hashes for mypy_boto3_iotanalytics-1.14.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cae68265ea12acf55a49a67a8835ac6b67d0cfddb8a08184b2d7ed63e1f24f7c |
|
MD5 | 9394bbab7be37bd6b93f0f25477706ef |
|
BLAKE2b-256 | ff34380285c6777f53dc21c2604cc8f763f30947fe3b0db7086fe0e48db79e05 |