ddkafka
Kafka helpers: batch consumer, lock-guarded consumer maker and msgpack producer on top of aiokafka
Installation
Install the library using pip:
pip install ddkafka
Development
The project runs entirely in Docker. Requires Docker and Fabric on the host:
fab build # build the dev image
fab tests # run pytest
fab linters # run ruff (with --fix), ty and complexipy
fab shell # IPython inside the container
fab bash # bash inside the container
This project was generated from dd-lib-stub;
run copier update to pull in template updates.
Producer
BaseKafkaProducerRepository sends events serialized with msgpack from model_dump(mode='json'), keyed by
idempotent_key. One AIOKafkaProducer is created lazily per subclass and shared by all its instances.
from pydantic import BaseModel
from ddkafka.config import ProducerConfig
from ddkafka.producer import BaseKafkaProducerRepository
class ProfileEvent(BaseModel):
profile_id: int
action: str
@property
def idempotent_key(self) -> str | None:
return f'{self.profile_id}:{self.action}'
class EventProducerRepository(BaseKafkaProducerRepository):
bootstrap_servers = ['kafka:9092']
config = ProducerConfig(linger_ms=100)
event_producer_repository_impl = EventProducerRepository()
await event_producer_repository_impl.create('profile_events', ProfileEvent(profile_id=1, action='open_app'))
await event_producer_repository_impl.bulk_create('profile_events', events)
Any object with idempotent_key and model_dump satisfies the Producible protocol; pydantic models only need the
property.
create and bulk_create return once the record is in the producer's buffer; aiokafka sends buffered records in
batches (linger_ms, max_batch_size), and a record the broker rejects is reported with an ERROR log entry. The
buffer only reaches Kafka while the process runs, so call stop() on shutdown (FastAPI lifespan, dramatiq
after_worker_shutdown), otherwise up to linger_ms worth of records is lost on SIGTERM:
await EventProducerRepository.stop()
Consumer
BaseKafkaConsumerRepository[Domain] reads one partition in batches. Payloads are msgpack dictionaries turned into
Domain with model_validate. get_batches() polls until the partition runs dry or a poll comes back thinner than
batch_size * min_batch_fill_ratio; commit() acknowledges everything yielded so far.
from ddkafka.consumer import BaseKafkaConsumerRepository
class ProfileEventConsumerRepository(BaseKafkaConsumerRepository[ProfileEvent]):
bootstrap_servers = ['kafka:9092']
topic = 'profile_events'
group_id = 'analytics_context'
batch_size = 100
repo = ProfileEventConsumerRepository(partition=0)
await repo.start()
try:
async for batch in repo.get_batches():
await process(batch)
await repo.commit()
finally:
await repo.stop()
get_batches(timestamp_threshold_minutes=5) yields only messages older than five minutes, for consumers that
deliberately lag behind the producer.
Tunables are class attributes: batch_size, poll_timeout_ms, min_batch_fill_ratio and config
(ConsumerConfig, passed to AIOKafkaConsumer as keyword arguments). Missing or mistyped attributes fail at
class definition.
A record that cannot be deserialized (a schema the consumer does not know, a payload written by something else)
raises MessageDeserializationError with the topic, partition and offset, and the partition stays at that offset
until the group's offset is moved past it. A consumer whose stream can afford to lose such a record sets
skip_undeserializable = True: the record is logged with its offset and dropped, the rest of the batch goes on.
Consumer maker
KafkaConsumerRepositoryMaker wraps a consumer in a distributed lock, so one partition is processed by one
worker at a time across the whole deployment. The lock is anything satisfying Lockable (acquire, release,
extend, timeout), for example RedisLock from ddredis. Entering acquires
the lock and starts the consumer; every yielded batch is followed by a checkpoint (lock heartbeat + offset commit);
leaving commits, stops and releases. A lock that is already held raises from acquire, a consumer that fails to
start raises ConsumerStartError after releasing the lock.
from ddredis.lock import RedisLock
from ddkafka.consumer_maker import KafkaConsumerRepositoryMaker
async with KafkaConsumerRepositoryMaker(
consumer_class=ProfileEventConsumerRepository,
partition=0,
lock_class=RedisLock,
lock_kwargs={'redis_client': redis_client, 'timeout': 300},
) as maker:
async for batch in maker.get_batches():
await process(batch)
Every batch is committed as a whole after the caller is done with it; a batch the caller fails on is not committed
and is read again next time, so processing must tolerate repeated records (idempotent_key). batch_size bounds
how much is reprocessed. maker.checkpoint() commits the current batch, so call it only once the batch is processed.
With stream=True the consumer does not return when the topic runs dry: it keeps the lock alive and polls
again after stream_round_pause, so a cron that starts it acts as a supervisor and messages are picked up as
they land. The pace must fit the lock: stream_round_pause plus the consumer's poll timeout may not exceed half
of the lock timeout, otherwise the maker refuses at construction.
Metadata
Release files for ddkafka 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ddkafka-0.0.1.tar.gz | 13.2 kB | With provenance | Details for ddkafka-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ddkafka-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for ddkafka-0.0.1-py3-none-any.whl |
Total release size: 29.4 kB
Release files / ddkafka-0.0.1.tar.gz
| Download URL | ddkafka-0.0.1.tar.gz |
|---|---|
| Size | 13.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
40fcb82c85dec24876d47f2e85941671f028a44508b56d6cee663f3faf2190cb
|
|
BLAKE2b-256 checksum How to use checksums |
b59a00a780b4c64ed8f200eb7bc7b439b619bb663c75a45695830a66520279f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.
Transparency logRelease files / ddkafka-0.0.1-py3-none-any.whl
| Download URL | ddkafka-0.0.1-py3-none-any.whl |
|---|---|
| Size | 16.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
787b4da3500c3b4263f4894aa6b877d0df5a6a8be3a37c4597601f01eeed5ab4
|
|
BLAKE2b-256 checksum How to use checksums |
eebb421b75d858d44e1ddf719c0f6db7333bd033fcf01cc56d9571eb5d875685
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.
Transparency logSecurity for ddkafka 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for ddkafka-0.0.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.