Type annotations for boto3.CognitoIdentity 1.14.40 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cognito-identity
Type annotations for boto3.CognitoIdentity 1.14.40 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 CognitoIdentity
service.
python -m pip install boto3-stubs[cognito-identity]
How to use
Client annotations
CognitoIdentityClient
provides annotations for boto3.client("cognito-identity")
.
import boto3
from mypy_boto3_cognito_identity import CognitoIdentityClient
from mypy_boto3_cognito_identity.paginator import ListIdentityPoolsPaginator
from mypy_boto3_cognito_identity.type_defs import CognitoIdentityProviderTypeDef, ...
client: CognitoIdentityClient = boto3.client("cognito-identity")
# 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: CognitoIdentityClient = session.client("cognito-identity")
Paginators annotations
mypy_boto3_cognito_identity.paginator
module contains type annotations for all paginators.
client: CognitoIdentityClient = boto3.client("cognito-identity")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_identity_pools_paginator: ListIdentityPoolsPaginator = client.get_paginator("list_identity_pools")
Typed dictionations
mypy_boto3_cognito_identity.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> CognitoIdentityProviderTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cognito_identity
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-identity")
session_client = boto3.Session().client("cognito-identity")
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-identity-1.14.40.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d955148683b5a652d2edf061255fe6e19d852836eab83541fece5a51131de0e |
|
MD5 | 8c45d7d3a99a77614efc1be7ed947f9a |
|
BLAKE2b-256 | 56c865e83c72c5f74c7bec5968f0ee9dc0b191c8cf44dd92c832d58b83644a67 |
Hashes for mypy_boto3_cognito_identity-1.14.40.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1af8e51ff41262d5bf5468a382e9d2d65e4a8ef756d8d59aa701e2a5290030bb |
|
MD5 | 6d3682a7ec17752012bc04e5a84304d0 |
|
BLAKE2b-256 | 03b219ece96363997cbf715b742c634f5fa92138848775d1be6641e840afb763 |