mypy-boto3-iotthingsgraph Type Stubs

1.42.3 · active · verified Sat Apr 11

mypy-boto3-iotthingsgraph provides type annotations for the `boto3` IoTThingsGraph service client, compatible with static type checkers like MyPy, Pyright, and IDEs like VSCode and PyCharm. It helps in catching type-related errors early and improves code autocompletion. The library is actively maintained with releases frequently synchronized with `boto3` and its upstream `mypy-boto3-builder` versions.

Warnings

breaking Python 3.8 support has been removed since `mypy-boto3-builder 8.12.0`, which `mypy-boto3-iotthingsgraph 1.42.3` is based on. Projects requiring type stubs must now use Python 3.9 or higher.
Fix: Upgrade your Python environment to 3.9 or newer. Ensure your `requires_python` matches in your project configuration.
breaking The `mypy-boto3-builder` project migrated to PEP 561 compliant packages. While this generally improves compatibility with type checkers, users relying on specific older mechanisms for stub discovery might need to adjust their `mypy` configuration or package installation methods.
Fix: Ensure your type checker (e.g., MyPy) is up-to-date. If issues persist, verify that your project structure and `py.typed` markers (if applicable for custom setups) align with PEP 561 guidelines.
breaking TypeDef naming conventions were changed in `mypy-boto3-builder 8.9.0`. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`, and conflicting `Extra` postfixes were moved. This affects all generated type stubs, including IoTThingsGraph, potentially breaking existing type annotations for complex input/output structures.
Fix: Review and update `TypeDef` imports and usage in your codebase to match the new, shorter naming conventions as described in the release notes or the generated stub files.
gotcha The `mypy-boto3-iotthingsgraph` package provides *only* type annotations. You must install `boto3` separately to have the actual runtime AWS SDK functionality.
Fix: Always install both `boto3` and `mypy-boto3-iotthingsgraph` in your development environment: `pip install boto3 mypy-boto3-iotthingsgraph`.
gotcha To avoid adding `mypy-boto3-iotthingsgraph` as a runtime dependency to your deployed application, it is best practice to wrap all type stub imports within `if TYPE_CHECKING:` blocks.
Fix: Use `from typing import TYPE_CHECKING` and enclose `from mypy_boto3_...` imports inside an `if TYPE_CHECKING:` block. Your production environment only needs `boto3`.
deprecated The 'legacy `mypy-boto3`' packages were moved to a separate product and are no longer generated alongside `boto3-stubs` by the builder. If you were using the older `mypy-boto3` umbrella package, you should migrate to specific service packages like `mypy-boto3-iotthingsgraph` or the meta-package `boto3-stubs`.
Fix: Uninstall any legacy `mypy-boto3` packages and install the appropriate `mypy-boto3-servicename` packages or `boto3-stubs` with extras for the services you use.

Install

pip install mypy-boto3-iotthingsgraph boto3 Install with pip

Imports

IoTThingsGraphClient
```
from mypy_boto3_iotthingsgraph.client import IoTThingsGraphClient
```
Type stubs are imported from the `mypy_boto3_servicename` package, not directly from `boto3`.
ListFlowTemplatesResponseTypeDef
```
from mypy_boto3_iotthingsgraph.type_defs import ListFlowTemplatesResponseTypeDef
```
Specific TypeDefs for API response structures are available in the `type_defs` submodule.
TYPE_CHECKING
```
from typing import TYPE_CHECKING
```
It is best practice to import type stubs only within `if TYPE_CHECKING:` blocks to avoid runtime dependencies.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-iotthingsgraph` to add type hints to a boto3 IoTThingsGraph client. The `IoTThingsGraphClient` type from `mypy_boto3_iotthingsgraph.client` is used to explicitly type the `boto3.client('iotthingsgraph')` instance, enabling autocompletion and static analysis. The `TYPE_CHECKING` block ensures that these type-only imports are excluded at runtime.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_iotthingsgraph.client import IoTThingsGraphClient
    from mypy_boto3_iotthingsgraph.type_defs import ListFlowTemplatesResponseTypeDef


def get_iotthingsgraph_flow_templates() -> list[str]:
    client: IoTThingsGraphClient = boto3.client('iotthingsgraph')
    response: ListFlowTemplatesResponseTypeDef = client.list_flow_templates()
    template_names = [t['id'] for t in response.get('flowTemplates', [])]
    return template_names

# Example usage (will not run without AWS credentials and actual resources)
# print(get_iotthingsgraph_flow_templates())

view raw JSON →