Type annotations for boto3.CognitoIdentity 1.14.52 service, generated by mypy-boto3-buider 2.3.1
Project description
mypy-boto3-cognito-identity
Type annotations for boto3.CognitoIdentity 1.14.52 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.3.1.
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.52.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c571a38bc9f3effa76223caeca1743c0e79435e64bafc402ede67776d50946e |
|
MD5 | 23e2f2716780b513a231c018576d8420 |
|
BLAKE2b-256 | 50cf2c6ff14bc768122f683034098a4d9eafe9b1fd728dab7bc242886b08c348 |
Hashes for mypy_boto3_cognito_identity-1.14.52.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 660f5e248f1654b220f54633cd850115ec76808d2f23a052b00424bf9a9f1f9a |
|
MD5 | 68fc05294287d6c93d56412a60cb6bcd |
|
BLAKE2b-256 | 9abd6d47536ff3f6bb027dbbb04acc95a2c0c601715bf7edd0736848370b3ff3 |