kafka-python

kafka-python

Python client for the Apache Kafka distributed stream processing system.kafka-python is designed to function much like the official java client, with asprinkling of pythonic interfaces (e.g., consumer iterators).

kafka-python is best used with newer brokers (0.10 or 0.9), but is backwards-compatible witholder versions (to 0.8.0). Some features will only be enabled on newer brokers,however; for example, fully coordinated consumer groups – i.e., dynamicpartition assignment to multiple consumers in the same group – requires use of0.9 kafka brokers. Supporting this feature for earlier broker releases wouldrequire writing and maintaining custom leadership election and membership /health check code (perhaps using zookeeper or consul). For older brokers, youcan achieve something similar by manually assigning different partitions toeach consumer instance with config management tools like chef, ansible, etc.This approach will work fine, though it does not support rebalancing onfailures. See Compatibility for more details.

Please note that the master branch may contain unreleased features. For releasedocumentation, please see readthedocs and/or python’s inline help.

>>> pip install kafka-python

KafkaConsumer

KafkaConsumer is a high-level message consumer, intended tooperate as similarly as possible to the official java client. Full supportfor coordinated consumer groups requires use of kafka brokers that support theGroup APIs: kafka v0.9+.

See KafkaConsumer for API and configuration details.

The consumer iterator returns ConsumerRecords, which are simple namedtuplesthat expose basic message attributes: topic, partition, offset, key, and value:

>>> from kafka import KafkaConsumer
>>> consumer = KafkaConsumer('my_favorite_topic')
>>> for msg in consumer:
...     print (msg)

>>> # manually assign the partition list for the consumer
>>> from kafka import TopicPartition
>>> consumer = KafkaConsumer(bootstrap_servers='localhost:1234')
>>> consumer.assign([TopicPartition('foobar', 2)])
>>> msg = next(consumer)

>>> # Deserialize msgpack-encoded values
>>> consumer = KafkaConsumer(value_deserializer=msgpack.loads)
>>> consumer.subscribe(['msgpackfoo'])
>>> for msg in consumer:
...     assert isinstance(msg.value, dict)

KafkaProducer

KafkaProducer is a high-level, asynchronous message producer.The class is intended to operate as similarly as possible to the official javaclient. See KafkaProducer for more details.

>>> from kafka import KafkaProducer
>>> producer = KafkaProducer(bootstrap_servers='localhost:1234')
>>> for _ in range(100):
...     producer.send('foobar', b'some_message_bytes')

>>> # Block until all pending messages are sent
>>> producer.flush()

>>> # Block until a single message is sent (or timeout)
>>> producer.send('foobar', b'another_message').get(timeout=60)

>>> # Use a key for hashed-partitioning
>>> producer.send('foobar', key=b'foo', value=b'bar')

>>> # Serialize json messages
>>> import json
>>> producer = KafkaProducer(value_serializer=lambda v: json.dumps(v).encode('utf-8'))
>>> producer.send('fizzbuzz', {'foo': 'bar'})

>>> # Serialize string keys
>>> producer = KafkaProducer(key_serializer=str.encode)
>>> producer.send('flipflap', key='ping', value=b'1234')

>>> # Compress messages
>>> producer = KafkaProducer(compression_type='gzip')
>>> for i in range(1000):
...     producer.send('foobar', b'msg %d' % i)

Compression

kafka-python supports gzip compression/decompression natively. To produce orconsume lz4 compressed messages, you must install lz4tools and xxhash (modulesmay not work on python2.6). To enable snappy, install python-snappy (alsorequires snappy library).See Installation for more information.

Protocol

A secondary goal of kafka-python is to provide an easy-to-use protocol layerfor interacting with kafka brokers via the python repl. This is useful fortesting, probing, and general experimentation. The protocol support isleveraged to enable a check_version()method that probes a kafka broker andattempts to identify which version it is running (0.8.0 to 0.10).

Low-level

Legacy support is maintained for low-level consumer and producer classes,SimpleConsumer and SimpleProducer.