Type annotations for boto3.Kafka 1.13.26 service, generated by mypy-boto3-buider 2.0.3
Project description
mypy-boto3-kafka
Type annotations for boto3.Kafka 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 Kafka
service.
python -m pip install boto3-stubs[kafka]
# update installed packages index for automated type discovery
python -m mypy_boto3
Use boto3
with mypy_boto3_kafka
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_kafka import KafkaClient
# Now mypy can check if your code is valid.
client: KafkaClient = boto3.client("kafka")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: KafkaClient = session.client("kafka")
# Annotated paginators are included as well
import mypy_boto3_kafka.paginator as kafka_paginators
list_cluster_operations_paginator: kafka_paginators.ListClusterOperationsPaginator = client.get_paginator("list_cluster_operations")
list_clusters_paginator: kafka_paginators.ListClustersPaginator = client.get_paginator("list_clusters")
list_configuration_revisions_paginator: kafka_paginators.ListConfigurationRevisionsPaginator = client.get_paginator("list_configuration_revisions")
list_configurations_paginator: kafka_paginators.ListConfigurationsPaginator = client.get_paginator("list_configurations")
list_kafka_versions_paginator: kafka_paginators.ListKafkaVersionsPaginator = client.get_paginator("list_kafka_versions")
list_nodes_paginator: kafka_paginators.ListNodesPaginator = client.get_paginator("list_nodes")
Automated type discovery
mypy_boto3
package can generate index for mypy_boto3_kafka
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_kafka as kafka
from mypy_boto3_kafka import KafkaClient
# with these
from mypy_boto3 import kafka
from mypy_boto3.kafka import KafkaClient
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-kafka-1.13.26.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4d4e301d6d701deb1cd237af533f0b68b7fa6baada4cebb7aedfc16351ebc93 |
|
MD5 | ef3fc5eeb099b8244a62cbbe0b8919c5 |
|
BLAKE2b-256 | e5e1c9758523a80b6b705cc48b0b075462924adca5ac43e5b7312cdd04d76e7c |
Hashes for mypy_boto3_kafka-1.13.26.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1009581016643b394ffa7f0bc735db0c267531fb75cfccb702097bd73694442f |
|
MD5 | 3807f6c23916633375f175a9cc58d608 |
|
BLAKE2b-256 | 379fe89d194ae51bbd4197d59213c99f2a5043972508f7e43ad1631458bd4007 |