Type annotations for boto3.CloudHSMV2 1.14.23 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudhsmv2
Type annotations for boto3.CloudHSMV2 1.14.23 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 CloudHSMV2
service.
python -m pip install boto3-stubs[cloudhsmv2]
How to use
Client annotations
CloudHSMV2Client
provides annotations for boto3.client("cloudhsmv2")
.
import boto3
from mypy_boto3_cloudhsmv2 import CloudHSMV2Client
from mypy_boto3_cloudhsmv2.paginator import (
DescribeBackupsPaginator,
DescribeClustersPaginator,
ListTagsPaginator,
)
from mypy_boto3_cloudhsmv2.type_defs import BackupTypeDef, ...
client: CloudHSMV2Client = boto3.client("cloudhsmv2")
# 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: CloudHSMV2Client = session.client("cloudhsmv2")
Paginators annotations
mypy_boto3_cloudhsmv2.paginator
module contains type annotations for all paginators.
client: CloudHSMV2Client = boto3.client("cloudhsmv2")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_backups_paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups")
describe_clusters_paginator: DescribeClustersPaginator = client.get_paginator("describe_clusters")
list_tags_paginator: ListTagsPaginator = client.get_paginator("list_tags")
Typed dictionations
mypy_boto3_cloudhsmv2.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> BackupTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cloudhsmv2
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("cloudhsmv2")
session_client = boto3.Session().client("cloudhsmv2")
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-cloudhsmv2-1.14.23.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93c3b205545b7d802d47cffa0e34645b6a289e1c49b363bf9086c39d114e9257 |
|
MD5 | 757209f3485770b9c6ecf26adf2815d1 |
|
BLAKE2b-256 | 95583953b32d92c2b91cde32f7c9d9c34de1f9ecc8b7b1f6732bf4b17714862e |
Hashes for mypy_boto3_cloudhsmv2-1.14.23.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27f6c7bc1a952a9e4c429d1667ec76b68a5e1ce15f4f67cefff403b638f34f17 |
|
MD5 | 03f555074654ef448c04da72b813cb9c |
|
BLAKE2b-256 | fa5266a0e5837937de4152df88b1b593d671098f30fb27af75169bf33e410c74 |