Type annotations for boto3.CloudSearchDomain 1.14.29 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudsearchdomain
Type annotations for boto3.CloudSearchDomain 1.14.29 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.29.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2c40e232607d78905e103d4e3b5ec7cca9e096ced05468204b2c37f6d57341f |
|
MD5 | f96c2943cf9bebfe52ec75089d14d959 |
|
BLAKE2b-256 | 93f3491884bbb8c1ab664b0527feedf985a72f8bd2bb8654af8c612a68bc80a3 |
Hashes for mypy_boto3_cloudsearchdomain-1.14.29.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb784fe8a2016fa4e8b8a527fa2a1db3c6e48007410b97b0b664dcf4fe39499f |
|
MD5 | 5f78ef5a5d0c916fd8fe9174b1635792 |
|
BLAKE2b-256 | 6ccc874bc426bc15d188665d13ba42e67decb62b5eddc7bdd7cafdd87fdfcaa9 |