Type annotations for boto3.CloudSearch 1.14.26 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudsearch
Type annotations for boto3.CloudSearch 1.14.26 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.26.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 759c543e4c1a7d489a452907a79c888fba51f688a5de9f76e6d2c821f83bc040 |
|
MD5 | 5792579879fc653bdd11c9a0b44626ba |
|
BLAKE2b-256 | 458f421b130a7d29e16840aec3b6b31dc06583d5cee8e3c8e93c82a94838a103 |
Hashes for mypy_boto3_cloudsearch-1.14.26.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9898d5dd1e8b8b92db6a143a19f9367d7e61bd14079c5e7b9b1038e95552c6b9 |
|
MD5 | 88546c479a6c529a566cf45e459fd20f |
|
BLAKE2b-256 | 9631b0cac598d7f536ff3eaae28377a024ddeec695e7035b97f279c3b72b2ab9 |