Type annotations for boto3.CognitoSync 1.14.19 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cognito-sync
Type annotations for boto3.CognitoSync 1.14.19 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.19.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 858a57a02d072637b0768ed2d5082a7e96026a14a7cca5f625cae4e6cfc968fe |
|
MD5 | 27ed859a8e684ec0d727bac5552b72b6 |
|
BLAKE2b-256 | 89d688da28439cac9f8000c0a4ceff6cfba716d6716a2bec09866a0564a8edc3 |
Hashes for mypy_boto3_cognito_sync-1.14.19.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c08805c15114bea067b05a8e202019b0793167ea727d0f45bd4cea6ced13303 |
|
MD5 | 9e8d77c5d8559fb8a15e7e70c167bfc8 |
|
BLAKE2b-256 | 1bf640d50ca03cabec2114dc0c8d6f7a3f680dd895c7bb2c9e263e7bc9e86c44 |