Type annotations for boto3.CloudSearch 1.14.2 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudsearch
Type annotations for boto3.CloudSearch 1.14.2 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 CloudSearch
service.
python -m pip install boto3-stubs[cloudsearch]
How to use
Client annotations
CloudSearchClient
provides annotations for boto3.client("cloudsearch")
.
import boto3
from mypy_boto3_cloudsearch import CloudSearchClient
from mypy_boto3_cloudsearch.type_defs import AccessPoliciesStatusTypeDef, ...
client: CloudSearchClient = boto3.client("cloudsearch")
# 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: CloudSearchClient = session.client("cloudsearch")
Typed dictionations
mypy_boto3_cloudsearch.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AccessPoliciesStatusTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cloudsearch
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("cloudsearch")
session_client = boto3.Session().client("cloudsearch")
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-cloudsearch-1.14.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 048eafa1cfd667d25e34b1e0068278b45c5183ba8eb8a7e8bf0e6e0c3a8edffc |
|
MD5 | 10dfebe41dd6c7f908ebd12f07ffa8f5 |
|
BLAKE2b-256 | 461f4e3f95df32ec5fa175534b3bcd4cfe7d594b96d86ee28e358bf0517e7ea3 |
Hashes for mypy_boto3_cloudsearch-1.14.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 008f4f015c32d2fbaa2ae36c109bd30e16ba2b96799f5ab0a0c99bedf844a90d |
|
MD5 | b562ad71e772710483edc1b523aa5d28 |
|
BLAKE2b-256 | 479c687aeba4dccd1c1b3d6ed2295728ac7021ad3216f25d3cb32496b28113af |