Type annotations for boto3.CognitoIdentity 1.14.23 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cognito-identity
Type annotations for boto3.CognitoIdentity 1.14.23 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.23.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e144d2ebfc680927c01911792c1f35f8ca3994737728e83ddd9409ee6e7e51e1 |
|
MD5 | 4f65e81653beac807ff72be5cdf0e25b |
|
BLAKE2b-256 | 1c9f34ed209b8568561ffc3c574217f5fb3b4b636f86e50f703cba860a6798a9 |
Hashes for mypy_boto3_cognito_identity-1.14.23.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f35e88c1e1ef965eff96b5bb8bb587b7a38108823bc4d6a6f9360dac84bc33ff |
|
MD5 | 611833d2a8a8f9ae934bbc5631e22bc2 |
|
BLAKE2b-256 | b339e8b62590f7495dcc717badb1d189de540d28758f917b785db1628ac46c6a |