Type annotations for boto3.Kendra 1.14.1 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-kendra
Type annotations for boto3.Kendra 1.14.1 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 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
from mypy_boto3_kendra.type_defs import AccessControlListConfigurationTypeDef, ...
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.
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
# 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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe506b3c388eb611b9d4a59d7c99794df0ead6c61bf5f2da11c10b2feca1ba7d |
|
MD5 | 44eb0b2bf20da853c553ab8202c8bfe1 |
|
BLAKE2b-256 | acf6cdbb60bc999ca41f0c77a4b810417b7394563fef6530c55f9ccd35a56e00 |
Hashes for mypy_boto3_kendra-1.14.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 543199e95c842f9db0e3c974a0e62e9634f7265dd43b08916beaa531980659f5 |
|
MD5 | 708ad05041a4d5e5de5ec995c50dc234 |
|
BLAKE2b-256 | a62b5e559962f54ad4e0030e3d86e48af355f9147a87d221f08c3d852030a150 |