Type annotations for boto3.Kafka 1.14.22 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-kafka
Type annotations for boto3.Kafka 1.14.22 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for Kafka
service.
python -m pip install boto3-stubs[kafka]
How to use
Client annotations
KafkaClient
provides annotations for boto3.client("kafka")
.
import boto3
from mypy_boto3_kafka import KafkaClient
from mypy_boto3_kafka.paginator import (
ListClusterOperationsPaginator,
ListClustersPaginator,
ListConfigurationRevisionsPaginator,
ListConfigurationsPaginator,
ListKafkaVersionsPaginator,
ListNodesPaginator,
)
from mypy_boto3_kafka.type_defs import BrokerEBSVolumeInfoTypeDef, ...
client: KafkaClient = boto3.client("kafka")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: KafkaClient = session.client("kafka")
Paginators annotations
mypy_boto3_kafka.paginator
module contains type annotations for all paginators.
client: KafkaClient = boto3.client("kafka")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_cluster_operations_paginator: ListClusterOperationsPaginator = client.get_paginator("list_cluster_operations")
list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
list_configuration_revisions_paginator: ListConfigurationRevisionsPaginator = client.get_paginator("list_configuration_revisions")
list_configurations_paginator: ListConfigurationsPaginator = client.get_paginator("list_configurations")
list_kafka_versions_paginator: ListKafkaVersionsPaginator = client.get_paginator("list_kafka_versions")
list_nodes_paginator: ListNodesPaginator = client.get_paginator("list_nodes")
Typed dictionations
mypy_boto3_kafka.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> BrokerEBSVolumeInfoTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_kafka
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
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("kafka")
session_client = boto3.Session().client("kafka")
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.14.22.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4a080a7cb9bd786024990fd8d7d6117f2c46dceb894dfa4c30f093eed0fc925 |
|
MD5 | f32f8e03924422a1f0db9b7575938b14 |
|
BLAKE2b-256 | 43bd6ce768d76711c0ebd4e4b54132838810a68571931de127b653b905bcbe30 |
Hashes for mypy_boto3_kafka-1.14.22.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 457fe131d84edecf90360c260f009a981eaa8755e435df5109664c786b3671b9 |
|
MD5 | 958ba00efd7bd034573355c028c36b76 |
|
BLAKE2b-256 | 51e36a764ecb373c256f23851c7eaebefa25d3bcdf6adbcedf24b1f387e5bae3 |