Type annotations for boto3.CloudHSM 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-cloudhsm
Type annotations for boto3.CloudHSM 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.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 CloudHSM
service.
python -m pip install boto3-stubs[cloudhsm]
How to use
Client annotations
CloudHSMClient
provides annotations for boto3.client("cloudhsm")
.
import boto3
from mypy_boto3_cloudhsm import CloudHSMClient
client: CloudHSMClient = boto3.client("cloudhsm")
# 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: CloudHSMClient = session.client("cloudhsm")
Paginators annotations
mypy_boto3_cloudhsm.paginator
module contains type annotations for all paginators.
from mypy_boto3_cloudhsm import CloudHSMClient
from mypy_boto3_cloudhsm.paginator import (
ListHapgsPaginator,
ListHsmsPaginator,
ListLunaClientsPaginator,
)
client: CloudHSMClient = boto3.client("cloudhsm")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_hapgs_paginator: ListHapgsPaginator = client.get_paginator("list_hapgs")
list_hsms_paginator: ListHsmsPaginator = client.get_paginator("list_hsms")
list_luna_clients_paginator: ListLunaClientsPaginator = client.get_paginator("list_luna_clients")
Typed dictionations
mypy_boto3_cloudhsm.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_cloudhsm.type_defs import TagTypeDef, ...
def get_structure() -> TagTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cloudhsm
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
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("cloudhsm")
session_client = boto3.Session().client("cloudhsm")
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-cloudhsm-1.14.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 576017473712d9c465837f3c1e5255766d611385cddb52a4f8d97c9470d93ed0 |
|
MD5 | 14d268c5f7070dc79bfa470b48f8ceba |
|
BLAKE2b-256 | dc6360b7b338f3a293766c91863e4945d3205d19f3b0ebef5178695c7ddb1d26 |
Hashes for mypy_boto3_cloudhsm-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 341ef38dcf8dad5ce4fe483eab02355ef60333f7c3bd9a15a6cba8e7f5e3b5e2 |
|
MD5 | 731a23b534aa9c9552124ada3dc85e21 |
|
BLAKE2b-256 | 706e30a1126a0308bdf9159ae869b9a6199f0bb2114bb5c541a5f83eb90ccebb |