Registry / type-stubs / mypy-boto3-cloudhsm

mypy-boto3-cloudhsm

JSON →
library1.42.3pypypiunverified

mypy-boto3-cloudhsm provides type annotations for the AWS CloudHSM service, designed to be used with `boto3`. It enhances development experience by enabling static type checking with tools like MyPy, Pylance, and IDEs like VSCode and PyCharm. The package is part of the `mypy-boto3-builder` ecosystem, which generates stubs for all `boto3` services, often releasing updates aligned with `boto3` and botocore releases.

type-stubsaws
Install & Compatibility
Where this runs
tested against v1.43.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.925 runs
installs and imports cleanly · install 0.0s · import 0.604s · 51.3MB
glibc
py 3.103.925 runs
installs and imports cleanly · install 3.8s · import 0.559s · 52MB
50MB installed
● package 50MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

from mypy_boto3_cloudhsm import CloudHSMClient
from mypy_boto3_cloudhsm.type_defs import ListHsmsResponseTypeDef

This quickstart demonstrates how to use `mypy-boto3-cloudhsm` for type hinting with a `boto3` CloudHSM client. The `TYPE_CHECKING` block ensures that type-hint-specific imports and assignments are only evaluated by type checkers and not at runtime, avoiding unnecessary dependencies in production. Remember to install `boto3` alongside `mypy-boto3-cloudhsm`.

import boto3 from typing import TYPE_CHECKING if TYPE_CHECKING: from mypy_boto3_cloudhsm import CloudHSMClient from mypy_boto3_cloudhsm.type_defs import ListHsmsResponseTypeDef # Initialize a boto3 client (runtime code) client = boto3.client("cloudhsm") # Type hint the client for static analysis if TYPE_CHECKING: typed_client: CloudHSMClient = client response: ListHsmsResponseTypeDef = typed_client.list_hsms() # Example of using the client (runtime code) # For a real application, consider error handling and pagination list_hsms_response = client.list_hsms() print(f"CloudHSM HSMs: {list_hsms_response.get('Hsms', [])}")
Debug
Known footguns
breakingPython 3.8 support has been removed. All `mypy-boto3-*` packages, including `mypy-boto3-cloudhsm`, now require Python 3.9 or higher due to changes in `mypy-boto3-builder` version 8.12.0.
breakingPackages generated by `mypy-boto3-builder` (version 8.12.0 and above) now follow PEP 561 for distributing type information. This change might affect how type checkers discover and apply stubs in certain environments or older project configurations.
gotchaThis library provides *only* type annotations for the AWS CloudHSM service. You must install the `boto3` library separately for actual runtime functionality and API calls. `mypy-boto3-cloudhsm` is not a standalone AWS SDK.
gotchaFor optimal type checking accuracy, it is recommended to keep the `mypy-boto3-cloudhsm` version aligned with the major and minor version of your `boto3` installation. The stubs are generated based on specific AWS API versions, and mismatches can lead to incomplete or incorrect type hints.
breakingBreaking changes to TypeDef naming conventions (e.g., shorter names for packed method arguments, conflict resolution) were introduced in `mypy-boto3-builder` version 8.9.0. While described generally for 'services', these changes can affect any service's generated TypeDefs, including CloudHSM.
Upgrade
Version history

Breaking-change detection hasn't run for this library yet.

Audit
Security & dependencies

CVE tracking and dependency tree are planned for a later release.

Agent activity
22 hits · last 30 days
gptbot
4
ahrefsbot
4
bytedance
4
script
1
Resources