Type annotations for boto3.CognitoSync 1.14.49 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cognito-sync
Type annotations for boto3.CognitoSync 1.14.49 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.49.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e07407f3e8a448b4fd76997db65e48db1854f3b7027a7b4f482f9cfe10768d93 |
|
MD5 | a22e21489035e442d9b7b622b0ac9b9a |
|
BLAKE2b-256 | 22afa1599f44de78b7f59999d05e3efddd46b5bd5ac4b4408fcdbf329083e7c0 |
Hashes for mypy_boto3_cognito_sync-1.14.49.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88ecb37ed9cba975d667e0aa579d64389fb17868ccfb00d8163b8a14451b3166 |
|
MD5 | ccf942b11ebf463f46e35c12c4081ef8 |
|
BLAKE2b-256 | 128fa1a3e144d544d7cd7b938ef56fbac155a351ced1ac39bfab77865a2ec687 |