Type annotations for boto3.CloudSearchDomain 1.14.15 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudsearchdomain
Type annotations for boto3.CloudSearchDomain 1.14.15 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.15.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3d8f6d8c1b7ec82b70439524adf94240ffba76ba690333c11d603e0caf7da95 |
|
MD5 | b945e7de62ae691a1c4306ece3590573 |
|
BLAKE2b-256 | 7a448a7493e2638aa45559af48f2fb182474e2a89d0f5e5bf460de18fa2c7091 |
Hashes for mypy_boto3_cloudsearchdomain-1.14.15.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65140a8797170232a17c35cd8e1a436da92ecc5b46ca381414dce58c41ab75d2 |
|
MD5 | 1fcca8bd1dc4a4133acd19a1bb713cce |
|
BLAKE2b-256 | 1026ce81e56085acb5c81cf3c36efebbb7d98989202a5162b50375f9066ee853 |