summaryrefslogtreecommitdiff
path: root/kafka/consumer/base.py
diff options
context:
space:
mode:
authorEnrico Canzonieri <ecanzonieri@gmail.com>2015-01-26 15:01:51 -0800
committerEnrico Canzonieri <enrico@yelp.com>2015-01-26 15:01:51 -0800
commit9ab8415ed75b08c5de9f823708027bb4f10a0643 (patch)
treef2011cb5cbdc4d5cd3d9bff9c52b35c2a6aca2ad /kafka/consumer/base.py
parentf517ddf283a86947a15f95e5ec562e81f4c477e5 (diff)
parent587206ff6ad59ae01248d24ff9c9fadbdfc1c1fc (diff)
downloadkafka-python-9ab8415ed75b08c5de9f823708027bb4f10a0643.tar.gz
Merge branch 'master' of github.com:mumrah/kafka-python into validate_consumer_offset
Conflicts: kafka/consumer/simple.py
Diffstat (limited to 'kafka/consumer/base.py')
-rw-r--r--kafka/consumer/base.py10
1 files changed, 7 insertions, 3 deletions
diff --git a/kafka/consumer/base.py b/kafka/consumer/base.py
index 2464aaf..9cdcf89 100644
--- a/kafka/consumer/base.py
+++ b/kafka/consumer/base.py
@@ -32,9 +32,11 @@ class Consumer(object):
Base class to be used by other consumers. Not to be used directly
This base class provides logic for
+
* initialization and fetching metadata of partitions
* Auto-commit logic
* APIs for fetching pending message count
+
"""
def __init__(self, client, group, topic, partitions=None, auto_commit=True,
auto_commit_every_n=AUTO_COMMIT_MSG_COUNT,
@@ -93,8 +95,9 @@ class Consumer(object):
"""
Commit offsets for this consumer
- partitions: list of partitions to commit, default is to commit
- all of them
+ Keyword Arguments:
+ partitions (list): list of partitions to commit, default is to commit
+ all of them
"""
# short circuit if nothing happened. This check is kept outside
@@ -148,7 +151,8 @@ class Consumer(object):
"""
Gets the pending message count
- partitions: list of partitions to check for, default is to check all
+ Keyword Arguments:
+ partitions (list): list of partitions to check for, default is to check all
"""
if not partitions:
partitions = self.offsets.keys()