Changelog

1.3.4 (Aug 13, 2017)

Bugfixes

  • Avoid multiple connection attempts when refreshing metadata (dpkp #1067)
  • Catch socket.errors when sending / recving bytes on wake socketpair (dpkp #1069)
  • Deal with brokers that reappear with different IP address (originsmike #1085)
  • Fix join-time-max and sync-time-max metrics to use Max() measure function (billyevans #1146)
  • Raise AssertionError when decompression unsupported (bts-webber #1159)
  • Catch ssl.EOFErrors on Python3.3 so we close the failing conn (Ormod #1162)
  • Select on sockets to avoid busy polling during bootstrap (dpkp #1175)
  • Initialize metadata_snapshot in group coordinator to avoid unnecessary rebalance (dpkp #1174)

Client

  • Timeout idle connections via connections_max_idle_ms (dpkp #1068)
  • Warn, dont raise, on DNS lookup failures (dpkp #1091)
  • Support exponential backoff for broker reconnections – KIP-144 (dpkp #1124)
  • Add gssapi support (Kerberos) for SASL (Harald-Berghoff #1152)
  • Add private map of api key -> min/max versions to BrokerConnection (dpkp #1169)

Consumer

  • Backoff on unavailable group coordinator retry (dpkp #1125)
  • Only change_subscription on pattern subscription when topics change (Artimi #1132)
  • Add offsets_for_times, beginning_offsets and end_offsets APIs (tvoinarovskyi #1161)

Producer

  • Raise KafkaTimeoutError when flush times out (infecto)
  • Set producer atexit timeout to 0 to match del (Ormod #1126)

Core / Protocol

  • 0.11.0.0 protocol updates (only - no client support yet) (dpkp #1127)
  • Make UnknownTopicOrPartitionError retriable error (tvoinarovskyi)

Test Infrastructure

  • pylint 1.7.0+ supports python 3.6 and merge py36 into common testenv (jianbin-wei #1095)
  • Add kafka 0.10.2.1 into integration testing version (jianbin-wei #1096)
  • Disable automated tests for python 2.6 and kafka 0.8.0 and 0.8.1.1 (jianbin-wei #1096)
  • Support manual py26 testing; dont advertise 3.3 support (dpkp)
  • Add 0.11.0.0 server resources, fix tests for 0.11 brokers (dpkp)
  • Use fixture hostname, dont assume localhost (dpkp)
  • Add 0.11.0.0 to travis test matrix, remove 0.10.1.1; use scala 2.11 artifacts (dpkp #1176)

Logging / Error Messages

  • Improve error message when expiring batches in KafkaProducer (dpkp #1077)
  • Update producer.send docstring – raises KafkaTimeoutError (infecto)
  • Use logging’s built-in string interpolation (jeffwidman)
  • Fix produce timeout message (melor #1151)
  • Fix producer batch expiry messages to use seconds (dnwe)

Documentation

  • Fix typo in KafkaClient docstring (jeffwidman #1054)
  • Update README: Prefer python-lz4 over lz4tools (kiri11 #1057)
  • Fix poll() hyperlink in KafkaClient (jeffwidman)
  • Update RTD links with https / .io (jeffwidman #1074)
  • Describe consumer thread-safety (ecksun)
  • Fix typo in consumer integration test (jeffwidman)
  • Note max_in_flight_requests_per_connection > 1 may change order of messages (tvoinarovskyi #1149)

1.3.3 (Mar 14, 2017)

Core / Protocol

  • Derive all api classes from Request / Response base classes (dpkp 1030)
  • Prefer python-lz4 if available (dpkp 1024)
  • Fix kwarg handing in kafka.protocol.struct.Struct (dpkp 1025)
  • Fixed couple of “leaks” when gc is disabled (Mephius 979)
  • Added max_bytes option and FetchRequest_v3 usage. (Drizzt1991 962)
  • CreateTopicsRequest / Response v1 (dpkp 1012)
  • Add MetadataRequest_v2 and MetadataResponse_v2 structures for KIP-78 (Drizzt1991 974)
  • KIP-88 / KAFKA-3853: OffsetFetch v2 structs (jeffwidman 971)
  • DRY-up the MetadataRequest_v1 struct (jeffwidman 966)
  • Add JoinGroup v1 structs (jeffwidman 965)
  • DRY-up the OffsetCommitResponse Structs (jeffwidman 970)
  • DRY-up the OffsetFetch structs (jeffwidman 964)
  • time –> timestamp to match Java API (jeffwidman 969)
  • Add support for offsetRequestV1 messages (jlafaye 951)
  • Add FetchRequest/Response_v3 structs (jeffwidman 943)
  • Add CreateTopics / DeleteTopics Structs (jeffwidman 944)

Test Infrastructure

  • Add python3.6 to travis test suite, drop python3.3 (exponea 992)
  • Update to 0.10.1.1 for integration testing (dpkp 953)
  • Update vendored berkerpeksag/selectors34 to ff61b82 (Mephius 979)
  • Remove dead code (jeffwidman 967)
  • Update pytest fixtures to new yield syntax (jeffwidman 919)

Consumer

  • Avoid re-encoding message for crc check (dpkp 1027)
  • Optionally skip auto-commit during consumer.close (dpkp 1031)
  • Return copy of consumer subscription set (dpkp 1029)
  • Short-circuit group coordinator requests when NodeNotReady (dpkp 995)
  • Avoid unknown coordinator after client poll (dpkp 1023)
  • No longer configure a default consumer group (dpkp 1016)
  • Dont refresh metadata on failed group coordinator request unless needed (dpkp 1006)
  • Fail-fast on timeout constraint violations during KafkaConsumer creation (harelba 986)
  • Default max_poll_records to Java default of 500 (jeffwidman 947)
  • For 0.8.2, only attempt connection to coordinator if least_loaded_node succeeds (dpkp)

Producer

  • change default timeout of KafkaProducer.close() to threading.TIMEOUT_MAX on py3 (mmyjona 991)

Client

  • Add optional kwarg to ready/is_ready to disable metadata-priority logic (dpkp 1017)
  • When closing a broker connection without error, fail in-flight-requests with Cancelled (dpkp 1010)
  • Catch socket errors during ssl handshake (dpkp 1007)
  • Drop old brokers when rebuilding broker metadata (dpkp 1005)
  • Drop bad disconnect test – just use the mocked-socket test (dpkp 982)
  • Add support for Python built without ssl (minagawa-sho 954)
  • Do not re-close a disconnected connection (dpkp)
  • Drop unused last_failure time from BrokerConnection (dpkp)
  • Use connection state functions where possible (dpkp)
  • Pass error to BrokerConnection.close() (dpkp)

Bugfixes

  • Free lz4 decompression context to avoid leak (dpkp 1024)
  • Fix sasl reconnect bug: auth future must be reset on close (dpkp 1003)
  • Fix raise exception from SubscriptionState.assign_from_subscribed (qntln 960)
  • Fix blackout calculation: mark last_attempt time during connection close (dpkp 1008)
  • Fix buffer pool reallocation after raising timeout (dpkp 999)

Logging / Error Messages

  • Add client info logging re bootstrap; log connection attempts to balance with close (dpkp)
  • Minor additional logging for consumer coordinator (dpkp)
  • Add more debug-level connection logging (dpkp)
  • Do not need str(self) when formatting to %s (dpkp)
  • Add new broker response errors (dpkp)
  • Small style fixes in kafka.errors (dpkp)
  • Include the node id in BrokerConnection logging (dpkp 1009)
  • Replace %s with %r in producer debug log message (chekunkov 973)

Documentation

  • Sphinx documentation updates (jeffwidman 1019)
  • Add sphinx formatting to hyperlink methods (jeffwidman 898)
  • Fix BrokerConnection api_version docs default (jeffwidman 909)
  • PEP-8: Spacing & removed unused imports (jeffwidman 899)
  • Move BrokerConnection docstring to class (jeffwidman 968)
  • Move docstring so it shows up in Sphinx/RTD (jeffwidman 952)
  • Remove non-pip install instructions (jeffwidman 940)
  • Spelling and grammar changes (melissacrawford396 923)
  • Fix typo: coorelation –> correlation (jeffwidman 929)
  • Make SSL warning list the correct Python versions (jeffwidman 924)
  • Fixup comment reference to _maybe_connect (dpkp)
  • Add ClusterMetadata sphinx documentation (dpkp)

Legacy Client

  • Add send_list_offset_request for searching offset by timestamp (charsyam 1001)
  • Use select to poll sockets for read to reduce CPU usage (jianbin-wei 958)
  • Use select.select without instance bounding (adamwen829 949)

1.3.2 (Dec 28, 2016)

Core

  • Add kafka.serializer interfaces (dpkp 912)
  • from kafka import ConsumerRebalanceListener, OffsetAndMetadata
  • Use 0.10.0.1 for integration tests (dpkp 803)

Consumer

  • KAFKA-3007: KafkaConsumer max_poll_records (dpkp 831)
  • Raise exception if given a non-str topic (ssaamm 824)
  • Immediately update metadata for pattern subscription (laz2 915)

Producer

  • Update Partitioners for use with KafkaProducer (barrotsteindev 827)
  • Sort partitions before calling partitioner (ms7s 905)
  • Added ssl_password config option to KafkaProducer class (kierkegaard13 830)

Client

  • Always check for request timeouts (dpkp 887)
  • When hostname lookup is necessary, do every connect (benauthor 812)

Bugfixes

  • Fix errorcode check when socket.connect_ex raises an exception (guojh 907)
  • Fix fetcher bug when processing offset out of range (sibiryakov 860)
  • Fix possible request draining in ensure_active_group (dpkp 896)
  • Fix metadata refresh handling with 0.10+ brokers when topic list is empty (sibiryakov 867)
  • KafkaProducer should set timestamp in Message if provided (Drizzt1991 875)
  • Fix murmur2 bug handling python2 bytes that do not ascii encode (dpkp 815)
  • Monkeypatch max_in_flight_requests_per_connection when checking broker version (dpkp 834)
  • Fix message timestamp_type (qix 828)

Logging / Error Messages

  • Always include an error for logging when the coordinator is marked dead (dpkp 890)
  • Only string-ify BrokerResponseError args if provided (dpkp 889)
  • Update warning re advertised.listeners / advertised.host.name (jeffwidman 878)
  • Fix unrecognized sasl_mechanism error message (sharego 883)

Documentation

  • Add docstring for max_records (jeffwidman 897)
  • Fixup doc references to max_in_flight_requests_per_connection
  • Fix typo: passowrd –> password (jeffwidman 901)
  • Fix documentation typo ‘Defualt’ -> ‘Default’. (rolando 895)
  • Added doc for max_poll_records option (Drizzt1991 881)
  • Remove old design notes from Kafka 8 era (jeffwidman 876)
  • Fix documentation typos (jeffwidman 874)
  • Fix quota violation exception message (dpkp 809)
  • Add comment for round robin partitioner with different subscriptions
  • Improve KafkaProducer docstring for retries configuration

1.3.1 (Aug 8, 2016)

Bugfixes

  • Fix AttributeError in BrokerConnectionMetrics after reconnecting

1.3.0 (Aug 4, 2016)

Incompatible Changes

  • Delete KafkaConnection class (dpkp 769)
  • Rename partition_assignment -> assignment in MemberMetadata for consistency
  • Move selectors34 and socketpair to kafka.vendor (dpkp 785)
  • Change api_version config to tuple; deprecate str with warning (dpkp 761)
  • Rename _DEFAULT_CONFIG -> DEFAULT_CONFIG in KafkaProducer (dpkp 788)

Improvements

  • Vendor six 1.10.0 to eliminate runtime dependency (dpkp 785)
  • Add KafkaProducer and KafkaConsumer.metrics() with instrumentation similar to java client (dpkp 754 / 772 / 794)
  • Support Sasl PLAIN authentication (larsjsol PR 779)
  • Add checksum and size to RecordMetadata and ConsumerRecord (KAFKA-3196 / 770 / 594)
  • Use MetadataRequest v1 for 0.10+ api_version (dpkp 762)
  • Fix KafkaConsumer autocommit for 0.8 brokers (dpkp 756 / 706)
  • Improve error logging (dpkp 760 / 759)
  • Adapt benchmark scripts from https://github.com/mrafayaleem/kafka-jython (dpkp 754)
  • Add api_version config to KafkaClient (dpkp 761)
  • New Metadata method with_partitions() (dpkp 787)
  • Use socket_options configuration to setsockopts(). Default TCP_NODELAY (dpkp 783)
  • Expose selector type as config option (dpkp 764)
  • Drain pending requests to the coordinator before initiating group rejoin (dpkp 798)
  • Send combined size and payload bytes to socket to avoid potentially split packets with TCP_NODELAY (dpkp 797)

Bugfixes

  • Ignore socket.error when checking for protocol out of sync prior to socket close (dpkp 792)
  • Fix offset fetch when partitions are manually assigned (KAFKA-3960 / 786)
  • Change pickle_method to use python3 special attributes (jpaulodit 777)
  • Fix ProduceResponse v2 throttle_time_ms
  • Always encode size with MessageSet (#771)
  • Avoid buffer overread when compressing messageset in KafkaProducer
  • Explicit format string argument indices for python 2.6 compatibility
  • Simplify RecordMetadata; short circuit callbacks (#768)
  • Fix autocommit when partitions assigned manually (KAFKA-3486 / #767 / #626)
  • Handle metadata updates during consumer rebalance (KAFKA-3117 / #766 / #701)
  • Add a consumer config option to exclude internal topics (KAFKA-2832 / #765)
  • Protect writes to wakeup socket with threading lock (#763 / #709)
  • Fetcher spending unnecessary time during metrics recording (KAFKA-3785)
  • Always use absolute_import (dpkp)

Test / Fixtures

  • Catch select errors while capturing test fixture logs
  • Fix consumer group test race condition (dpkp 795)
  • Retry fixture failures on a different port (dpkp 796)
  • Dump fixture logs on failure

Documentation

  • Fix misspelling of password (ssaamm 793)
  • Document the ssl_password config option (ssaamm 780)
  • Fix typo in KafkaConsumer documentation (ssaamm 775)
  • Expand consumer.fetcher inline comments
  • Update kafka configuration links -> 0.10.0.0 docs
  • Fixup metrics_sample_window_ms docstring in consumer

1.2.5 (July 15, 2016)

Bugfixes

  • Fix bug causing KafkaProducer to double-compress message batches on retry
  • Check for double-compressed messages in KafkaConsumer, log warning and optionally skip
  • Drop recursion in _unpack_message_set; only decompress once

1.2.4 (July 8, 2016)

Bugfixes

  • Update consumer_timeout_ms docstring - KafkaConsumer raises StopIteration, no longer ConsumerTimeout
  • Use explicit subscription state flag to handle seek() during message iteration
  • Fix consumer iteration on compacted topics (dpkp PR 752)
  • Support ssl_password config when loading cert chains (amckemie PR 750)

1.2.3 (July 2, 2016)

Patch Improvements

  • Fix gc error log: avoid AttributeError in _unregister_cleanup (dpkp PR 747)
  • Wakeup socket optimizations (dpkp PR 740)
  • Assert will be disabled by “python -O” (tyronecai PR 736)
  • Randomize order of topics/partitions processed by fetcher to improve balance (dpkp PR 732)
  • Allow client.check_version timeout to be set in Producer and Consumer constructors (eastlondoner PR 647)

1.2.2 (June 21, 2016)

Bugfixes

  • Clarify timeout unit in KafkaProducer close and flush (ms7s PR 734)
  • Avoid busy poll during metadata refresh failure with retry_backoff_ms (dpkp PR 733)
  • Check_version should scan nodes until version found or timeout (dpkp PR 731)
  • Fix bug which could cause least_loaded_node to always return the same unavailable node (dpkp PR 730)
  • Fix producer garbage collection with weakref in atexit handler (dpkp PR 728)
  • Close client selector to fix fd leak (msmith PR 729)
  • Tweak spelling mistake in error const (steve8918 PR 719)
  • Rearrange connection tests to separate legacy KafkaConnection

1.2.1 (June 1, 2016)

Bugfixes

  • Fix regression in MessageSet decoding wrt PartialMessages (#716)
  • Catch response decode errors and log details (#715)
  • Fix Legacy support url (#712 - JonasGroeger)
  • Update sphinx docs re 0.10 broker support

1.2.0 (May 24, 2016)

Support Kafka 0.10 Features

  • Add protocol support for ApiVersionRequest (dpkp PR 678)
  • KAFKA-3025: Message v1 – add timetamp and relative offsets (dpkp PR 693)
  • Use Fetch/Produce API v2 for brokers >= 0.10 (uses message format v1) (dpkp PR 694)
  • Use standard LZ4 framing for v1 messages / kafka 0.10 (dpkp PR 695)

Consumers

  • Update SimpleConsumer / legacy protocol to handle compressed messages (paulcavallaro PR 684)

Producers

  • KAFKA-3388: Fix expiration of batches sitting in the accumulator (dpkp PR 699)
  • KAFKA-3197: when max.in.flight.request.per.connection = 1, attempt to guarantee ordering (dpkp PR 698)
  • Don’t use soon-to-be-reserved keyword await as function name (FutureProduceResult) (dpkp PR 697)

Clients

  • Fix socket leaks in KafkaClient (dpkp PR 696)

Documentation

<none>

Internals

  • Support SSL CRL [requires python 2.7.9+ / 3.4+] (vincentbernat PR 683)
  • Use original hostname for SSL checks (vincentbernat PR 682)
  • Always pass encoded message bytes to MessageSet.encode()
  • Raise ValueError on protocol encode/decode errors
  • Supplement socket.gaierror exception in BrokerConnection.connect() (erikbeebe PR 687)
  • BrokerConnection check_version: expect 0.9 to fail with CorrelationIdError
  • Fix small bug in Sensor (zackdever PR 679)

1.1.1 (Apr 26, 2016)

Bugfixes

  • Fix throttle_time_ms sensor handling (zackdever PR 667)
  • Improve handling of disconnected sockets (EasyPost PR 666 / dpkp)
  • Disable standard metadata refresh triggers during bootstrap (dpkp)
  • More predictable Future callback/errback exceptions (zackdever PR 670)
  • Avoid some exceptions in Coordinator.__del__ (dpkp PR 668)

1.1.0 (Apr 25, 2016)

Consumers

  • Avoid resending FetchRequests that are pending on internal queue
  • Log debug messages when skipping fetched messages due to offset checks
  • KAFKA-3013: Include topic-partition in exception for expired batches
  • KAFKA-3318: clean up consumer logging and error messages
  • Improve unknown coordinator error handling
  • Improve auto-commit error handling when group_id is None
  • Add paused() API (zackdever PR 602)
  • Add default_offset_commit_callback to KafkaConsumer DEFAULT_CONFIGS

Producers

<none>

Clients

  • Support SSL connections
  • Use selectors module for non-blocking IO
  • Refactor KafkaClient connection management
  • Fix AttributeError in __del__
  • SimpleClient: catch errors thrown by _get_leader_for_partition (zackdever PR 606)

Documentation

  • Fix serializer/deserializer examples in README
  • Update max.block.ms docstring
  • Remove errant next(consumer) from consumer documentation
  • Add producer.flush() to usage docs

Internals

  • Add initial metrics implementation (zackdever PR 637)
  • KAFKA-2136: support Fetch and Produce v1 (throttle_time_ms)
  • Use version-indexed lists for request/response protocol structs (dpkp PR 630)
  • Split kafka.common into kafka.structs and kafka.errors
  • Handle partial socket send() (dpkp PR 611)
  • Fix windows support (dpkp PR 603)
  • IPv6 support (TimEvens PR 615; Roguelazer PR 642)

1.0.2 (Mar 14, 2016)

Consumers

  • Improve KafkaConsumer Heartbeat handling (dpkp PR 583)
  • Fix KafkaConsumer.position bug (stefanth PR 578)
  • Raise TypeError when partition is not a TopicPartition (dpkp PR 587)
  • KafkaConsumer.poll should sleep to prevent tight-loops (dpkp PR 597)

Producers

  • Fix producer threading bug that can crash sender (dpkp PR 590)
  • Fix bug in producer buffer pool reallocation (dpkp PR 585)
  • Remove spurious warnings when closing sync SimpleProducer (twm PR 567)
  • Fix FutureProduceResult.await() on python2.6 (dpkp)
  • Add optional timeout parameter to KafkaProducer.flush() (dpkp)
  • KafkaProducer optimizations (zackdever PR 598)

Clients

  • Improve error handling in SimpleClient.load_metadata_for_topics (dpkp)
  • Improve handling of KafkaClient.least_loaded_node failure (dpkp PR 588)

Documentation

  • Fix KafkaError import error in docs (shichao-an PR 564)
  • Fix serializer / deserializer examples (scribu PR 573)

Internals

  • Update to Kafka 0.9.0.1 for integration testing
  • Fix ifr.future.failure in conn.py (mortenlj PR 566)
  • Improve Zookeeper / Kafka Fixture management (dpkp)

1.0.1 (Feb 19, 2016)

Consumers

  • Add RangePartitionAssignor (and use as default); add assignor tests (dpkp PR 550)
  • Make sure all consumers are in same generation before stopping group test
  • Verify node ready before sending offset fetch request from coordinator
  • Improve warning when offset fetch request returns unknown topic / partition

Producers

  • Warn if pending batches failed during flush
  • Fix concurrency bug in RecordAccumulator.ready()
  • Fix bug in SimpleBufferPool memory condition waiting / timeout
  • Support batch_size = 0 in producer buffers (dpkp PR 558)
  • Catch duplicate batch.done() calls [e.g., maybe_expire then a response errback]

Clients

Documentation

  • Improve kafka.cluster docstrings
  • Migrate load_example.py to KafkaProducer / KafkaConsumer

Internals

  • Don’t override system rcvbuf or sndbuf unless configured explicitly (dpkp PR 557)
  • Some attributes may not exist in __del__ if we failed assertions
  • Break up some circular references and close client wake pipes on __del__ (aisch PR 554)

1.0.0 (Feb 15, 2016)

This release includes significant code changes. Users of older kafka-python versions are encouraged to test upgrades before deploying to production as some interfaces and configuration options have changed.

Users of SimpleConsumer / SimpleProducer / SimpleClient (formerly KafkaClient) from prior releases should migrate to KafkaConsumer / KafkaProducer. Low-level APIs (Simple*) are no longer being actively maintained and will be removed in a future release.

For comprehensive API documentation, please see python help() / docstrings, kafka-python.readthedocs.org, or run ‘tox -e docs’ from source to build documentation locally.

Consumers

  • KafkaConsumer re-written to emulate the new 0.9 kafka consumer (java client) and support coordinated consumer groups (feature requires >= 0.9.0.0 brokers)
    • Methods no longer available:
      • configure [initialize a new consumer instead]
      • set_topic_partitions [use subscribe() or assign()]
      • fetch_messages [use poll() or iterator interface]
      • get_partition_offsets
      • offsets [use committed(partition)]
      • task_done [handled internally by auto-commit; or commit offsets manually]
    • Configuration changes (consistent with updated java client):
      • lots of new configuration parameters – see docs for details
      • auto_offset_reset: previously values were ‘smallest’ or ‘largest’, now values are ‘earliest’ or ‘latest’
      • fetch_wait_max_ms is now fetch_max_wait_ms
      • max_partition_fetch_bytes is now max_partition_fetch_bytes
      • deserializer_class is now value_deserializer and key_deserializer
      • auto_commit_enable is now enable_auto_commit
      • auto_commit_interval_messages was removed
      • socket_timeout_ms was removed
      • refresh_leader_backoff_ms was removed
  • SimpleConsumer and MultiProcessConsumer are now deprecated and will be removed in a future release. Users are encouraged to migrate to KafkaConsumer.

Producers

  • new producer class: KafkaProducer. Exposes the same interface as official java client. Async by default; returned future.get() can be called for synchronous blocking
  • SimpleProducer is now deprecated and will be removed in a future release. Users are encouraged to migrate to KafkaProducer.

Clients

  • synchronous KafkaClient renamed to SimpleClient. For backwards compatibility, you will get a SimpleClient via ‘from kafka import KafkaClient’. This will change in a future release.
  • All client calls use non-blocking IO under the hood.
  • Add probe method check_version() to infer broker versions.

Documentation

  • Updated README and sphinx documentation to address new classes.
  • Docstring improvements to make python help() easier to use.

Internals

  • Old protocol stack is deprecated. It has been moved to kafka.protocol.legacy and may be removed in a future release.
  • Protocol layer re-written using Type classes, Schemas and Structs (modeled on the java client).
  • Add support for LZ4 compression (including broken framing header checksum).

0.9.5 (Dec 6, 2015)

Consumers

  • Initial support for consumer coordinator: offsets only (toddpalino PR 420)
  • Allow blocking until some messages are received in SimpleConsumer (saaros PR 457)
  • Support subclass config changes in KafkaConsumer (zackdever PR 446)
  • Support retry semantics in MultiProcessConsumer (barricadeio PR 456)
  • Support partition_info in MultiProcessConsumer (scrapinghub PR 418)
  • Enable seek() to an absolute offset in SimpleConsumer (haosdent PR 412)
  • Add KafkaConsumer.close() (ucarion PR 426)

Producers

  • Catch client.reinit() exceptions in async producer (dpkp)
  • Producer.stop() now blocks until async thread completes (dpkp PR 485)
  • Catch errors during load_metadata_for_topics in async producer (bschopman PR 467)
  • Add compression-level support for codecs that support it (trbs PR 454)
  • Fix translation of Java murmur2 code, fix byte encoding for Python 3 (chrischamberlin PR 439)
  • Only call stop() on not-stopped producer objects (docker-hub PR 435)
  • Allow null payload for deletion feature (scrapinghub PR 409)

Clients

  • Use non-blocking io for broker aware requests (ecanzonieri PR 473)
  • Use debug logging level for metadata request (ecanzonieri PR 415)
  • Catch KafkaUnavailableError in _send_broker_aware_request (mutability PR 436)
  • Lower logging level on replica not available and commit (ecanzonieri PR 415)

Documentation

  • Update docs and links wrt maintainer change (mumrah -> dpkp)

Internals

  • Add py35 to tox testing
  • Update travis config to use container infrastructure
  • Add 0.8.2.2 and 0.9.0.0 resources for integration tests; update default official releases
  • new pylint disables for pylint 1.5.1 (zackdever PR 481)
  • Fix python3 / python2 comments re queue/Queue (dpkp)
  • Add Murmur2Partitioner to kafka __all__ imports (dpkp Issue 471)
  • Include LICENSE in PyPI sdist (koobs PR 441)

0.9.4 (June 11, 2015)

Consumers

  • Refactor SimpleConsumer internal fetch handling (dpkp PR 399)
  • Handle exceptions in SimpleConsumer commit() and reset_partition_offset() (dpkp PR 404)
  • Improve FailedPayloadsError handling in KafkaConsumer (dpkp PR 398)
  • KafkaConsumer: avoid raising KeyError in task_done (dpkp PR 389)
  • MultiProcessConsumer – support configured partitions list (dpkp PR 380)
  • Fix SimpleConsumer leadership change handling (dpkp PR 393)
  • Fix SimpleConsumer connection error handling (reAsOn2010 PR 392)
  • Improve Consumer handling of ‘falsy’ partition values (wting PR 342)
  • Fix _offsets call error in KafkaConsumer (hellais PR 376)
  • Fix str/bytes bug in KafkaConsumer (dpkp PR 365)
  • Register atexit handlers for consumer and producer thread/multiprocess cleanup (dpkp PR 360)
  • Always fetch commit offsets in base consumer unless group is None (dpkp PR 356)
  • Stop consumer threads on delete (dpkp PR 357)
  • Deprecate metadata_broker_list in favor of bootstrap_servers in KafkaConsumer (dpkp PR 340)
  • Support pass-through parameters in multiprocess consumer (scrapinghub PR 336)
  • Enable offset commit on SimpleConsumer.seek (ecanzonieri PR 350)
  • Improve multiprocess consumer partition distribution (scrapinghub PR 335)
  • Ignore messages with offset less than requested (wkiser PR 328)
  • Handle OffsetOutOfRange in SimpleConsumer (ecanzonieri PR 296)

Producers

  • Add Murmur2Partitioner (dpkp PR 378)
  • Log error types in SimpleProducer and SimpleConsumer (dpkp PR 405)
  • SimpleProducer support configuration of fail_on_error (dpkp PR 396)
  • Deprecate KeyedProducer.send() (dpkp PR 379)
  • Further improvements to async producer code (dpkp PR 388)
  • Add more configuration parameters for async producer (dpkp)
  • Deprecate SimpleProducer batch_send=True in favor of async (dpkp)
  • Improve async producer error handling and retry logic (vshlapakov PR 331)
  • Support message keys in async producer (vshlapakov PR 329)
  • Use threading instead of multiprocessing for Async Producer (vshlapakov PR 330)
  • Stop threads on __del__ (chmduquesne PR 324)
  • Fix leadership failover handling in KeyedProducer (dpkp PR 314)

KafkaClient

  • Add .topics property for list of known topics (dpkp)
  • Fix request / response order guarantee bug in KafkaClient (dpkp PR 403)
  • Improve KafkaClient handling of connection failures in _get_conn (dpkp)
  • Client clears local metadata cache before updating from server (dpkp PR 367)
  • KafkaClient should return a response or error for each request - enable better retry handling (dpkp PR 366)
  • Improve str/bytes conversion in KafkaClient and KafkaConsumer (dpkp PR 332)
  • Always return sorted partition ids in client.get_partition_ids_for_topic() (dpkp PR 315)

Documentation

  • Cleanup Usage Documentation
  • Improve KafkaConsumer documentation (dpkp PR 341)
  • Update consumer documentation (sontek PR 317)
  • Add doc configuration for tox (sontek PR 316)
  • Switch to .rst doc format (sontek PR 321)
  • Fixup google groups link in README (sontek PR 320)
  • Automate documentation at kafka-python.readthedocs.org

Internals

  • Switch integration testing from 0.8.2.0 to 0.8.2.1 (dpkp PR 402)
  • Fix most flaky tests, improve debug logging, improve fixture handling (dpkp)
  • General style cleanups (dpkp PR 394)
  • Raise error on duplicate topic-partition payloads in protocol grouping (dpkp)
  • Use module-level loggers instead of simply ‘kafka’ (dpkp)
  • Remove pkg_resources check for __version__ at runtime (dpkp PR 387)
  • Make external API consistently support python3 strings for topic (kecaps PR 361)
  • Fix correlation id overflow (dpkp PR 355)
  • Cleanup kafka/common structs (dpkp PR 338)
  • Use context managers in gzip_encode / gzip_decode (dpkp PR 337)
  • Save failed request as FailedPayloadsError attribute (jobevers PR 302)
  • Remove unused kafka.queue (mumrah)

0.9.3 (Feb 3, 2015)

  • Add coveralls.io support (sontek PR 307)
  • Fix python2.6 threading.Event bug in ReentrantTimer (dpkp PR 312)
  • Add kafka 0.8.2.0 to travis integration tests (dpkp PR 310)
  • Auto-convert topics to utf-8 bytes in Producer (sontek PR 306)
  • Fix reference cycle between SimpleConsumer and ReentrantTimer (zhaopengzp PR 309)
  • Add Sphinx API docs (wedaly PR 282)
  • Handle additional error cases exposed by 0.8.2.0 kafka server (dpkp PR 295)
  • Refactor error class management (alexcb PR 289)
  • Expose KafkaConsumer in __all__ for easy imports (Dinoshauer PR 286)
  • SimpleProducer starts on random partition by default (alexcb PR 288)
  • Add keys to compressed messages (meandthewallaby PR 281)
  • Add new high-level KafkaConsumer class based on java client api (dpkp PR 234)
  • Add KeyedProducer.send_messages api (pubnub PR 277)
  • Fix consumer pending() method (jettify PR 276)
  • Update low-level demo in README (sunisdown PR 274)
  • Include key in KeyedProducer messages (se7entyse7en PR 268)
  • Fix SimpleConsumer timeout behavior in get_messages (dpkp PR 238)
  • Fix error in consumer.py test against max_buffer_size (rthille/wizzat PR 225/242)
  • Improve string concat performance on pypy / py3 (dpkp PR 233)
  • Reorg directory layout for consumer/producer/partitioners (dpkp/wizzat PR 232/243)
  • Add OffsetCommitContext (locationlabs PR 217)
  • Metadata Refactor (dpkp PR 223)
  • Add Python 3 support (brutasse/wizzat - PR 227)
  • Minor cleanups - imports / README / PyPI classifiers (dpkp - PR 221)
  • Fix socket test (dpkp - PR 222)
  • Fix exception catching bug in test_failover_integration (zever - PR 216)

0.9.2 (Aug 26, 2014)

  • Warn users that async producer does not reliably handle failures (dpkp - PR 213)
  • Fix spurious ConsumerFetchSizeTooSmall error in consumer (DataDog - PR 136)
  • Use PyLint for static error checking (dpkp - PR 208)
  • Strictly enforce str message type in producer.send_messages (dpkp - PR 211)
  • Add test timers via nose-timer plugin; list 10 slowest timings by default (dpkp)
  • Move fetching last known offset logic to a stand alone function (zever - PR 177)
  • Improve KafkaConnection and add more tests (dpkp - PR 196)
  • Raise TypeError if necessary when encoding strings (mdaniel - PR 204)
  • Use Travis-CI to publish tagged releases to pypi (tkuhlman / mumrah)
  • Use official binary tarballs for integration tests and parallelize travis tests (dpkp - PR 193)
  • Improve new-topic creation handling (wizzat - PR 174)

0.9.1 (Aug 10, 2014)

  • Add codec parameter to Producers to enable compression (patricklucas - PR 166)
  • Support IPv6 hosts and network (snaury - PR 169)
  • Remove dependency on distribute (patricklucas - PR 163)
  • Fix connection error timeout and improve tests (wizzat - PR 158)
  • SimpleProducer randomization of initial round robin ordering (alexcb - PR 139)
  • Fix connection timeout in KafkaClient and KafkaConnection (maciejkula - PR 161)
  • Fix seek + commit behavior (wizzat - PR 148)

0.9.0 (Mar 21, 2014)

  • Connection refactor and test fixes (wizzat - PR 134)
  • Fix when partition has no leader (mrtheb - PR 109)
  • Change Producer API to take topic as send argument, not as instance variable (rdiomar - PR 111)
  • Substantial refactor and Test Fixing (rdiomar - PR 88)
  • Fix Multiprocess Consumer on windows (mahendra - PR 62)
  • Improve fault tolerance; add integration tests (jimjh)
  • PEP8 / Flakes / Style cleanups (Vetoshkin Nikita; mrtheb - PR 59)
  • Setup Travis CI (jimjh - PR 53/54)
  • Fix import of BufferUnderflowError (jimjh - PR 49)
  • Fix code examples in README (StevenLeRoux - PR 47/48)

0.8.0

  • Changing auto_commit to False in [SimpleConsumer](kafka/consumer.py), until 0.8.1 is release offset commits are unsupported
  • Adding fetch_size_bytes to SimpleConsumer constructor to allow for user-configurable fetch sizes
  • Allow SimpleConsumer to automatically increase the fetch size if a partial message is read and no other messages were read during that fetch request. The increase factor is 1.5
  • Exception classes moved to kafka.common