Type annotations for boto3.Kafka 1.12.24 service, generated by mypy-boto3-buider 1.0.5
Project description
mypy-boto3-kafka
Type annotations for boto3.Kafka 1.12.24 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 1.0.5.
More information can be found on boto3-stubs page.
How to use
Type checking
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for Kafka
service.
python -m pip install boto3-stubs[mypy-boto3-kafka]
Use boto3
with mypy_boto3
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3 import kafka
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_kafka as kafka
# Use this client as usual, now mypy can check if your code is valid.
# Check if your IDE supports function overloads,
# you probably do not need explicit type annotations
# client = boto3.client("kafka")
client: kafka.KafkaClient = boto3.client("kafka")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: kafka.KafkaClient = session.client("kafka")
# Paginators need type annotation on creation
list_cluster_operations_paginator: kafka.ListClusterOperationsPaginator = client.get_paginator("list_cluster_operations")
list_clusters_paginator: kafka.ListClustersPaginator = client.get_paginator("list_clusters")
list_configuration_revisions_paginator: kafka.ListConfigurationRevisionsPaginator = client.get_paginator("list_configuration_revisions")
list_configurations_paginator: kafka.ListConfigurationsPaginator = client.get_paginator("list_configurations")
list_kafka_versions_paginator: kafka.ListKafkaVersionsPaginator = client.get_paginator("list_kafka_versions")
list_nodes_paginator: kafka.ListNodesPaginator = client.get_paginator("list_nodes")
How it works
Fully automated builder carefully generates
type annotations for each service, patiently waiting for boto3
updates. It delivers
a drop-in type annotations for you and makes sure that:
- All available
boto3
services are covered. - Each public class and method of every
boto3
service gets valid type annotations extracted from the documentation (blamebotocore
docs if types are incorrect). - Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by black for readability.
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
Hashes for mypy-boto3-kafka-1.12.24.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2527c0cfcfd5fdf17cce5399c4e3f9d379003ad876161ab828b61eef47aaf84d |
|
MD5 | 498748784689d174cea7af0542f1b65d |
|
BLAKE2b-256 | ef43fc27dc9198cd1f400cdab610e28d76d642e6f07353e6b201cdddb26e2e74 |