Type annotations for boto3.KinesisVideo 1.14.16 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-kinesisvideo
Type annotations for boto3.KinesisVideo 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 KinesisVideo
service.
python -m pip install boto3-stubs[kinesisvideo]
How to use
Client annotations
KinesisVideoClient
provides annotations for boto3.client("kinesisvideo")
.
import boto3
from mypy_boto3_kinesisvideo import KinesisVideoClient
from mypy_boto3_kinesisvideo.paginator import ListSignalingChannelsPaginator, ListStreamsPaginator
from mypy_boto3_kinesisvideo.type_defs import ChannelInfoTypeDef, ...
client: KinesisVideoClient = boto3.client("kinesisvideo")
# 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: KinesisVideoClient = session.client("kinesisvideo")
Paginators annotations
mypy_boto3_kinesisvideo.paginator
module contains type annotations for all paginators.
client: KinesisVideoClient = boto3.client("kinesisvideo")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_signaling_channels_paginator: ListSignalingChannelsPaginator = client.get_paginator("list_signaling_channels")
list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
Typed dictionations
mypy_boto3_kinesisvideo.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> ChannelInfoTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_kinesisvideo
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("kinesisvideo")
session_client = boto3.Session().client("kinesisvideo")
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-kinesisvideo-1.14.16.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 888845e45f214ea3a80f556645b483832857f950e8f3b6eaee1c88f58fa2593b |
|
MD5 | ac27a3cb16c831cd3318c08879d5272b |
|
BLAKE2b-256 | 2a13538c7d4f2669983ced014f534d496173cb804eeee2cfa857421e8281bda5 |
Hashes for mypy_boto3_kinesisvideo-1.14.16.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14240175813d617786853d7f761fc62518c68b4005607b814831540d7e8fbcb2 |
|
MD5 | ef6612d3a235b84b17ef6231a67f8d8d |
|
BLAKE2b-256 | 8cdddd3c6e08ba46770c9799763cd526cc126e02748c0a66fe57ca0b0ec9c065 |