Type annotations for boto3.CloudHSM 1.18.23 service, generated by mypy-boto3-builder 5.1.0
Project description
mypy-boto3-cloudhsm
Type annotations for boto3.CloudHSM 1.18.23 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated by mypy-boto3-builder 5.1.0.
More information can be found on boto3-stubs page and in mypy-boto3-cloudhsm docs
See how it helps to find and fix potential bugs:
How to install
Install boto3-stubs
for CloudHSM
service.
python -m pip install boto3-stubs[cloudhsm]
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylance
as your Python Language Server - Install
boto-stubs[cloudhsm]
in your environment:python -m pip install 'boto3-stubs[cloudhsm]'
Both type checking and auto-complete should work for CloudHSM
service. No
explicit type annotations required, write your boto3
code as usual.
PyCharm
- Install
boto-stubs[cloudhsm]
in your environment:python -m pip install 'boto3-stubs[cloudhsm]'
Both type checking and auto-complete should work for CloudHSM
service. No
explicit type annotations required, write your boto3
code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
boto3-stubs
submodules.
Other IDEs
Not tested, but as long as your IDE support mypy
or pyright
, everything
should work.
mypy
- Install
mypy
:python -m pip install mypy
- Install
boto-stubs[cloudhsm]
in your environment:python -m pip install 'boto3-stubs[cloudhsm]'
- Run
mypy
as usual
Type checking should work for CloudHSM
service. No explicit type annotations
required, write your boto3
code as usual.
pyright
- Install
pyright
:yarn global add pyright
- Install
boto-stubs[cloudhsm]
in your environment:python -m pip install 'boto3-stubs[cloudhsm]'
- Optionally, you can install
boto3-stubs
totypings
folder.
Type checking should work for CloudHSM
service. No explicit type annotations
required, write your boto3
code as usual.
Explicit type annotations
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")
Literals
mypy_boto3_cloudhsm.literals
module contains literals extracted from shapes
that can be used in user code for type checking.
from mypy_boto3_cloudhsm.literals import (
ClientVersionType,
CloudHsmObjectStateType,
HsmStatusType,
ListHapgsPaginatorName,
ListHsmsPaginatorName,
ListLunaClientsPaginatorName,
SubscriptionTypeType,
)
def check_value(value: ClientVersionType) -> bool:
...
Typed dictionaries
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 (
AddTagsToResourceRequestRequestTypeDef,
AddTagsToResourceResponseTypeDef,
CreateHapgRequestRequestTypeDef,
CreateHapgResponseTypeDef,
CreateHsmRequestRequestTypeDef,
CreateHsmResponseTypeDef,
CreateLunaClientRequestRequestTypeDef,
CreateLunaClientResponseTypeDef,
DeleteHapgRequestRequestTypeDef,
DeleteHapgResponseTypeDef,
DeleteHsmRequestRequestTypeDef,
DeleteHsmResponseTypeDef,
DeleteLunaClientRequestRequestTypeDef,
DeleteLunaClientResponseTypeDef,
DescribeHapgRequestRequestTypeDef,
DescribeHapgResponseTypeDef,
DescribeHsmRequestRequestTypeDef,
DescribeHsmResponseTypeDef,
DescribeLunaClientRequestRequestTypeDef,
DescribeLunaClientResponseTypeDef,
GetConfigRequestRequestTypeDef,
GetConfigResponseTypeDef,
ListAvailableZonesResponseTypeDef,
ListHapgsRequestRequestTypeDef,
ListHapgsResponseTypeDef,
ListHsmsRequestRequestTypeDef,
ListHsmsResponseTypeDef,
ListLunaClientsRequestRequestTypeDef,
ListLunaClientsResponseTypeDef,
ListTagsForResourceRequestRequestTypeDef,
ListTagsForResourceResponseTypeDef,
ModifyHapgRequestRequestTypeDef,
ModifyHapgResponseTypeDef,
ModifyHsmRequestRequestTypeDef,
ModifyHsmResponseTypeDef,
ModifyLunaClientRequestRequestTypeDef,
ModifyLunaClientResponseTypeDef,
PaginatorConfigTypeDef,
RemoveTagsFromResourceRequestRequestTypeDef,
RemoveTagsFromResourceResponseTypeDef,
ResponseMetadataTypeDef,
TagTypeDef,
)
def get_structure() -> AddTagsToResourceRequestRequestTypeDef:
return {
...
}
Versioning
mypy-boto3-cloudhsm
version is the same as related boto3
version and
follows PEP 440 format.
Documentation
All type annotations can be found in mypy-boto3-cloudhsm docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.
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.18.23.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb5b129932b986a41d7fd63581dbb293b7af425ba597613bf067532e6e6fcfca |
|
MD5 | 9ed9f73332703739b8c152c937468f83 |
|
BLAKE2b-256 | 0b8376c661f40716e2e65d7ea993eda0c46f1a685f7765180e32cca634d54dcd |
Hashes for mypy_boto3_cloudhsm-1.18.23-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12b2f874aadec9a0db65e8c281730b0e8ed3754bf54446fab90b00e75d125bb8 |
|
MD5 | 43995e1d0a1ad04feb384b0e177df4ca |
|
BLAKE2b-256 | 5d2b8fd41393ed1f1056654132002a0a788d11acf23e472d1e5f88d50dd4fe70 |