Skip to main content

Type annotations for boto3.CloudHSMV2 1.14.11 service, generated by mypy-boto3-buider 2.2.0

Project description

mypy-boto3-cloudhsmv2

PyPI - mypy-boto3-cloudhsmv2 PyPI - Python Version Docs

Type annotations for boto3.CloudHSMV2 1.14.11 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 expected
  • PyCharm also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installed
  • VSCode 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

mypy-boto3-cloudhsmv2-1.14.11.0.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

mypy_boto3_cloudhsmv2-1.14.11.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file mypy-boto3-cloudhsmv2-1.14.11.0.tar.gz.

File metadata

  • Download URL: mypy-boto3-cloudhsmv2-1.14.11.0.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

File hashes

Hashes for mypy-boto3-cloudhsmv2-1.14.11.0.tar.gz
Algorithm Hash digest
SHA256 a33875b0b88900478a763fd1b81c46c35137d4538670d2280030b4a3756431d5
MD5 f3de2b7846bcd5459da3ed9e33b349d8
BLAKE2b-256 354ff2113a8519cb888b43f7ef7d3787195b85eeae373765a04b8f643becee78

See more details on using hashes here.

File details

Details for the file mypy_boto3_cloudhsmv2-1.14.11.0-py3-none-any.whl.

File metadata

  • Download URL: mypy_boto3_cloudhsmv2-1.14.11.0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

File hashes

Hashes for mypy_boto3_cloudhsmv2-1.14.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 58bae0ce70149d10b4a77e6cfd210daaf508ad21f42987d1d5bee56f2d61ace7
MD5 5bea52909913c9cef979877f023ec8a0
BLAKE2b-256 92276f1a8f441d9f70b9a095749d5f3f02cc5f177aae1856c6f6bd056cb06c45

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page