Type annotations for boto3.CloudSearch 1.14.13 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudsearch
Type annotations for boto3.CloudSearch 1.14.13 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.13.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5740b7b12b7bb0461872e77eb6d2abec3e60fde2774717d51e40729388074c6 |
|
MD5 | 8b2cb3afcd64051540b4acd51ecb264e |
|
BLAKE2b-256 | 52f947968dbc63aff1ce0e941a90f2d6abe937ce3f3839a6a1738f37a35abaff |
Hashes for mypy_boto3_cloudsearch-1.14.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b44379bb52f4b71c83a132b2598c35e16b32df8427683e23de8a57cd3b5beafa |
|
MD5 | 9d1520136d6a15393fe0a86bbba6f973 |
|
BLAKE2b-256 | c0ee68669fb126a07ae7e376bac534ca29932287b2826c79684ec5065a26c0b7 |