Type annotations for boto3.Chime 1.14.16 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-chime
Type annotations for boto3.Chime 1.14.16 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 Chime
service.
python -m pip install boto3-stubs[chime]
How to use
Client annotations
ChimeClient
provides annotations for boto3.client("chime")
.
import boto3
from mypy_boto3_chime import ChimeClient
from mypy_boto3_chime.paginator import ListAccountsPaginator, ListUsersPaginator
from mypy_boto3_chime.type_defs import AccountSettingsTypeDef, ...
client: ChimeClient = boto3.client("chime")
# 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: ChimeClient = session.client("chime")
Paginators annotations
mypy_boto3_chime.paginator
module contains type annotations for all paginators.
client: ChimeClient = boto3.client("chime")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_accounts_paginator: ListAccountsPaginator = client.get_paginator("list_accounts")
list_users_paginator: ListUsersPaginator = client.get_paginator("list_users")
Typed dictionations
mypy_boto3_chime.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AccountSettingsTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_chime
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("chime")
session_client = boto3.Session().client("chime")
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-chime-1.14.16.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | da7b9473fe869dabdf040bc346249623b417532e6116173c89829902bed4c635 |
|
MD5 | e095ad5db797e9824450b6146bfb98d1 |
|
BLAKE2b-256 | b3600805b7f5a249ceaa1e2a6a2a3b254daad639e9f597d3ecc37b0f010ecd6b |
Hashes for mypy_boto3_chime-1.14.16.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43415f3c5c7fa4072837dac6553dbbd5ad57b5fac52c69af133e58cde3fe80b8 |
|
MD5 | 49c17d186df313697952700266654c93 |
|
BLAKE2b-256 | 9573e0a510961798bde9c499825ae56a44759cef062bd17eb80f8f7aa6cdc9e8 |