Type annotations for boto3.Kinesis 1.13.26 service, generated by mypy-boto3-buider 2.0.2
Project description
mypy-boto3-kinesis
Type annotations for boto3.Kinesis 1.13.26 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.2.
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]
# update installed packages index for automated type discovery
python -m mypy_boto3
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")
Automated type discovery
mypy_boto3
package can generate index for mypy_boto3_kinesis
and other installed services.
# Run this command when you add or remove service packages
python -m mypy_boto3
Generated index provides overloads for boto3.client
and boto3.service
,
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 carefullyVSCode
does not currently support function overloads
Also, generated index allows you to import types from mypy_boto3
:
# you can replace imports
import mypy_boto3_kinesis as kinesis
from mypy_boto3_kinesis import KinesisClient
# with these
from mypy_boto3 import kinesis
from mypy_boto3.kinesis import KinesisClient
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.13.26.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ebfbaf2f056422755143732d4b475232df4f84470e0aabb0a0a820ba943b167 |
|
MD5 | be011da4f8568031726ea672c986e75b |
|
BLAKE2b-256 | ffa0b7aea8134bba7eb5116190f5dd22db76e745f033147d512a76e2b60f9819 |
Hashes for mypy_boto3_kinesis-1.13.26.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 701bcc41b08f07dce1e80931dda0a046a409b08e60268114c7ee2d88e87e2bdf |
|
MD5 | f11604c8f7ddd92778555386c9637283 |
|
BLAKE2b-256 | 3d744a796fba3c292df5fa8a4e25bbe852c20de6535af3d6e58ca76fd2dfa476 |