Type annotations for boto3.CloudHSM 1.14.4 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudhsm
Type annotations for boto3.CloudHSM 1.14.4 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 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
from mypy_boto3_cloudhsm.paginator import (
ListHapgsPaginator,
ListHsmsPaginator,
ListLunaClientsPaginator,
)
from mypy_boto3_cloudhsm.type_defs import TagTypeDef, ...
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.
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.
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
# 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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d626b46fe91aec98ada5cda7dbdb809e1cfa31e4b00221d01b3647f133fc2187 |
|
MD5 | f5785822b16e3dbd07342be2468062ea |
|
BLAKE2b-256 | 1cd7016d32e3ddbdbd5b85e9914435fbb860f82c69a2b5d05d9745a6ba06dcf3 |
Hashes for mypy_boto3_cloudhsm-1.14.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69a742487de582b0aa2a9e56dd8684412d4447f8fdb9dd96b4886cd7bda62da1 |
|
MD5 | 8195a21fc8dd88a2de124252ea854993 |
|
BLAKE2b-256 | aba762700283f3d82c91ce8136be87442aae6654911a4cbeba2ec1db28e984e9 |