Type annotations for boto3.CloudSearch 1.14.3 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudsearch
Type annotations for boto3.CloudSearch 1.14.3 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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60716c16333bc19009b72a76dd09336206e3894f7aca605876b63589993cc99f |
|
MD5 | ebd2fc963ffb0ae791067e318cde501d |
|
BLAKE2b-256 | af3b064ca0f7a9c3f46096f74ee653e8c2b4fe1dcb77a96c41792acae7f4f7ca |
Hashes for mypy_boto3_cloudsearch-1.14.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbc6b5f530a9c31fa20cbd17e5ba9ec61c2ec88c74a70030d15aefc46efa293d |
|
MD5 | e55fd3883b9fc70265619cf0f25da355 |
|
BLAKE2b-256 | 6d1791d936dc8e95390c88c7797a9e99daf40e510235aa35b632114e99f1c8e6 |