Type annotations for boto3.Kinesis 1.14.0 service, generated by mypy-boto3-buider 2.0.4
Project description
mypy-boto3-kinesis
Type annotations for boto3.Kinesis 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.4.
More information can be found on boto3-stubs page.
How to use
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for Kinesis
service.
python -m pip install boto3-stubs[kinesis]
Use boto3
with mypy_boto3_kinesis
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_kinesis import KinesisClient
# Now mypy can check if your code is valid.
client: KinesisClient = boto3.client("kinesis")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: KinesisClient = session.client("kinesis")
# Waiters are also supported
import mypy_boto3_kinesis.waiter as kinesis_waiters
stream_exists_waiter: kinesis_waiters.StreamExistsWaiter = client.get_waiter("stream_exists")
stream_not_exists_waiter: kinesis_waiters.StreamNotExistsWaiter = client.get_waiter("stream_not_exists")
# Annotated paginators are included as well
import mypy_boto3_kinesis.paginator as kinesis_paginators
describe_stream_paginator: kinesis_paginators.DescribeStreamPaginator = client.get_paginator("describe_stream")
list_shards_paginator: kinesis_paginators.ListShardsPaginator = client.get_paginator("list_shards")
list_stream_consumers_paginator: kinesis_paginators.ListStreamConsumersPaginator = client.get_paginator("list_stream_consumers")
list_streams_paginator: kinesis_paginators.ListStreamsPaginator = client.get_paginator("list_streams")
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_kinesis
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
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("kinesis")
session_client = boto3.Session().client("kinesis")
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-kinesis-1.14.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a280395adecf5bf970451a4f3372d81eae22a6fe38d8a45cdc9c8bd863ff52c |
|
MD5 | 027c5e6bfadcc5ec1b0a13e39d09165e |
|
BLAKE2b-256 | ad062340caea24d2cc06e78f258acfa7220611cc14ec5e92d43a7668323efddd |
Hashes for mypy_boto3_kinesis-1.14.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4ee7ba1b5bb290548ee3b73bf8acef637c85c039378cb6b0f5403ce36ab9ea1 |
|
MD5 | 7e854500084a12e581d7558704dcb9dd |
|
BLAKE2b-256 | 2967c0fdd3f6555a66954ea3530a7ea15a06626925f86268e5d9dd313808f504 |