Type annotations for boto3.QLDB 1.18.42 service, generated by mypy-boto3-builder 5.2.0
Project description
mypy-boto3-qldb
Type annotations for boto3.QLDB 1.18.42 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated by mypy-boto3-builder 5.2.0.
More information can be found on boto3-stubs page and in mypy-boto3-qldb docs
See how it helps to find and fix potential bugs:
How to install
Install boto3-stubs
for QLDB
service.
python -m pip install boto3-stubs[qldb]
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylance
as your Python Language Server - Install
boto-stubs[qldb]
in your environment:python -m pip install 'boto3-stubs[qldb]'
Both type checking and auto-complete should work for QLDB
service. No
explicit type annotations required, write your boto3
code as usual.
PyCharm
- Install
boto-stubs[qldb]
in your environment:python -m pip install 'boto3-stubs[qldb]'
Both type checking and auto-complete should work for QLDB
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 supports mypy
or pyright
, everything
should work.
mypy
- Install
mypy
:python -m pip install mypy
- Install
boto-stubs[qldb]
in your environment:python -m pip install 'boto3-stubs[qldb]'
- Run
mypy
as usual
Type checking should work for QLDB
service. No explicit type annotations
required, write your boto3
code as usual.
pyright
- Install
pyright
:yarn global add pyright
- Install
boto-stubs[qldb]
in your environment:python -m pip install 'boto3-stubs[qldb]'
- Optionally, you can install
boto3-stubs
totypings
folder.
Type checking should work for QLDB
service. No explicit type annotations
required, write your boto3
code as usual.
Explicit type annotations
Client annotations
QLDBClient
provides annotations for boto3.client("qldb")
.
import boto3
from mypy_boto3_qldb import QLDBClient
client: QLDBClient = boto3.client("qldb")
# 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: QLDBClient = session.client("qldb")
Literals
mypy_boto3_qldb.literals
module contains literals extracted from shapes that
can be used in user code for type checking.
from mypy_boto3_qldb.literals import (
EncryptionStatusType,
ErrorCauseType,
ExportStatusType,
LedgerStateType,
PermissionsModeType,
S3ObjectEncryptionTypeType,
StreamStatusType,
)
def check_value(value: EncryptionStatusType) -> bool:
...
Typed dictionaries
mypy_boto3_qldb.type_defs
module contains structures and shapes assembled to
typed dictionaries for additional type checking.
from mypy_boto3_qldb.type_defs import (
CancelJournalKinesisStreamRequestRequestTypeDef,
CancelJournalKinesisStreamResponseTypeDef,
CreateLedgerRequestRequestTypeDef,
CreateLedgerResponseTypeDef,
DeleteLedgerRequestRequestTypeDef,
DescribeJournalKinesisStreamRequestRequestTypeDef,
DescribeJournalKinesisStreamResponseTypeDef,
DescribeJournalS3ExportRequestRequestTypeDef,
DescribeJournalS3ExportResponseTypeDef,
DescribeLedgerRequestRequestTypeDef,
DescribeLedgerResponseTypeDef,
ExportJournalToS3RequestRequestTypeDef,
ExportJournalToS3ResponseTypeDef,
GetBlockRequestRequestTypeDef,
GetBlockResponseTypeDef,
GetDigestRequestRequestTypeDef,
GetDigestResponseTypeDef,
GetRevisionRequestRequestTypeDef,
GetRevisionResponseTypeDef,
JournalKinesisStreamDescriptionTypeDef,
JournalS3ExportDescriptionTypeDef,
KinesisConfigurationTypeDef,
LedgerEncryptionDescriptionTypeDef,
LedgerSummaryTypeDef,
ListJournalKinesisStreamsForLedgerRequestRequestTypeDef,
ListJournalKinesisStreamsForLedgerResponseTypeDef,
ListJournalS3ExportsForLedgerRequestRequestTypeDef,
ListJournalS3ExportsForLedgerResponseTypeDef,
ListJournalS3ExportsRequestRequestTypeDef,
ListJournalS3ExportsResponseTypeDef,
ListLedgersRequestRequestTypeDef,
ListLedgersResponseTypeDef,
ListTagsForResourceRequestRequestTypeDef,
ListTagsForResourceResponseTypeDef,
ResponseMetadataTypeDef,
S3EncryptionConfigurationTypeDef,
S3ExportConfigurationTypeDef,
StreamJournalToKinesisRequestRequestTypeDef,
StreamJournalToKinesisResponseTypeDef,
TagResourceRequestRequestTypeDef,
UntagResourceRequestRequestTypeDef,
UpdateLedgerPermissionsModeRequestRequestTypeDef,
UpdateLedgerPermissionsModeResponseTypeDef,
UpdateLedgerRequestRequestTypeDef,
UpdateLedgerResponseTypeDef,
ValueHolderTypeDef,
)
def get_structure() -> CancelJournalKinesisStreamRequestRequestTypeDef:
return {
...
}
Versioning
mypy-boto3-qldb
version is the same as related boto3
version and follows
PEP 440 format.
Documentation
All type annotations can be found in mypy-boto3-qldb 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_qldb-1.18.42-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c10d3870e7eb67d6e285703a3c0ac5cb7f028850ac247baa05736ef708c8e4a4 |
|
MD5 | 3381b74584b595cf356f0aae788aca6a |
|
BLAKE2b-256 | 62037d1f077611b6f68a7616b0ce38007bd24e1fd80b0067df45ffba606b1a7f |