Type annotations for boto3.KinesisVideo 1.14.41 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-kinesisvideo
Type annotations for boto3.KinesisVideo 1.14.41 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.41.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0cd2dc9c5c0dcd14651c2d010fab5b6738505e801a145332a5b021e1d136ad7a |
|
MD5 | 126afa0515b0edae9ec9c917cce41da5 |
|
BLAKE2b-256 | 01e5d7e9121468892763dace28ed0ecb08cd513b1347ca9aa8bd3d4be9bb9443 |
Hashes for mypy_boto3_kinesisvideo-1.14.41.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27791db8e25d6ba7fe169407c87035ff131afc18bab9f5c86dfe20767f5b0eef |
|
MD5 | 7e324220d7a56c2288cce0a868e1c71b |
|
BLAKE2b-256 | 3493501325093b2849299fae8b8a97ff2f7cc180d5e10f6892398e3be30b2d6c |