Type annotations for boto3.CloudSearch 1.14.11 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudsearch
Type annotations for boto3.CloudSearch 1.14.11 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.11.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8670c8434d04b8747f91f3a5a4083eace0f7e082261c01408bb200deaf791081 |
|
MD5 | daf689d9c0fddb3445480afc07a655f3 |
|
BLAKE2b-256 | 6f15794f1c6845af819567281d4d614246a4a829af19e19984a220686a79132e |
Hashes for mypy_boto3_cloudsearch-1.14.11.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4876912103dddf54ea31733584f08156be2af371b99ddbd56982951c48cb8865 |
|
MD5 | 0ac5e1e983d75dbd7dbef67773e15ba1 |
|
BLAKE2b-256 | a7ad722c7c7a1fa0b89f20c33bdc1a0960d863e7a0a5caa562bf0f44a4adbf4c |