Type annotations for boto3.IoTThingsGraph 1.14.19 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-iotthingsgraph
Type annotations for boto3.IoTThingsGraph 1.14.19 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 IoTThingsGraph
service.
python -m pip install boto3-stubs[iotthingsgraph]
How to use
Client annotations
IoTThingsGraphClient
provides annotations for boto3.client("iotthingsgraph")
.
import boto3
from mypy_boto3_iotthingsgraph import IoTThingsGraphClient
from mypy_boto3_iotthingsgraph.paginator import (
GetFlowTemplateRevisionsPaginator,
GetSystemTemplateRevisionsPaginator,
ListFlowExecutionMessagesPaginator,
ListTagsForResourcePaginator,
SearchEntitiesPaginator,
SearchFlowExecutionsPaginator,
SearchFlowTemplatesPaginator,
SearchSystemInstancesPaginator,
SearchSystemTemplatesPaginator,
SearchThingsPaginator,
)
from mypy_boto3_iotthingsgraph.type_defs import DefinitionDocumentTypeDef, ...
client: IoTThingsGraphClient = boto3.client("iotthingsgraph")
# 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: IoTThingsGraphClient = session.client("iotthingsgraph")
Paginators annotations
mypy_boto3_iotthingsgraph.paginator
module contains type annotations for all paginators.
client: IoTThingsGraphClient = boto3.client("iotthingsgraph")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
get_flow_template_revisions_paginator: GetFlowTemplateRevisionsPaginator = client.get_paginator("get_flow_template_revisions")
get_system_template_revisions_paginator: GetSystemTemplateRevisionsPaginator = client.get_paginator("get_system_template_revisions")
list_flow_execution_messages_paginator: ListFlowExecutionMessagesPaginator = client.get_paginator("list_flow_execution_messages")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
search_entities_paginator: SearchEntitiesPaginator = client.get_paginator("search_entities")
search_flow_executions_paginator: SearchFlowExecutionsPaginator = client.get_paginator("search_flow_executions")
search_flow_templates_paginator: SearchFlowTemplatesPaginator = client.get_paginator("search_flow_templates")
search_system_instances_paginator: SearchSystemInstancesPaginator = client.get_paginator("search_system_instances")
search_system_templates_paginator: SearchSystemTemplatesPaginator = client.get_paginator("search_system_templates")
search_things_paginator: SearchThingsPaginator = client.get_paginator("search_things")
Typed dictionations
mypy_boto3_iotthingsgraph.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> DefinitionDocumentTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_iotthingsgraph
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("iotthingsgraph")
session_client = boto3.Session().client("iotthingsgraph")
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-iotthingsgraph-1.14.19.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58bcd3b0cb7a4f048085753d2d4f301cd10f36446eda56c32136fadc17b1ec5b |
|
MD5 | 421df97ed07160c7bd0444c7311352a3 |
|
BLAKE2b-256 | 57fb550cd8d6d67b97db162ed0d38be8ac777539293499c475dfa737ea4ff40b |
Hashes for mypy_boto3_iotthingsgraph-1.14.19.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1e74435fb1144928dd4548306f603ea1ee3f58e5cef60ea09783bc427ec95ca |
|
MD5 | 1bb23ee9a61072cc58702ce83ceb6755 |
|
BLAKE2b-256 | aed6664905533906b69a6f3f5192e97c59f65a60df751448ba3b8498ab8b2f71 |