Type annotations for boto3.Kinesis 1.13.26 service, generated by mypy-boto3-buider 2.0.3
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.3.
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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3616695c8f91c06787f8e8c64c53d1295fc2b3cf42b6bfc40fc21ce47ff2ae2 |
|
MD5 | a0cf7b7966e7c8da5323b46a68c90280 |
|
BLAKE2b-256 | 3f2176e6ea2d11701ce0d076b44542651cad64aecb7733ecf41c20fcc54076af |
Hashes for mypy_boto3_kinesis-1.13.26.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c30c1011b9df30d4cadad37599d3e9569ef48b7ec2c6192331fd88de7e340300 |
|
MD5 | 6d6223ba5d707850d26b07787b83acd1 |
|
BLAKE2b-256 | 95d2d81110f3696642a412d759db41d907d5cd434e811821c3deb926af0ccb8b |