Type annotations for boto3.CloudHSMV2 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-cloudhsmv2
Type annotations for boto3.CloudHSMV2 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 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
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.
from mypy_boto3_cloudhsmv2 import CloudHSMV2Client
from mypy_boto3_cloudhsmv2.paginator import (
DescribeBackupsPaginator,
DescribeClustersPaginator,
ListTagsPaginator,
)
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.
from mypy_boto3_cloudhsmv2.type_defs import BackupTypeDef, ...
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
import boto3
# 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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37326d828e92ac4e9b8413f822b2ce42747548f4df5d3821861f73378edf7ffa |
|
MD5 | c6a792c65f246fca0f4b3f1943ab3e9e |
|
BLAKE2b-256 | 9a4142af296fc03e7c05d1d40f403803c37e45332b0ab680f05457aef5829f6f |
Hashes for mypy_boto3_cloudhsmv2-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7029e99cb8e67af12f20feceea9e546e1189dc7cacdba00f12afefe2dd249810 |
|
MD5 | 4040e6185b40c6b31084f91f00891e3d |
|
BLAKE2b-256 | c5b80a8361af1ff49c5affcbd0c58954e71ddf77771702e5273762b1258419a5 |