Type annotations for boto3.CloudSearchDomain 1.14.2 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudsearchdomain
Type annotations for boto3.CloudSearchDomain 1.14.2 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 CloudSearchDomain
service.
python -m pip install boto3-stubs[cloudsearchdomain]
How to use
Client annotations
CloudSearchDomainClient
provides annotations for boto3.client("cloudsearchdomain")
.
import boto3
from mypy_boto3_cloudsearchdomain import CloudSearchDomainClient
from mypy_boto3_cloudsearchdomain.type_defs import BucketInfoTypeDef, ...
client: CloudSearchDomainClient = boto3.client("cloudsearchdomain")
# 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: CloudSearchDomainClient = session.client("cloudsearchdomain")
Typed dictionations
mypy_boto3_cloudsearchdomain.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> BucketInfoTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cloudsearchdomain
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("cloudsearchdomain")
session_client = boto3.Session().client("cloudsearchdomain")
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-cloudsearchdomain-1.14.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2fb24fa9c49468dc598ed4cc71fe6e0b0965b9fb03c3ee6e6938fc3a60f25362 |
|
MD5 | 0806023ac18fabd7dbc3b21a768cf63c |
|
BLAKE2b-256 | e93977875fdc7afaca2266c26c875a34e3cbc9de28d3106b2b87df5ac998e3d4 |
Hashes for mypy_boto3_cloudsearchdomain-1.14.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0205a1127af9f1a22ac4b677fd6fe14a9d538c412814e430b6cf7e4e086e170b |
|
MD5 | 2575ad02db807064ba856a6144114f51 |
|
BLAKE2b-256 | 7b42836fdfa6b8231983aed1f03a46b4dd5bea897c50dcdca0fa5b6bbcdc06c3 |