Type annotations for boto3.CognitoSync 1.14.23 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cognito-sync
Type annotations for boto3.CognitoSync 1.14.23 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.23.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e607c2da384bee8bcb9881c71df2e2e50f44614c8aed7a5b234e57f3c4b96021 |
|
MD5 | 80d8a3e3bdad78abade6e11a0acea70e |
|
BLAKE2b-256 | eccddc06705c32b0831dab29cfce0d0b8e3a18d4630db2072838a80cf2a27968 |
Hashes for mypy_boto3_cognito_sync-1.14.23.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d4eea722dd234c49f39b22af154174ef7705b1d0a513833e34b506fb8e062d2 |
|
MD5 | 62ed8b3687880c3eff9d1bcaedfb40a0 |
|
BLAKE2b-256 | f71f1d4b4df17d712a57ebf2b9d3ac30ade469efd4ffeee7980123a7664f2a65 |