Type annotations for boto3.CloudSearchDomain 1.14.28 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudsearchdomain
Type annotations for boto3.CloudSearchDomain 1.14.28 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.28.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a0abd3425495ccb8c5dcfcb9ff60acec572e1469979dca0406d1fb9fbd9fe5c |
|
MD5 | a7c1d6206b3c5238a032adf948efc268 |
|
BLAKE2b-256 | e5c07b6dd122864e6b02c10ebd9428a582d0b2cbfe75b358fd4d69730c290c42 |
Hashes for mypy_boto3_cloudsearchdomain-1.14.28.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 569e363be592a063f57147a908d71e34228d882621b1052f3f4659abc1555fc0 |
|
MD5 | 1540a2be4768d50ac107ef8a9b55afa9 |
|
BLAKE2b-256 | 59f6438cd0c73b2cbb21b3ec6cb5f60d6fe05c6fb0ad61a98bfbc942a2ba7fe8 |