Types for Confluent Kafka

1.4.1 · active · verified Sat Apr 11

This package provides type hints for the `confluent-kafka` Python client, enhancing development experience with static type checking (e.g., with mypy) and improved auto-completion in IDEs. It follows Semantic Versioning 2.0.0 and is released frequently to stay updated with `confluent-kafka` changes. As of `confluent-kafka-python` v2.13.0+, the official library includes its own type hints, making this package primarily relevant for users on older `confluent-kafka` versions.

Warnings

deprecated This package is largely deprecated for `confluent-kafka-python` versions 2.13.0 and above, as the official `confluent-kafka-python` library now includes its own integrated type hints. Users on newer `confluent-kafka-python` versions should prefer the official type hints.
Fix: For `confluent-kafka-python` v2.13.0 and newer, remove `types-confluent-kafka` and rely on the built-in type hints. For older versions, continue using this package.
gotcha This package provides type hints for the `confluent-kafka` library, but does not provide the `confluent-kafka` library itself. Users must install `confluent-kafka` separately. Additionally, `confluent-kafka` itself has experimental and deprecated classes (e.g., `SerializingProducer`, `DeserializingConsumer` are experimental; `AvroConsumer`, `AvroProducer` are deprecated). The types in `types-confluent-kafka` will reflect these underlying library statuses.
Fix: Ensure `confluent-kafka` is installed alongside `types-confluent-kafka`. Consult the `confluent-kafka` documentation for best practices regarding its experimental and deprecated features to avoid future breaking changes or issues.
breaking When upgrading `confluent-kafka`, be aware of its own breaking changes. For example, `confluent-kafka` 1.8.2 introduced a mandatory `use.deprecated.format` option for `ProtobufSerializer` and `ProtobufDeserializer`. While `types-confluent-kafka` does not introduce these changes, the types it provides will reflect the API of the underlying `confluent-kafka` version.
Fix: Always review the `CHANGELOG` of the `confluent-kafka` library when upgrading and update your code accordingly. Ensure the version of `types-confluent-kafka` is compatible with your `confluent-kafka` version.

Install

pip install --no-cache-dir types-confluent-kafka Install `types-confluent-kafka`

Imports

Producer
```
from confluent_kafka import Producer
```
Types from `types-confluent-kafka` are 'injected' into the `confluent_kafka` module upon installation.
Consumer
```
from confluent_kafka import Consumer
```
Types from `types-confluent-kafka` are 'injected' into the `confluent_kafka` module upon installation.

Quickstart

This quickstart demonstrates how to import and use `Producer` and `Consumer` with type hints, leveraging the `types-confluent-kafka` package. The type hints become available directly through the `confluent_kafka` module. To run this, ensure a Kafka broker is accessible at the specified `bootstrap.servers` (defaulting to `localhost:9092`).

from confluent_kafka import Producer, Consumer
import os

# Configure Kafka broker(s)
bootstrap_servers = os.environ.get('KAFKA_BOOTSTRAP_SERVERS', 'localhost:9092')

# Producer with type hints
producer: Producer = Producer({'bootstrap.servers': bootstrap_servers})
print(f"Producer created with bootstrap servers: {bootstrap_servers}")

# Consumer with type hints
consumer: Consumer = Consumer({'bootstrap.servers': bootstrap_servers, 'group.id': 'my-group'})
print(f"Consumer created with bootstrap servers: {bootstrap_servers} and group.id: my-group")

# Example of how to use with mypy (run 'mypy your_kafka_application.py' in terminal)

view raw JSON →