Type annotations for boto3.CognitoSync 1.14.1 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cognito-sync
Type annotations for boto3.CognitoSync 1.14.1 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 CognitoSync
service.
python -m pip install boto3-stubs[cognito-sync]
How to use
Client annotations
CognitoSyncClient
provides annotations for boto3.client("cognito-sync")
.
import boto3
from mypy_boto3_cognito_sync import CognitoSyncClient
from mypy_boto3_cognito_sync.type_defs import CognitoStreamsTypeDef, ...
client: CognitoSyncClient = boto3.client("cognito-sync")
# 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: CognitoSyncClient = session.client("cognito-sync")
Typed dictionations
mypy_boto3_cognito_sync.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> CognitoStreamsTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cognito_sync
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("cognito-sync")
session_client = boto3.Session().client("cognito-sync")
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-cognito-sync-1.14.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbacf88375b3ebfeff7803447d8882b4d2451b3b443e7f89b98ffc2b9ec8a0a7 |
|
MD5 | b3e8906ff201fb2e1375815f5b5cd35b |
|
BLAKE2b-256 | 8525eccb28702553a0215901e5035db7fc98203a3b9719cce5b8c0e9da8267a2 |
Hashes for mypy_boto3_cognito_sync-1.14.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 343cd3e6954353dd7ef70bb9c66c8bc5bcf764cc688ef27fe6e5c98415c6343f |
|
MD5 | 5ac73dc7b3de8dacc74a65149831a0b3 |
|
BLAKE2b-256 | 55e3b0f449ca3388015a303eb0e91f245ef175590240d5a95efffcc0a4c60001 |