Python client for Apache Kafka
Python Shell
Latest commit b1ae45c Sep 13, 2017 @tvoinarovskyi tvoinarovskyi committed on GitHub Merge pull request #1213 from dpkp/1212-stop-using-mutable-types-for-…
…default-arg-values

Stop using mutable types for default arg values
Permalink
Failed to load latest commit information.
benchmarks Adapt benchmark scripts from https://github.com/mrafayaleem/kafka-jython Jul 16, 2016
docs Update sphinx/RTD changelog for 1.3.4 Aug 13, 2017
kafka Merge pull request #1213 from dpkp/1212-stop-using-mutable-types-for-… Sep 13, 2017
servers Add 0.11.0.0 server resources (reduced offsets.topic.replication.fact… Jun 19, 2017
test Stop using mutable types for default arg values Sep 12, 2017
.covrc Dont include kafka.vendor in coverage Aug 4, 2016
.gitignore Update Partitioners for use with KafkaProducer (#827) Sep 28, 2016
.gitmodules Remove kafka src submodules Aug 13, 2014
.travis.yml Add 0.11.0.0 to travis test matrix, remove 0.10.1.1; use scala 2.11 a… Aug 13, 2017
AUTHORS.md Update docs and links wrt maintainer change (mumrah -> dpkp) Dec 3, 2015
CHANGES.md Update sphinx/RTD changelog for 1.3.4 Aug 13, 2017
LICENSE Update LICENSE Feb 3, 2015
MANIFEST.in Include README.rst, CHANGES.md, and AUTHORS.md in manifest Dec 7, 2015
README.rst Update compatibility docs re: 0.11 brokers and python 3.6 Aug 13, 2017
build_integration.sh Add 0.11.0.0 to travis test matrix, remove 0.10.1.1; use scala 2.11 a… Aug 13, 2017
example.py Describe consumer thread-safety Jun 17, 2017
pylint.rc Ignore not-context-manager pylint error (#1092) Apr 29, 2017
setup.cfg Build universal wheels - kafka-python is compatible with both py2 and… Apr 25, 2016
setup.py Follow-up: support manual py26 testing; dont advertise 3.3 support Jun 17, 2017
tox.ini Follow-up: support manual py26 testing; dont advertise 3.3 support Jun 17, 2017

README.rst

Kafka Python client

https://coveralls.io/repos/dpkp/kafka-python/badge.svg?branch=master&service=github https://travis-ci.org/dpkp/kafka-python.svg?branch=master

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

kafka-python is best used with newer brokers (0.9+), but is backwards-compatible with older versions (to 0.8.0). Some features will only be enabled on newer brokers. For example, fully coordinated consumer groups -- i.e., dynamic partition assignment to multiple consumers in the same group -- requires use of 0.9+ kafka brokers. Supporting this feature for earlier broker releases would require writing and maintaining custom leadership election and membership / health check code (perhaps using zookeeper or consul). For older brokers, you can achieve something similar by manually assigning different partitions to each consumer instance with config management tools like chef, ansible, etc. This approach will work fine, though it does not support rebalancing on failures. See <https://kafka-python.readthedocs.io/en/master/compatibility.html> for more details.

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

>>> pip install kafka-python

KafkaConsumer

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

See <https://kafka-python.readthedocs.io/en/master/apidoc/KafkaConsumer.html> for API and configuration details.

The consumer iterator returns ConsumerRecords, which are simple namedtuples that 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)
>>> # join a consumer group for dynamic partition assignment and offset commits
>>> from kafka import KafkaConsumer
>>> consumer = KafkaConsumer('my_favorite_topic', group_id='my_favorite_group')
>>> 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 java client. See <https://kafka-python.readthedocs.io/en/master/apidoc/KafkaProducer.html> 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 a single message is sent (or timeout)
>>> future = producer.send('foobar', b'another_message')
>>> result = future.get(timeout=60)
>>> # Block until all pending messages are at least put on the network
>>> # NOTE: This does not guarantee delivery or success! It is really
>>> # only useful if you configure internal batching using linger_ms
>>> producer.flush()
>>> # 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)

Thread safety

The KafkaProducer can be used across threads without issue, unlike the KafkaConsumer which cannot.

While it is possible to use the KafkaConsumer in a thread-local manner, multiprocessing is recommended.

Compression

kafka-python supports gzip compression/decompression natively. To produce or consume lz4 compressed messages, you should install python-lz4 (pip install lz4). To enable snappy compression/decompression install python-snappy (also requires snappy library). See <https://kafka-python.readthedocs.io/en/master/install.html#optional-snappy-install> for more information.

Protocol

A secondary goal of kafka-python is to provide an easy-to-use protocol layer for interacting with kafka brokers via the python repl. This is useful for testing, probing, and general experimentation. The protocol support is leveraged to enable a KafkaClient.check_version() method that probes a kafka broker and attempts to identify which version it is running (0.8.0 to 0.11).

Low-level

Legacy support is maintained for low-level consumer and producer classes, SimpleConsumer and SimpleProducer. See <https://kafka-python.readthedocs.io/en/master/simple.html?highlight=SimpleProducer> for API details.