Type annotations for boto3.CognitoIdentity 1.14.24 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cognito-identity
Type annotations for boto3.CognitoIdentity 1.14.24 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.24.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a30cc6878973910160b6bf93d2c8ab30e2153249898a61df7ef9bf05972e56a8 |
|
MD5 | 70928454e1d1db6e10f8aeb30634a24d |
|
BLAKE2b-256 | c36e05094b68e5b61852362f1035371edc4ebf031ca89259cf084abe1768a017 |
Hashes for mypy_boto3_cognito_identity-1.14.24.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c21390431644d857c5530a06becf431155f9f34f92210fba060610d5b328dc3 |
|
MD5 | c8996cc7b6922f0b6b1a0451cee1f42d |
|
BLAKE2b-256 | 078c7188c59e2189e8bebae4c70e0ab25ea24f9f18ecde745257126255c7c30b |