Type annotations for boto3.Kendra 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-kendra
Type annotations for boto3.Kendra 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 Kendra
service.
python -m pip install boto3-stubs[kendra]
How to use
Client annotations
KendraClient
provides annotations for boto3.client("kendra")
.
import boto3
from mypy_boto3_kendra import KendraClient
client: KendraClient = boto3.client("kendra")
# 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: KendraClient = session.client("kendra")
Typed dictionations
mypy_boto3_kendra.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_kendra.type_defs import AccessControlListConfigurationTypeDef, ...
def get_structure() -> AccessControlListConfigurationTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_kendra
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("kendra")
session_client = boto3.Session().client("kendra")
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-kendra-1.14.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfc5862e02ded3f02b981cb6a24db8e6331569c8fd58d39dd2e527eb320a8e94 |
|
MD5 | e5fd46a179e70a84c90333f2fd6450cd |
|
BLAKE2b-256 | c1c0b051c931cd04c4931275a9acc884c33ef0356c59102f74c65807c35ca972 |
Hashes for mypy_boto3_kendra-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cca0b633c75361785e7b757fce88c8783b74f263e0fe2b6ee9007fa7808bd2e5 |
|
MD5 | 8dc5b40e25652c2c33c1cfc291362b6a |
|
BLAKE2b-256 | 0841454e0ecdca198d2236b0bf1cd5a949c2919a3eb0dd87887e9c7890558d59 |