Type annotations for boto3.CloudSearch 1.14.17 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudsearch
Type annotations for boto3.CloudSearch 1.14.17 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.17.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 138da6bac055566f54aa4ce24ca214ba8845f1448cf7ab2d8ae5737729640dd2 |
|
MD5 | ca49e277ff55ef1f12695a0f11267530 |
|
BLAKE2b-256 | 88ff9e06547390e99a91920f2a03a4daa19ea86db68528a20350ce5be4cc6cc3 |
Hashes for mypy_boto3_cloudsearch-1.14.17.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3ac7b1705c587a2c973d54f8aa5dfbe7048b44534a1f16bb4b4e4564236f05a |
|
MD5 | db2ede927c533eb97f0831806b495131 |
|
BLAKE2b-256 | 9803534c18de073082dd3f7fa499261987d6f2cd7132fec40ad6201343bc535a |